ScarDoc

Start typing to search the SCAR reference.

Function
SGroup

SGroup_IsOnScreen

Returns true if ANY or ALL (use those keywords) of the squads in the group are present onscreen. You can pass in a percentage of the screen to check, so 0.8 would be a centered rectangle occupying 80% of the screen.

On this page
SGroup_IsOnScreen(group, all, percent)

Description

Returns true if ANY or ALL (use those keywords) of the squads in the group are present onscreen. You can pass in a percentage of the screen to check, so 0.8 would be a centered rectangle occupying 80% of the screen.

Parameters

  • groupSGroupIDrequired
  • allBooleanrequired
  • percentFloatoptional

Returns

Boolean

Source

Declared in the game's script sources at:

scar/groups.scar