setSpeedMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(added seeAlso)
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= global |Multiplayer Effects=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Sets group speed mode. If unit is passed as param, unit's group is used. Mode may be one of:  
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50
 
|arg= local
 
|eff= global
 
|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)
* '''"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)
|DESCRIPTION=
____________________________________________________________________________________________


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


|p1= groupName: [[Object]] or [[Group]] |PARAMETER1=
|p1= groupName: [[Object]] or [[Group]]


|p2= mode: [[String]] |PARAMETER2=
|p2= mode: [[String]]


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>_groupOne [[setSpeedMode]] "LIMITED";</code> |EXAMPLE1=
____________________________________________________________________________________________


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


|seealso= [[speedMode]], [[getSpeed]], [[forceSpeed]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETSPEEDMODE]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SETSPEEDMODE]]
[[Category:Scripting Commands OFP 1.46|SETSPEEDMODE]]
[[Category:Scripting Commands ArmA|SETSPEEDMODE]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

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