setCruiseControl: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Explanation about how speed limiter works and potential pitfalls)
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
 
(8 intermediate revisions by 2 users not shown)
Line 2: Line 2:


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


Line 11: Line 8:
|eff= local
|eff= local


|descr= Limits or sets a player-controlled vehicle's speed through cruise control.<br>
|descr= Limits or sets '''[[local]] [[player]]-controlled''' vehicle's speed through cruise control.
Speed Limiter and Cruise Control are implemented using a PID controller overwriting the vehicles thrust input.<br>
 
Cruise control is implemented as a speed limiter that simulates 100% thrust input by the player.<br>
{{Feature|informative|
If you apply brakes while cruise control is enabled, the cruise control (and speed limit) will automatically disengage.<br>
* this command only works on CarX, TankX, ShipX simulation vehicles
If (deltaSpeed > setpoint*20% && speed > setpoint) the vehicle will automatically apply brakes to try to get back down to the setpoint.<br>
* this command is implemented using a PID controller overwriting the vehicle's thrust/brakes input
If (deltaSpeed > setpoint*20% && speed < setpoint) the vehicle will always apply 100% thrust.<br><br>
{{Feature|important|
Executing this script command resets the PID controller.<br>
Meaning if you do it every frame you will break the automatic thrust control, so don't do that.<br>
You should only call ''setCruiseControl'' to ''change'' the setpoint.<br><br>
This command only works for:
* The local player
* CarX, TankX and ShipX simulated vehicles
* Forward speeds (positive ''speed'')
}}
}}
{{{!}} class="wikitable"
! Speed Limiter
! Cruise Control
{{!}}- style="vertical-align: top"
{{!}}
* the vehicle does not accelerate by itself
* manually accelerating is required to move forward
* accelerating beyond set speed limit is restricted by the PID controller
* applying brakes does not disable Speed Limiter
* behaviour:
** if the speed is over 120% the set limit, the vehicle will apply 100% of braking and limit acceleration to 0%
** if the speed is below 80% the set limit, the acceleration and braking are untouched
** between 80 and 120%, the PID controller limits the acceleration and applies brakes if required
{{!}}
* the vehicle accelerates by itself
* manually accelerating is possible
* accelerating above set speed limit is possible
* applying brakes disables Cruise Control
* behaviour:
** if the speed is over 120% the set limit, the vehicle will apply 100% of braking
** if the speed is below 80% the set limit, the vehicle will apply 100% of acceleration
** between 80 and 120%, the PID controller manages the speed
{{!}}}
{{Feature|important|This command should only be called to ''change'' values and '''not''' be called every frame, as it resets the PID controller.}}


|gr1= Unit Control
|gr1= Unit Control
Line 33: Line 47:
|s1= vehicle [[setCruiseControl]] [speed, autoThrust]
|s1= vehicle [[setCruiseControl]] [speed, autoThrust]


|p1= vehicle: [[Object]] - The vehicle to limit
|p1= vehicle: [[Object]] - the vehicle to limit; [[local]] [[player]]'s vehicle (<sqf inline>vehicle player</sqf>)


|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]]


|x1= <code>[[vehicle]] [[player]] [[setCruiseControl]] [50, [[true]]]; {{cc|sets cruise control to 50 km/h}}</code>
|x1= <sqf>vehicle player setCruiseControl [50, true]; // sets cruise control to 50 km/h</sqf>


|x2= <code>[[vehicle]] [[player]] [[setCruiseControl]] [5, [[false]]]; {{cc|limits player's vehicle speed to 5 km/h}}</code>
|x2= <sqf>vehicle player setCruiseControl [5, false]; // limits player's vehicle speed to 5 km/h</sqf>


|seealso= [[getCruiseControl]] [[limitSpeed]] [[forceSpeed]] [[setAirplaneThrottle]]
|seealso= [[getCruiseControl]] [[limitSpeed]] [[forceSpeed]] [[setAirplaneThrottle]]
}}
}}

Latest revision as of 13:59, 8 November 2023

Arma 3 logo black.png2.06
LALocalLELocal
Hover & click on the images for description

Description

Description:
Limits or sets local player-controlled vehicle's speed through cruise control.
ⓘ
  • this command only works on CarX, TankX, ShipX simulation vehicles
  • this command is implemented using a PID controller overwriting the vehicle's thrust/brakes input
Speed Limiter Cruise Control
  • the vehicle does not accelerate by itself
  • manually accelerating is required to move forward
  • accelerating beyond set speed limit is restricted by the PID controller
  • applying brakes does not disable Speed Limiter
  • behaviour:
    • if the speed is over 120% the set limit, the vehicle will apply 100% of braking and limit acceleration to 0%
    • if the speed is below 80% the set limit, the acceleration and braking are untouched
    • between 80 and 120%, the PID controller limits the acceleration and applies brakes if required
  • the vehicle accelerates by itself
  • manually accelerating is possible
  • accelerating above set speed limit is possible
  • applying brakes disables Cruise Control
  • behaviour:
    • if the speed is over 120% the set limit, the vehicle will apply 100% of braking
    • if the speed is below 80% the set limit, the vehicle will apply 100% of acceleration
    • between 80 and 120%, the PID controller manages the speed
⚠
This command should only be called to change values and not be called every frame, as it resets the PID controller.
Groups:
Unit ControlObject Manipulation

Syntax

Syntax:
vehicle setCruiseControl [speed, autoThrust]
Parameters:
vehicle: Object - the vehicle to limit; local player's vehicle (vehicle player)
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
Retrieved from "https://community.bistudio.com/wiki?title=setCruiseControl&oldid=348375"