Documentation

Config

Explanations and examples for the current vehicle lifts configuration.

Edit zyke_vehiclelifts/shared/config.lua. Distances and heights are metres, and speeds are metres per second. Lifts that always stand are listed in zyke_vehiclelifts/shared/lifts.lua.

The interact keybind can be changed in GTA / FiveM settings. Framework and permission settings live in zyke_lib.

#Full Default Config

#Config.Settings.vehiclelifts

#kinds.twopost.speed

Speed the carriages travel at, up and down. Every player in the bay sees the same motion.

Example:

lua
speed = 0.10

#kinds.twopost.low

Height of the car's sills off the floor at the low stop, where the car is worked on lying on a creeper.

Example:

lua
low = 0.55

#kinds.twopost.waist

Height of the car's wheel hubs off the floor at the waist stop, where wheels and corners are worked on standing.

Example:

lua
waist = 0.95

#kinds.twopost.high

Height of the car's sills off the floor at the high stop, where players walk under the car. The posts take a car no higher than sills at 2.20.

Example:

lua
high = 2.20

Each stop lands on the lock of the posts nearest to its height. A stop that would stand no higher than the one before it is left out for that car.

#interaction

How players use the power unit and the arms. "point" shows zyke_lib interaction markers, used with E while looking at them. "target" uses ox_target or qb-target through zyke_lib, with options on the power unit and on the car. Without a target resource running, "target" falls back to interaction markers and prints a console warning.

Example:

lua
interaction = "point"

#admin.enabled

Enables the admin command.

Example:

lua
enabled = true

#admin.command

Command that places a lift where the admin stands, or removes the nearest placed lift. See Commands.

Example:

lua
command = "vehiclelifts"

#admin.permission

Permission checked by the admin command through zyke_lib. Use one permission or a list; any match grants access. command is the ACE permission, and the remaining defaults are the ESX admin groups.

Example:

lua
permission = {"command", "admin", "superadmin", "owner"}

#Lifts

Lifts in shared/lifts.lua stand for as long as the resource runs. /vehiclelifts prints a ready line for this list. Other resources place lifts with CreateLift instead; see Exports & Events.

#VehicleLifts.<lift>.coords

Point on the floor, midway between where the two posts stand. The right post, with the power unit on its outside, stands 1.6 metres to the right of the heading.

Example:

lua
coords = vec3(-1366.5, -3007.1, 12.95)

#VehicleLifts.<lift>.heading

Heading in degrees, the way a car's nose points when it is driven in between the posts. Defaults to 0.0.

Example:

lua
heading = 240.0

#VehicleLifts.<lift>.kind

Kind of lift, a key under kinds. Defaults to "twopost".

Example:

lua
kind = "twopost"

#Full Lift Entry

A complete shared/lifts.lua with one lift, as printed by /vehiclelifts.

Example:

lua
VehicleLifts = {
    {coords = vec3(-1366.512, -3007.104, 12.950), heading = 240.0, kind = "twopost"},
}