setCruiseControl: Difference between revisions

Revision as of 16:48, 26 May 2021

2.06

LALocal LELocal

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 set a player-controlled vehicle's speed through cruise control.

⚠

This command only works:

for the local player
on CarX, TankX and ShipX simulated vehicles
with forward speeds

Groups:

Unit Control Object 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

@@ Line 12: / Line 12: @@
 * for the local player
 * on CarX, TankX and ShipX simulated vehicles
+* with forward speeds
 }}
@@ Line 22: / Line 23: @@
 |p1= vehicle: [[Object]] - the vehicle to limit
-|p2= speed: [[Number]] - desired/top speed in km/h. 0 to disable any setting. Negative values for reverse gear speed
+|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]]
@@ Line 33: / Line 34: @@
 |x2= <code>[[vehicle]] [[player]] [[setCruiseControl]] [5, [[false]]]; {{cc|limits player's vehicle speed to 5 km/h}}</code>
-|x3= <code>[[vehicle]] [[player]] [[setCruiseControl]] [-5, [[true]]]; {{cc|will make the vehicle go backwards}}</code>
-|x4= <code>[[vehicle]] [[player]] [[setCruiseControl]] [-5, [[false]]]; {{cc|will make the vehicle go backwards too (speed cannot be over -5 km/h)}}</code>
 |seealso= [[getCruiseControl]] [[limitSpeed]] [[forceSpeed]] [[setAirplaneThrottle]]
 }}