VehicleClient

swingBoatBoomToRatio

SWING_BOAT_BOOM_TO_RATIO0xF488C566413B4232

The GTA V native SWING_BOAT_BOOM_TO_RATIO of the VEHICLE namespace, as LS:MP client scripts call it: the global function swingBoatBoomToRatio, in JavaScript and in Lua.

SignatureJavaScript
swingBoatBoomToRatio(vehicle: Vehicle, ratio: number): void
SignatureLua
swingBoatBoomToRatio(vehicle: Vehicle, ratio: number)

Usage

JavaScript
swingBoatBoomToRatio(vehicle, ratio);
Lua
swingBoatBoomToRatio(vehicle, ratio)

Parameters

ParameterTypeJavaScriptLua
vehicleVehiclenumberinteger
ratiofloatnumbernumber

Returns

Nothing. In JavaScript the call evaluates to undefined.

Notes

From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.

Sets the boat boom position for the TR3 trailer.
Ratio value is between 0.0 and 1.0, where 0.0 is 90 degrees to the left of the boat, and 1.0 is just slightly to the right/back of the boat.
To get the current boom position ratio, use getBoatBoomPositionRatio

Reference

Namespace
Vehicle VEHICLE
In the game
void SWING_BOAT_BOOM_TO_RATIO(Vehicle vehicle, float ratio)
Hash
0xF488C566413B4232
Formerly
_SET_BOAT_BOOM_POSITION_RATIO

Open in the interactive natives reference