ScarDoc

Start typing to search the SCAR reference.

Function
EGroup

EGroup_Filter

Filters an EGroup by blueprint or type.

On this page
EGroup_Filter(egroup, blueprint/type, filtertype, splitGroup)

Description

Blueprints can be provided by name or by ID, and in a table if you want to filter on more than one type. Setting filtertype to FILTER_KEEP results in the group only containing entities of the types listed in the blueprint table. Setting filtertype to FILTER_REMOVE will strip those same entities out and leave those that aren't of the types listed.

Parameters

  • egroupEGroupIDrequired
  • blueprint/typeID/Table/Stringrequired
  • filtertypeIntegerrequired
  • splitGroupEGroupIDoptional

Returns

Void

Source

Declared in the game's script sources at:

scar/groups.scar