ScarDoc

Start typing to search the SCAR reference.

Function
SGroup

SGroup_FilterOnScreen

Filters an SGroup by whether units are on screen or not. Percent refers to the screen area you are considering (0.8 is a good value to use - it won't include things that are right at the screen edge).

On this page
SGroup_FilterOnScreen(egroup, percent, filtertype)

Description

Setting filtertype to FILTER_KEEP results in the group only containing those squads that are on screen.

Parameters

  • egroupSGroupIDrequired
  • percentRealrequired
  • filtertypeIntegerrequired

Returns

Void

Source

Declared in the game's script sources at:

scar/groups.scar