Description
Sets or gets the combat pace for the local player. If the right-hand array is empty, the command will simply return the current combat pace mode without making any changes to combat pace.
Syntax
soldier combatPace [enable, duration]
Parameters:
soldier: Object - The local player unit.enable: Boolean - (Optional, no default) Whether to enable or disable combat pace. This param is optional, i.e. the right-hand array can be completely empty (see #Example 1).duration: Scalar - (Optional, default -1) Duration of combat pace in seconds (maximum 5 seconds). If duration < 0, combat pace will be toggled. If duration >= 0, short combat pace will be used. duration == 0 means use the default short combat pace duration in config, similar to when the player presses the fire button and weapon is raised. Note that the combat pace modes are mutually exclusive (enabling one disables the other)
Returns: String - previous combat pace. Possible values: "None", "Timer", "Toggle"
Examples
Example 1
private _isCombatPaceToggled = player combatPace [] == "Toggle"; // current combat pace is toggled
Example 2
private _isInCombatPace = player combatPace [] != "None"; // either using timer or toggled combat pace
Example 3
player combatPace [false]; // disables combat pace (both short and toggle)
Example 4
player combatPace [true]; // enables combat pace toggle and disables timer mode
Example 5
player combatPace [true, 1]; // disables combat pace toggle, enables timer mode for 1 second
Example 6
player combatPace [player combatPace [] != "Toggle"]; // toggle combat pace (enable<->disable)