Build your own wm_vehiclecontroll file!

Give each vehicle its own Lua file in the vehicles folder. The script loads files in that folder when the resource starts. The example below uses one moving boom; replace it with the parts on your own model. If several versions share the same equipment, see Vehicle variants.

RegisterRecoveryVehicleConfig('my_rig', {
    model = 'my_rig',
    name = 'My Rig',
    speed = 1.0,
    control = {
        radius = 20.0,
        menu = { enabled = false }
    },
    props = {
        {
            name = 'boom',
            prop = 'my_rig_boom',
            attach = 'vehicle',
            offSet = { 0.0, -2.0, 0.5 },
            rotation = { 0.0, 0.0, 0.0 },
            rotation_min = { 0.0, 0.0, 0.0 },
            rotation_max = { 15.0, 0.0, 0.0 },
            offset_min = { 0.0, 0.0, 0.0 },
            offset_max = { 0.0, 0.0, 0.0 },
            controlls = {
                { button = 173, movementType = 'rotate', axis = 1, movementAmount = 0.1 },
                { button = 172, movementType = 'rotate', axis = 1, movementAmount = -0.1 }
            }
        }
    }
})

Change my_rig to your vehicle's spawn name, then replace the boom model and positions with your own. Restart the resource to load your changes.

Start with the vehicle model and the parts you want to move. The settings below go inside its vehicle definition, next to props. Attachment and operator options have their own sections further down this page.

Think of props as the vehicle's working parts: bed, boom, ladder, lift, hook and so on. Each part needs a name, a model and something to attach to. Attach the first part to 'vehicle'; attach later parts to the name of another part if they should move together. Positions use three numbers in X, Y, Z order.

Each part can respond to one or more buttons. Add those actions to its controlls list. The button number chooses the FiveM input; movementType says what the button does. The script supports these ten actions. Placing a person on a part uses a separate setting called pedplace.

Button Conditions decide when a button may be used. Add them to a button inside a prop's controlls. They work with Toggle, Attach Vehicle by Wheel, Attach Vehicle by Body and Attach Trailer. For Toggle, the conditions are checked when showing a hidden part; the same button can still hide it again.

Use the exact names of other parts from your props list. This example shows every condition on one Toggle button; keep only the ones your vehicle needs.

visible = false,
controlls = {
    {
        button = 201,
        movementType = 'toggle',
        requiresVisibleProp = 'cover',
        requiresHiddenProp = 'boom',
        requiresHiddenProps = { 'left_foot', 'right_foot' },
        requiresNoWheelAttachment = true,
        requiresNoTrailerAttachment = true
    }
},

Move slides a prop, Rotate turns it, and Toggle shows or hides it. Give each movement direction its own button. The axis chooses X, Y or Z; a positive or negative amount chooses which way it moves. Set the prop's minimum and maximum positions so it stops at the right point.

controlls = {
    { button = 173, movementType = 'rotate', axis = 1, movementAmount = 0.1 },
    { button = 172, movementType = 'rotate', axis = 1, movementAmount = -0.1 },
    { button = 174, movementType = 'move', axis = 2, movementAmount = 0.01 },
    { button = 175, movementType = 'move', axis = 2, movementAmount = -0.01 },
    { button = 201, movementType = 'toggle' }
}

Set visible to false on a prop that should start hidden. Add only the buttons that make sense for that part of your rig.

Rope connects a prop, such as a boom, to a second prop, such as a hook block. One button lets rope out and another reels it in. Give both buttons the same rope name and set attachto to the prop at the other end.

controlls = {
    {
        button = 173,
        movementType = 'rope',
        name = 'mainHoist',
        attachto = 'hookblock',
        direction = 1,
        speed = 0.5,
        initialLength = 0.5,
        maxLength = 30.0,
        points = {
            { from = { 0.0, 1.0, 0.0 }, to = { 0.0, 0.0, 0.0 } }
        }
    },
    {
        button = 172,
        movementType = 'rope',
        name = 'mainHoist',
        attachto = 'hookblock',
        direction = -1,
        speed = 0.5,
        initialLength = 0.5,
        maxLength = 30.0
    }
},

Water Particle makes a nozzle or other prop spray a chosen effect when its button is pressed. Set asset and name to the effect you want, then move the spray to the right place with offSet and rotation. The example can be switched on and cycles through three spray sizes.

controlls = {
    {
        button = 157,
        movementType = 'waterparticle',
        asset = 'core',
        name = 'water_cannon_jet',
        toggle = true,
        scales = { 1.0, 1.5, 2.0 },
        offSet = { 0.0, 0.0, 0.0 },
        rotation = { 0.0, 0.0, 0.0 }
    }
},

Attach Vehicle fixes a nearby vehicle to the chosen prop of your rig, such as a flatbed. The offSet and rotation in the button action decide where the vehicle sits. Press the button again to release it.

Where it goes: inside the controlls of the prop that carries the vehicle, such as your bed. Put controlls next to that prop's offSet and rotation.

controlls = {
    {
        button = 47,
        movementType = 'attachvehicle',
        offSet = { 0.0, 0.0, 0.35 },
        rotation = { 0.0, 0.0, 0.0 },
        radius = 8.0
    }
},

Attach Vehicle by Wheel holds a vehicle by its two front wheels on your wheel-lift prop. Put one pickup point under the left wheel and one under the right. The button couples or releases the vehicle.

Where it goes: inside the controlls of your wheel-lift prop.

controlls = {
    {
        button = 29,
        movementType = 'attachvehiclebywheel',
        axis = 1,
        rotationFollowAxis = 3,
        points = {
            { name = 'left', offSet = { -0.83, -0.65, 0.26 }, bone = 'wheel_lf', radius = 5.0 },
            { name = 'right', offSet = { 0.83, -0.65, 0.26 }, bone = 'wheel_rf', radius = 5.0 }
        }
    }
},

Attach Vehicle by Body holds a vehicle at two points on its body. Use it for a cradle or rotator that lifts the vehicle without gripping the wheels. Put left and right pickup points on the carrying prop, then use the button to couple or release the vehicle.

Where it goes: inside the controlls of the cradle or rotator prop that touches the recovered vehicle.

controlls = {
    {
        button = 29,
        movementType = 'attachvehiclebybody',
        axis = 1,
        rotationFollowAxis = 3,
        points = {
            { name = 'left', offSet = { -0.68, -0.42, 0.0 }, radius = 5.0 },
            { name = 'right', offSet = { 0.68, -0.42, 0.0 }, radius = 5.0 }
        }
    }
},

Attach Trailer lets you place an attach_female hitch point at an offset on one of your rig's props. Press the chosen button to attach a trailer to that prop. The trailer connects through its attach_male bone.

Where it goes: add this button to the prop that holds the trailer hitch. The three position numbers in the example place the hitch on that prop: left or right, forward or back, and up or down.

controlls = {
    {
        button = 29,
        movementType = 'attachtrailer',
        bone = 'attach_male',
        point = { offSet = { 0.0, -0.21, 0.19 }, radius = 5.0 }
    }
},

The radius sets how close the trailer needs to be to connect; use a value above 0 and no higher than 5.

Attach Container fixes a nearby container to a prop at the position set by offSet and rotation. Its button works only when the vehicle's animConvRoof is at state 2. Press the button again to release the container.

Where it goes: inside the controlls of the prop that holds the container. In this example, that prop is the bed.

controlls = {
    {
        button = 47,
        movementType = 'attachcontainer',
        attachcontainer = 'container_mount',
        anchorProp = 'bed',
        offSet = { 0.0, 0.0, 0.0 },
        rotation = { 0.0, 0.0, 0.0 },
        radius = 8.0
    }
},

Dynamic Vehicle Attach secures another vehicle to any rig prop listed in allowedProps. You can list several props. Set vehicle to true to allow attachment to the rig's vehicle body as well, or false to use only the listed props.

Where it goes: next to props in the vehicle Lua file. This feature has no controlls action.

dynamicAttach = {
    allowedProps = { 'bed' },
    vehicle = true,
    automatic = true
},

Add more prop names after bed, separated by commas. With automatic set to true, a vehicle can be secured after it comes to rest on an allowed surface. Set it to false when the operator should attach it manually.

Dynamic Prop Attach secures loose objects on a rig prop, such as equipment on a bed. When the vehicle travels, those objects stay with the prop. Add this setting to the prop that carries them; there is no button action for it.

dynamicpropattach = {
    radius = 3.0,
    surfaceTolerance = 0.35,
    maxHeight = 2.5,
    maxObjects = 8
},

Radius sets the area around the prop. Surface tolerance and maximum height decide which objects count as cargo; maxObjects limits how many are secured. For the standard values, set dynamicpropattach to true on the prop. This works with networked objects.

Ped Place gives a player a position on a prop, such as a cage or basket. Add it inside that prop's controlls and choose the command they use to get on or off. One command can do both; you can also give entering and leaving separate commands.

controlls = {
    {
        pedplace = true,
        command = 'cage',
        pedplacecontroll = true,
        offSet = { -0.2, 1.0, 0.95 },
        rotation = { 0.0, 0.0, 0.0 }
    }
},

For a stretcher, setplayerinit = true lets the operator choose a nearby player to place on it. This mode needs pedplacecontroll = false. To play an animation while that player is on the prop, set animation = true. thisdict names the animation set; thisname names the animation within it. Both must be filled in when animation is enabled.

controlls = {
    {
        pedplace = true,
        command = 'stretcher',
        pedplacecontroll = false,
        setplayerinit = true,
        offSet = { 0.0, 0.0, 1.255 },
        rotation = { 0.0, 0.0, -90.0 },
        animation = true,
        thisdict = 'anim@gangops@morgue@table@',
        thisname = 'body_search'
    }
},

Add pedPlaceHideGuard = true to the prop if it should stay visible while someone is on it.

Operator Control sets where a person can operate the rig and what happens when they start. Radius decides how close they must be; attach chooses the vehicle body or a moving prop as their operating point. You can open a menu and play a remote-control animation. Add this table beside props in the vehicle Lua.

Set secondaryremotecontrol = true to offer a second handheld remote option. The player can start control near the vehicle without standing at the usual operator point. The radius still decides how close they need to be.

control = {
    radius = 20.0,
    attach = 'vehicle',
    secondaryremotecontrol = true,
    menu = {
        enabled = true,
        resourceName = 'my_vehicle_menu',
        automaticOpen = true,
        key = 311,
        ownsFocus = true,
        returnControl = 56
    },
    animation = {
        enabled = true,
        idle = { dict = 'wm_wv_pedanim', name = 'idle', flag = 49 },
        prop = {
            enabled = true,
            model = 'wm_wv_remotecontroll',
            attachToPed = {
                boneIndex = 57005,
                offSet = { 0.19, 0.05, -0.22 },
                rotation = { -60.0, -114.0, 12.0 }
            }
        }
    }
},

Winch Attach Points adds places where a winch can connect on a rig prop. The player chooses one of these fixed points, then chooses what to pull. Add the points to the prop; offSet places each one on the model and radius sets how close the player must stand.

winchAttachPoints = {
    { name = 'left', offSet = { -1.15, 0.0, -0.56 }, radius = 1.5 },
    { name = 'right', offSet = { 1.15, 0.0, -0.56 }, radius = 1.5 }
},