getCruiseControl: Difference between revisions

From Bohemia Interactive Community
No edit summary
(improved return value formatting for parser)
 
Line 18: Line 18:
|p1= vehicle: [[Object]] - the vehicle
|p1= vehicle: [[Object]] - the vehicle


|r1= [[Array]] format:
|r1= [[Array]] with [speedLimit, cruiseControlActive]
* 0: [[Number]] - defined speed limit
* speedLimit: [[Number]] - defined speed limit
* 1: [[Boolean]] - [[true]] if cruise control is enabled, [[false]] if only speed was limited
* cruiseControlActive: [[Boolean]] - [[true]] if cruise control is enabled, [[false]] if only speed was limited


|x1= <sqf>getCruiseControl vehicle player params ["_speedLimit", "_cruiseControlActive"];</sqf>
|x1= <sqf>getCruiseControl vehicle player params ["_speedLimit", "_cruiseControlActive"];</sqf>

Latest revision as of 17:56, 4 January 2026

Hover & click on the images for description

Description

Description:
Returns cruise control settings set with setCruiseControl command.
Groups:
Unit ControlObject Manipulation

Syntax

Syntax:
getCruiseControl vehicle
Parameters:
vehicle: Object - the vehicle
Return Value:
Array with [speedLimit, cruiseControlActive]
  • speedLimit: Number - defined speed limit
  • cruiseControlActive: Boolean - true if cruise control is enabled, false if only speed was limited

Examples

Example 1:
getCruiseControl vehicle player params ["_speedLimit", "_cruiseControlActive"];

Additional Information

See also:
setCruiseControl limitSpeed forceSpeed setAirplaneThrottle

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note