Function
SGroup
SGroup_Filter
Filters an SGroup by blueprint.
On this page
SGroup_Filter(sgroup, blueprint, filtertype, splitSGroup)Description
A table of blueprints can be specified if you want to filter on more than one type. Setting filtertype to FILTER_KEEP results in the group only containing squads of the types listed in the blueprint table. Setting filtertype to FILTER_REMOVE will strip those same squads out and leave those that aren't of the types listed. Setting splitSGroup will move any squads being KEEP or REMOVE to it. This SGroup will NOT be cleared beforehand. SquadTypes can also be used in place of Blueprints. If you want a squad to match a bunch of SquadTypes at the same time (i.e. AND instead of OR) then they can be listed together in a sub-table.
Parameters
sgroupSGroupIDrequiredblueprintSBP/SquadType/TablerequiredfiltertypeIntegerrequiredsplitSGroupSGroupIDoptional
Returns
VoidSource
Declared in the game's script sources at:
scar/groups.scar