ScarDoc

Start typing to search the SCAR reference.

Function
SGroup

SGroup_FilterByProximity

Filters an sgroup base on proximity. Use FILTER_KEEP to keep the affected units, or FILTER_REMOVE to remove them. Set invertPosition to TRUE to affect the units outside the position.

On this page
SGroup_FilterByProximity(sgroup, arg2, filtertype, OPT_range, OPT_splitSGroup)

Description

Filters an sgroup base on proximity. Use FILTER_KEEP to keep the affected units, or FILTER_REMOVE to remove them. Set invertPosition to TRUE to affect the units outside the position.

Parameters

  • sgroupSGroupIDrequired
  • arg2Positionrequired
  • filtertypeIntegerrequired
  • OPT_rangeRealoptional
  • OPT_splitSGroupSGroupIDoptional

Returns

Unknown

Source

Declared in the game's script sources at:

scar/groups.scar