vehicleMoveInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|Comments= ____________________________________________________________________________________________ | arma3dev |Game name= |1.97|Game version= _________________...")
 
No edit summary
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |Game name=
|game1= arma3
|version1= 1.98


|1.97|Game version=
|gr1= Object Manipulation
____________________________________________________________________________________________


| Returns current vehicle move/turn info (a getter for [[sendSimpleCommand]]) in format [moveInfo, turnInfo]. Possible values:<br><br>
|gr2= Unit Control
<u>moveInfo</u>
* <tt>"FORMATION"</tt> - vehicle is stationary
* <tt>"FORWARD"</tt>  - vehicle is moving forward
* <tt>"FAST"</tt> - vehicle is slow moving forward
* <tt>"SLOW"</tt> - vehicle is fast moving forward
* <tt>"STOP"</tt> - vehicle is stationary
* <tt>"BACK"</tt> - vehicle is reversing
* <tt>"DirectByCommander"</tt> - keyboard pilot is used, i.e. player is in the vehicle and is the [[effectiveCommander]] pressing any driving key (WASD or arrows).


<u>turnInfo</u>
|descr= Returns current vehicle move/turn info (a getter for [[sendSimpleCommand]]) in format [moveInfo, turnInfo]. Possible values:
* <tt>"LEFT"</tt> - vehicle is tuning left (use [[sendSimpleCommand | "STOPTURNING"]] to cancel)
* <tt>"RIGHT"</tt> - vehicle is tuning right (use [[sendSimpleCommand | "STOPTURNING"]] to cancel)
* <tt>"NONE"</tt> - vehicle is not tuning
* <tt>"ABS"</tt> - vehicle is not tuning


|DESCRIPTION=
{{{!}} class="wikitable"
____________________________________________________________________________________________
! moveInfo
! turnInfo
{{!}}- style="vertical-align: top"
{{!}} width="50%" {{!}}
* {{hl|"FORMATION"}} - vehicle is stationary
* {{hl|"FORWARD"}}  - vehicle is moving forward
* {{hl|"FAST"}} - vehicle is fast moving forward
* {{hl|"SLOW"}} - vehicle is slow moving forward
* {{hl|"STOP"}} - vehicle is stationary
* {{hl|"BACK"}} - vehicle is reversing
* {{sic|{{hl|"DirectByComander"}}}} - keyboard pilot is used, i.e. player is in the vehicle and is the [[effectiveCommander]] pressing any driving key (WASD or arrows).
{{!}} width="50%" {{!}}
* {{hl|"LEFT"}} - vehicle is turning left (use [[sendSimpleCommand | "STOPTURNING"]] to cancel)
* {{hl|"RIGHT"}} - vehicle is turning right (use [[sendSimpleCommand | "STOPTURNING"]] to cancel)
* {{hl|"NONE"}} - vehicle is not turning (when script command is used)
* {{hl|"ABS"}} - vehicle is not turning (when keyboard pilot is used)
{{!}}}


| [[vehicleMoveInfo]] vehicle |SYNTAX=
|s1= [[vehicleMoveInfo]] vehicle


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


| [[Array]] in format [moveInfo, turnInfo], where:
|r1= [[Array]] in format [moveInfo, turnInfo], where:
* moveInfo: [[String]] - state of vehicle forward/backward movement (see description)
* moveInfo: [[String]] - state of vehicle forward/backward movement (see description)
* turnInfo: [[String]] - state of vehicle left/right turning (see description) |RETURNVALUE=
* turnInfo: [[String]] - state of vehicle left/right turning (see description)
____________________________________________________________________________________________
 
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[vehicleMoveInfo]] [[vehicle]] [[player]] };</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[sendSimpleCommand]], [[useAISteeringComponent]], [[effectiveCommander]], [[setEffectiveCommander]], [[enableAI]], [[disableAI]], [[enableAIFeature]] |SEEALSO=
|x1= <sqf>onEachFrame { hintSilent str vehicleMoveInfo vehicle player };</sqf>


|seealso= [[sendSimpleCommand]] [[useAISteeringComponent]] [[effectiveCommander]] [[setEffectiveCommander]] [[enableAI]] [[disableAI]] [[getUnitState]] [[enableAIFeature]]
}}
}}
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|VEHICLEMOVEINFO]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:51, 22 October 2024

Hover & click on the images for description

Description

Description:
Returns current vehicle move/turn info (a getter for sendSimpleCommand) in format [moveInfo, turnInfo]. Possible values:
moveInfo turnInfo
  • "FORMATION" - vehicle is stationary
  • "FORWARD" - vehicle is moving forward
  • "FAST" - vehicle is fast moving forward
  • "SLOW" - vehicle is slow moving forward
  • "STOP" - vehicle is stationary
  • "BACK" - vehicle is reversing
  • "DirectByComander"sic - keyboard pilot is used, i.e. player is in the vehicle and is the effectiveCommander pressing any driving key (WASD or arrows).
  • "LEFT" - vehicle is turning left (use "STOPTURNING" to cancel)
  • "RIGHT" - vehicle is turning right (use "STOPTURNING" to cancel)
  • "NONE" - vehicle is not turning (when script command is used)
  • "ABS" - vehicle is not turning (when keyboard pilot is used)
Groups:
Object ManipulationUnit Control

Syntax

Syntax:
vehicleMoveInfo vehicle
Parameters:
vehicle: Object
Return Value:
Array in format [moveInfo, turnInfo], where:
  • moveInfo: String - state of vehicle forward/backward movement (see description)
  • turnInfo: String - state of vehicle left/right turning (see description)

Examples

Example 1:
onEachFrame { hintSilent str vehicleMoveInfo vehicle player };

Additional Information

See also:
sendSimpleCommand useAISteeringComponent effectiveCommander setEffectiveCommander enableAI disableAI getUnitState enableAIFeature

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