getSpeed: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
mNo edit summary
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|1.00|= Game version
|version1= 1.00
|arg= global|= Arguments in MP
____________________________________________________________________________________________


| Get the speed for the given speed mode.
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50
 
|arg= global
 
|gr1= Object Manipulation
 
|descr= Get the speed for the given speed mode.


SpeedMode can be:
SpeedMode can be:
Line 13: Line 26:
*"SLOW"
*"SLOW"
*"NORMAL"
*"NORMAL"
*"FAST" |DESCRIPTION=
*"FAST"
____________________________________________________________________________________________


| object '''getSpeed''' speedMode |SYNTAX=
|s1= object [[getSpeed]] speedMode


|p1= object: [[Object]] |PARAMETER1=
|p1= object: [[Object]]


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


| [[Number]] (m/s) |RETURNVALUE=
|r1= [[Number]] - m/s
____________________________________________________________________________________________


|x1= <code>_spd = [[player]] [[getSpeed]] "FAST";</code> |=
|x1= <sqf>_spd = player getSpeed "FAST";</sqf>
 
| [[forceWalk]], [[isWalking]], [[forceSpeed]], [[isForcedWalk]] |SEEALSO=


|seealso= [[forceWalk]] [[isWalking]] [[forceSpeed]] [[isForcedWalk]]
}}
}}
<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|GETSPEED]]
[[Category:Scripting Commands ArmA|GETSPEED]]
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
[[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 11:45, 28 September 2023

Hover & click on the images for description

Description

Description:
Get the speed for the given speed mode. SpeedMode can be:
  • "AUTO"
  • "SLOW"
  • "NORMAL"
  • "FAST"
Groups:
Object Manipulation

Syntax

Syntax:
object getSpeed speedMode
Parameters:
object: Object
speedMode: String
Return Value:
Number - m/s

Examples

Example 1:
_spd = player getSpeed "FAST";

Additional Information

See also:
forceWalk isWalking forceSpeed isForcedWalk

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