Function; Player_FillSobGroupInVolume - HWRM/KarosGraveyard GitHub Wiki

Player_FillSobGroupInVolume(<sSobGroupNameOut>, <iPlayerIndex>, <sVolumeName>)

Description

Puts all ships belonging to <iPlayerIndex> into <sSobGroupNameOut> if they are within <sVolumeName>. Note: unlike SobGroup_FillSobGroupInVolume, the function does not seem to return a boolean indicating whether <sSobGroupNameOut> is empty or not -SunTzu
Note: Sleeping ships, such as those docked within a ship in the Volume, are not added to <sSobGroupNameOut> -Grey_Ghost

Example

Player_FillSobGroupInVolume("VaygrShipsInProbeRange", 1, "ProbeVol"..i)

Arguments

<sSobGroupNameOut>: the name of the sobgroup to place ships into.
<iPlayerIndex>: the index number of the player.
<sVolumeName>: the name of the volume.

Scope

Related Pages

Function Reference

SCAR (SCripting at Relic) Reference

Comments

Page Status

Updated Formatting? Initial
Updated for HWRM? Initial