setSpeedMode

Description

Sets group speed mode. If unit is passed as param, unit's group is used. Mode may be one of:

• "UNCHANGED" (unchanged)
• "LIMITED" (half speed)
• "NORMAL" (full speed, maintain formation)
• "FULL" (do not wait for any other units in formation)

Syntax

groupName setSpeedMode mode

Parameters:

• groupName: Object or Group
• mode: String

Returns: Nothing

Examples

Example 1

_groupOne setSpeedMode "LIMITED";

See also

speedMode · getSpeed · forceSpeed