Function; SobGroup_FillSobGroupInVolume - HWRM/KarosGraveyard GitHub Wiki
SobGroup_FillSobGroupInVolume(<sSobGroupOutName>, <sSobGroupName>, <sVolumeName>)
Description
Returns true if any ship in <sSobGroupName> is inside <sVolumeName>, and false if all ships in <sSobGroupName> are outside of <sVolumeName>.
Fills <sSobGroupOutName> with all squadrons in <sSobGroupName> that are inside <sVolumeName>.
Note: <sSobGroupOutName> is automatically cleared each time the function is executed, prior to being filled again.
Note: docked ships are put into <sSobGroupOutName> if the carrier they're docked with is inside the volume.
Note: <sSobGroupOutName> must already have been created before this function may be called.
Example
if (SobGroup_FillSobGroupInVolume("shipsInVolume", "WaveOne_Gate_1b", "vol_WaveOne_Gate_1_B") == 1) then
... code ...
end
Arguments
<sSobGroupName>: the sobGroup containing the ships to test.
<sVolumeName>: the name of the volume.
<sSobGroupOutName>: the sobGroup in which ships passing the condition are placed.
Related Pages
Comments
Edited (it returns true even if only one ships is in volume) and completed (re the filling part).
--SunTzu (2005-12-26 15:11:39)
Slight grammar and formatting fixes.
--0-3pool107-112.nas29.houston4.tx.us.da.qwest.net (2006-01-09 23:17:56)
Page Status
Updated Formatting? Initial
Updated for HWRM? Initial