setSpeedMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(added seeAlso)
 
(66 intermediate revisions by 15 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''''group'' setSpeedMode ''mode'''''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''group:''' [[Object or Group]]
|game4= arma2
|version4= 1.00


'''mode:''' [[String]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|arg= local


Set '''group''' speed '''mode'''.
|eff= global


'''Mode''' may be one of:
|gr1= Groups


|descr= 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)
* '''"LIMITED"''' (half speed)
* '''"NORMAL"''' (full speed, maintain formation)
* '''"NORMAL"''' (full speed, maintain formation)
* '''"FULL"''' (do not wait for any other units in formation)
* '''"FULL"''' (do not wait for any other units in formation)


|s1= groupName [[setSpeedMode]] mode


'''Example:'''
|p1= groupName: [[Object]] or [[Group]]


groupOne '''setSpeedMode''' '''"LIMITED"'''
|p2= mode: [[String]]
 
|r1= [[Nothing]]
 
|x1= <sqf>_groupOne setSpeedMode "LIMITED";</sqf>
 
|seealso= [[speedMode]], [[getSpeed]], [[forceSpeed]]
}}

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