ScarDoc

Start typing to search the SCAR reference.

Function
Util

Util_AddMouseoverSquadToSGroup

If there's a squad under the mouse cursor, this adds it to a unique SGroup. Return value is the SGroup it was added to, or nil if there was no squad under the mouse cursor. Pass in true for 'clearGroup' to clear the sgroup before adding the squad.

On this page
Util_AddMouseoverSquadToSGroup(arg1, clearGroup)

Description

If there's a squad under the mouse cursor, this adds it to a unique SGroup. Return value is the SGroup it was added to, or nil if there was no squad under the mouse cursor. Pass in true for 'clearGroup' to clear the sgroup before adding the squad.

Parameters

  • arg1Unknownrequired
  • clearGroupBooleanoptional

Returns

SGroupID

Source

Declared in the game's script sources at:

scar/scarutil.scar