setCruiseControl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Remove invalid examples, clarify forwards only)
m (fixed some typos and inconsistencies)
Line 2: Line 2:


|game1= arma3
|game1= arma3
|branch= dev
|version1= 2.06
|version1= 2.06


|arg= local
|arg= local
|eff= local
|eff= local


|branch= dev
|descr= Limits or sets a player-controlled vehicle's speed through cruise control. {{Feature|important|This command only works for:
 
* The local player
|descr= Limits or set a player-controlled vehicle's speed through cruise control. {{Feature|important|This command only works:
* CarX, TankX and ShipX simulated vehicles
* for the local player
* Forward speeds (positive ''speed'')
* on CarX, TankX and ShipX simulated vehicles
* with forward speeds
}}
}}


Line 21: Line 23:
|s1= vehicle [[setCruiseControl]] [speed, autoThrust]
|s1= vehicle [[setCruiseControl]] [speed, autoThrust]


|p1= vehicle: [[Object]] - the vehicle to limit
|p1= vehicle: [[Object]] - The vehicle to limit


|p2= speed: [[Number]] - desired/top speed in km/h. 0 to disable any setting. Only positives values are valid, negative values will make the vehicle unable to move forward.
|p2= speed: [[Number]] - Desired/top speed in km/h. 0 to disable any setting. Only positives values are valid, negative values will make the vehicle unable to move forward


|p3= autoThrust: [[Boolean]]
|p3= autoThrust: [[Boolean]]
* [[true]] - cruise control. The vehicle will maintain this speed until brakes is applied or driver dies or leaves the vehicle
* [[true]] - Cruise control. The vehicle will maintain this speed until brakes is applied or driver dies or leaves the vehicle
* [[false]] - speed limiter - The vehicle will not accelerate above set speed
* [[false]] - Speed limiter. The vehicle will not accelerate above set speed


|r1= [[Nothing]]
|r1= [[Nothing]]

Revision as of 16:29, 26 May 2021

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.06.

Description

Description:
Limits or sets a player-controlled vehicle's speed through cruise control.
This command only works for:
  • The local player
  • CarX, TankX and ShipX simulated vehicles
  • Forward speeds (positive speed)
Groups:
Unit ControlObject Manipulation

Syntax

Syntax:
vehicle setCruiseControl [speed, autoThrust]
Parameters:
vehicle: Object - The vehicle to limit
speed: Number - Desired/top speed in km/h. 0 to disable any setting. Only positives values are valid, negative values will make the vehicle unable to move forward
autoThrust: Boolean
  • true - Cruise control. The vehicle will maintain this speed until brakes is applied or driver dies or leaves the vehicle
  • false - Speed limiter. The vehicle will not accelerate above set speed
Return Value:
Nothing

Examples

Example 1:
vehicle player setCruiseControl [50, true]; // sets cruise control to 50 km/h
Example 2:
vehicle player setCruiseControl [5, false]; // limits player's vehicle speed to 5 km/h

Additional Information

See also:
getCruiseControl limitSpeed forceSpeed setAirplaneThrottle

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