setSpeedMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
(added seeAlso)
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|arg= local
|arg= local
Line 11: Line 28:
|gr1= Groups
|gr1= Groups


| Sets group speed mode. If unit is passed as param, unit's group is used. Mode may be one of:  
|descr= Sets group speed mode. If unit is passed as param, unit's group is used. Mode may be one of:  
* '''"UNCHANGED"''' (unchanged)
* '''"UNCHANGED"''' (unchanged)
* '''"LIMITED"''' (half speed)
* '''"LIMITED"''' (half speed)
Line 17: Line 34:
* '''"FULL"''' (do not wait for any other units in formation)
* '''"FULL"''' (do not wait for any other units in formation)


| groupName '''setSpeedMode''' mode
|s1= groupName [[setSpeedMode]] mode


|p1= groupName: [[Object]] or [[Group]]
|p1= groupName: [[Object]] or [[Group]]
Line 23: Line 40:
|p2= mode: [[String]]
|p2= mode: [[String]]


|r1=[[Nothing]]
|r1= [[Nothing]]


|x1= <code>_groupOne [[setSpeedMode]] "LIMITED";</code>
|x1= <sqf>_groupOne setSpeedMode "LIMITED";</sqf>


|seealso= [[speedMode]]
|seealso= [[speedMode]], [[getSpeed]], [[forceSpeed]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 17:21, 2 January 2023

Hover & click on the images for description

Description

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)
Groups:
Groups

Syntax

Syntax:
groupName setSpeedMode mode
Parameters:
groupName: Object or Group
mode: String
Return Value:
Nothing

Examples

Example 1:
_groupOne setSpeedMode "LIMITED";

Additional Information

See also:
speedModegetSpeedforceSpeed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note