ScarDoc

Start typing to search the SCAR reference.

Function
Cmd

Cmd_StaggeredRetreat

Retreats large numbers of units in a staggered, realistic manner.

On this page
Cmd_StaggeredRetreat(sgroup, markers, maxTries, vulnerableRetreat)

Description

Each Squad in the sgroup will have a 1 in 3 chance to retreat. After 10 seconds (or maxTries), all squads will be forced to retreat. Squads will delete on arrival at their retreat point. vulnerableRetreat will make retreating squads take more damage

Parameters

  • sgroupSGroupIDrequired
  • markersTablerequired
  • maxTriesIntegeroptional
  • vulnerableRetreatBooleanoptional

Returns

Void

Source

Declared in the game's script sources at:

scar/command.scar