GetBoatVehicleModelAgility - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: VEHICLEAPI set: clientGame: gta5editImprove

GET_BOAT_VEHICLE_MODEL_AGILITY

0x5AA3F878A178C4FC

0x87C5D271

// GetBoatVehicleModelAgility
float GET_BOAT_VEHICLE_MODEL_AGILITY(Hash modelHash);

Parameters:

modelHash:
The model hash of the boat.

Returns:

Returns the agility value of the specified boat as a float number.

Retrieves the agility for a specific boat model, including any vehicle mods. Unlike other vehicles where Rockstar Games typically assess performance based on traction, boats use agility as a measure. This static value is distinct from the traction metrics used for other vehicle types.

NativeDB Introduced: v323

Old name: _GET_VEHICLE_MODEL_MOVE_RESISTANCE

Examples:

Lua
JavaScript
C#

-- This example prints the agility of the player's current boat.

-- Retrieve the player ped.
local playerPed = PlayerPedId()

-- Retrieve the vehicle the player is currently in.
local vehicle = GetVehiclePedIsIn(playerPed, false)

-- Retrieve the model hash of the boat.
local boatHash = GetEntityModel(vehicle)

-- If the vehicle does not exist or is not a boat, end the execution of the code here.
if not DoesEntityExist(vehicle) or not IsThisModelABoat(boatHash) then 
    return 
end

-- Retrieve the agility of the boat.
local agility = GetBoatVehicleModelAgility(boatHash)

-- Print the agility of the boat.
print("Boat Agility: " .. agility)

DOES_SCRIPT_VEHICLE_GENERATOR_EXIST(int vehicleGenerator)

_DOES_VEHICLE_ALLOW_RAPPEL(Vehicle vehicle)

DOES_VEHICLE_EXIST_WITH_DECORATOR(char* decorator)

_DOES_VEHICLE_HAVE_LANDING_GEAR(Vehicle vehicle)

DOES_VEHICLE_HAVE_ROOF(Vehicle vehicle)

DOES_VEHICLE_HAVE_SEARCHLIGHT(Vehicle vehicle)

DOES_VEHICLE_HAVE_STUCK_VEHICLE_CHECK(Vehicle vehicle)

DOES_VEHICLE_HAVE_WEAPONS(Vehicle vehicle)

_DOES_VEHICLE_TYRE_EXIST(Vehicle vehicle, int tyreIndex)

_EJECT_JB700_ROOF(Vehicle vehicle, float x, float y, float z)

_ENABLE_AIRCRAFT_OBSTACLE_AVOIDANCE(Vehicle vehicle, BOOL avoidObstacles)

EXPLODE_VEHICLE(Vehicle vehicle, BOOL isAudible, BOOL isInvisible)

EXPLODE_VEHICLE_IN_CUTSCENE(Vehicle vehicle, BOOL p1)

_FIND_RANDOM_POINT_IN_SPACE(Ped ped)

_FIND_VEHICLE_CARRYING_THIS_ENTITY(Entity entity)

FIX_VEHICLE_WINDOW(Vehicle vehicle, int windowIndex)

FORCE_PLAYBACK_RECORDED_VEHICLE_UPDATE(Vehicle vehicle, BOOL p1)

FORCE_SUBMARINE_NEURTAL_BUOYANCY(Vehicle submarine, int time)

FORCE_SUBMARINE_SURFACE_MODE(Vehicle vehicle, BOOL toggle)

FULLY_CHARGE_NITROUS(Vehicle vehicle)

_GET_ALL_VEHICLES(int* vehArray)

GET_BOAT_BOOM_POSITION_RATIO(Vehicle vehicle)

_GET_BOAT_BOOM_POSITION_RATIO_2(Vehicle vehicle, BOOL p1)

_GET_BOAT_BOOM_POSITION_RATIO_3(Vehicle vehicle, BOOL p1)

GET_BOAT_VEHICLE_MODEL_AGILITY(Hash modelHash)

_GET_CAN_VEHICLE_JUMP(Vehicle vehicle)

_GET_CARGOBOB_HOOK_POSITION(Vehicle cargobob)

GET_CLOSEST_VEHICLE(float x, float y, float z, float radius, Hash modelHash, int flags)

GET_CONVERTIBLE_ROOF_STATE(Vehicle vehicle)

GET_CURRENT_PLAYBACK_FOR_VEHICLE(Vehicle vehicle)

GET_DISPLAY_NAME_FROM_VEHICLE_MODEL(Hash modelHash)

_GET_DOES_VEHICLE_HAVE_TOMBSTONE(Vehicle vehicle)

_GET_DRIFT_TYRES_ENABLED(Vehicle vehicle)

_GET_ENTITY_ATTACHED_TO_CARGOBOB(Vehicle vehicle)

GET_ENTITY_ATTACHED_TO_TOW_TRUCK(Vehicle towTruck)