Client

WARNING: Using exports that modify the vehicles logic like SetManual or RemoveManual may cause issues if they are outside of a Thread and the vehicles are in the Config.Vehicles.

SetManual

Set the vehicle to manual gears

--- Set the vehicle as manual
-- @param vehicle - the vehicle
export["gn-gears"]:SetManual(vehicle)

-- @usage
local vehicle = GetVehiclePedIsUsing(Player)
export["gn-gears"]:SetManual(vehicle)

RemoveManual

Remove a Manual Car

--- @function Remove the vehicle as manual
-- @param vehicle - the vehicle
export["gn-gears"]:RemoveManual(vehicle)

-- @usage
local vehicle = GetVehiclePedIsUsing(Player)
export["gn-gears"]:RemoveManual(vehicle)

ShouldBeManual

Check if the vehicle is in forced manual vehicle list (Config.Vehicles)

--- @function Check if the car is manully natively or in Config.Vehicles
-- @param vehicle - the vehicle
-- @return boolean - is the vehicle manual
export["gn-gears"]:ShouldBeManual(vehicle)

-- @usage
local vehicle = GetVehiclePedIsUsing(Player)
local IsManual = export["gn-gears"]:ShouldBeManual(vehicle)

IsCustomCarManual

Check if the vehicle is added by the export and is not on the forced list of the script

--- @function Check if the car is manully added as manual
-- @param vehicle - the vehicle
-- @return boolean - is the vehicle manually added
export["gn-gears"]:IsCustomCarManual(vehicle)

-- @usage
local vehicle = GetVehiclePedIsUsing(Player)
local IsManuallyAdded = export["gn-gears"]:IsCustomCarManual(vehicle)

GetVehicleData

Retrive juicy information that can be used for HUDs, custom scripting or debugging

--- @function Get juicy information for carhuds o custom scripts
-- @param vehicle - the vehicle
-- @return IsNativeManual - is the vehicle manual on Config.Vehicles.
-- @return IsCustomCarManual - is the vehicle added manually using the export
-- @return CurrentGear - current vehicle gear
export["gn-gears"]:GetVehicleData(vehicle)

-- @usage
local vehicle = GetVehiclePedIsUsing(PlayerPedId())
local IsManual, CustomAdded, CurrentGear = export["gn-gears"]:GetVehicleData(vehicle)

IsRealisticMode

Check, if the script is in realistic mode

--- @function Verify is the mode is realistic
-- @return boolean
export["gn-gears"]:IsRealisticMode()

-- @usage
local isRealisticModeEnabled = export["gn-gears"]:IsRealisticMode()
if isRealisticModeEnabled then return end

IsArcadeMode

Check, if the script is in arcade mode

--- @function Verify is the mode is arcade
-- @return boolean
export["gn-gears"]:IsArcadeMode()

-- @usage
local IsArcadeModeEnabled = export["gn-gears"]:IsArcadeMode()
if IsArcadeModeEnabled then return end