setSpeedMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(added seeAlso)
 
(41 intermediate revisions by 4 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 |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Set group speed mode. If unit is passed as param, unit's group is used. Mode may be one of:
|game5= arma2oa
* '''"UNCHANGED"''' (unchanged)
|version5= 1.50
* '''"LIMITED"''' (half speed)
* '''"NORMAL"''' (full speed, maintain formation)
* '''"FULL"''' (do not wait for any other units in formation)
|= Description
____________________________________________________________________________________________


| groupName '''setSpeedMode''' mode |= Syntax
|game6= tkoh
|version6= 1.00


|p1= groupName: [[Object]] or [[Group]] |= Parameter 1
|game7= arma3
|version7= 0.50


|p2= mode: [[String]] |= Parameter 2
|arg= local


| [[Nothing]] |= Return value
|eff= global
____________________________________________________________________________________________
 
|x1= <code>_groupOne [[setSpeedMode]] "LIMITED";</code> |= Example 1
____________________________________________________________________________________________


| [[speedMode]] |= See also
|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)
* '''"NORMAL"''' (full speed, maintain formation)
* '''"FULL"''' (do not wait for any other units in formation)


<h3 style="display:none">Notes</h3>
|s1= groupName [[setSpeedMode]] mode
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 14 Feb 2010
|p1= groupName: [[Object]] or [[Group]]
<dt class="note">'''[[User:MadRussian|MadRussian]]'''
<dd class="note">Although setSpeedMode can be called on an individual unit, the entire group will be affected.


|p2= mode: [[String]]


<dd class="notedate">Posted on 17 May 2008
|r1= [[Nothing]]
<dt class="note>'''[[User:Paul-Hewson|Paul-Hewson]]'''
<dd class="note">In Multiplayer, this command is overwritten by itself to NORMAL or FULLSPEED (i don't know which one, but it's fast move) when you ask the unit to move via script (ex : _unit doMove (getMarkerPos "destination"); )
The solution to solve this problem is to initialize the setSpeedMode after your order the unit to move.


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


So basically it gives you :
|seealso= [[speedMode]], [[getSpeed]], [[forceSpeed]]
 
}}
_unit doMove (getMarkerPos "destination");
 
_unit setSpeedMode "LIMITED";
 
 
If you plan to move the unit again after it reaches its destination, you will have to set the speed mode to LIMITED again like i did just above.
 
 
<!-- 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

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=setSpeedMode&oldid=336415"