GetIsBoatCapsized - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: VEHICLEAPI set: clientGame: gta5editImprove

GET_IS_BOAT_CAPSIZED

0xBA91D045575699AD

// GetIsBoatCapsized
BOOL GET_IS_BOAT_CAPSIZED(Vehicle vehicle);

Parameters:

vehicle:
The vehicle to check. This should be a boat-type vehicle.

Returns:

Returns true if the specified boat is capsized, false otherwise.

Checks whether the specified boat vehicle is capsized, meaning it has overturned or is upside down in the water.

Examples:

Lua
JavaScript
C#

-- This example checks if the player is in a boat and if the boat is capsized.

-- Retrieve the LocalPlayer.
local playerPed = PlayerPedId()

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

-- Retrieve the model of the vehicle
local vehicleModel = GetEntityModel(vehicle)

-- Check if the vehicle exists in the game world.
if not DoesEntityExist(vehicle) then 
    -- If the vehicle does not exist, end the execution of the code here.
    return 
end

-- Check if the vehicle is a boat.
if not IsThisModelABoat(vehicleModel) then
    -- If the vehicle is not a boat, end the execution of the code here.
    return
end

-- Check if the boat is capsized.
if GetIsBoatCapsized(vehicle) then
    print("The boat is capsized!")
else
    print("The boat is not capsized!")
end

FORCE_SUBMARINE_NEURTAL_BUOYANCY(Vehicle submarine, int time)

FORCE_SUBMARINE_SURFACE_MODE(Vehicle vehicle, BOOL toggle)

_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)

_GET_ENTRY_POSITION_OF_DOOR(Vehicle vehicle, int doorIndex)

_GET_HAS_RETRACTABLE_WHEELS(Vehicle vehicle)

_GET_HAS_ROCKET_BOOST(Vehicle vehicle)

GET_HELI_MAIN_ROTOR_HEALTH(Vehicle vehicle)

GET_HELI_TAIL_BOOM_HEALTH(Vehicle vehicle)

GET_HELI_TAIL_ROTOR_HEALTH(Vehicle vehicle)

_GET_HYDRAULIC_WHEEL_VALUE(Vehicle vehicle, int wheelId)

GET_IS_BOAT_CAPSIZED(Vehicle vehicle)

_GET_IS_DOOR_VALID(Vehicle vehicle, int doorIndex)

GET_IS_LEFT_VEHICLE_HEADLIGHT_DAMAGED(Vehicle vehicle)

GET_IS_RIGHT_VEHICLE_HEADLIGHT_DAMAGED(Vehicle vehicle)

_GET_IS_VEHICLE_EMP_DISABLED(Vehicle vehicle)

GET_IS_VEHICLE_ENGINE_RUNNING(Vehicle vehicle)

GET_IS_VEHICLE_PRIMARY_COLOUR_CUSTOM(Vehicle vehicle)

GET_IS_VEHICLE_SECONDARY_COLOUR_CUSTOM(Vehicle vehicle)

_GET_IS_VEHICLE_SHUNT_BOOST_ACTIVE(Vehicle vehicle)

_GET_IS_WHEELS_LOWERED_STATE_ACTIVE(Vehicle vehicle)

GET_LANDING_GEAR_STATE(Vehicle vehicle)