SetVehicleVariant

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function sets the variant of a specified vehicle. In GTA: San Andreas some vehicles are different; for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default variant list see: Vehicle variants.

* UPDATED IN VERSION 1.5.9 (BETA: 1.5.8 r20693):
Function is also available client-side (previously available server-side only).
[[{{{image}}}|link=|]] Tip: Both variant arguments need to be supplied, otherwise random ones will be picked.
[[{{{image}}}|link=|]] Tip: If you only want one variant, set 'variant2' to 255. If you want no variants, then set both 'variant1' and 'variant2' to 255.
[[{{{image}}}|link=|]] Note: The fairings on the NRG-500 and BF-400 are both variants, so unless you explicitly ask for 3 or 4, your bike will have no fairings which some people may find offensive.

Syntax

bool setVehicleVariant ( vehicle theVehicle [, int variant1, int variant2 ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:setVariant(...)
Counterpart: getVehicleVariant

Required Arguments

  • theVehicle: The vehicle that you want to set the variant.

Optional Arguments

Both arguments need to be supplied, otherwise random variants will be picked.

Returns

Returns true if the vehicle variants were successfully set, false otherwise (the specified vehicle doesn't exist or the specified variants are invalid).

Example

This example lets the vehicle driver set their vehicle's variant with a command:

function setMyVehicleVariants (thePlayer, commandName, arg1, arg2)
    local variant1, variant2 = tonumber (arg1), tonumber (arg2) -- If anything was passed make sure the arguments are numbers or pass nil
    local myVeh = getPedOccupiedVehicle (thePlayer) -- Get the vehicle that the player is in

    if (myVeh and getVehicleController (myVeh) == thePlayer) then -- Make sure the player is the vehicle driver (controller)
        local wasSet = setVehicleVariant (myVeh, variant1, variant2) -- Set the vehicle variants the player passed as arguments

        if wasSet then
            outputChatBox ("Vehicle variant successfully set!", thePlayer, 0, 255, 0)
        else
            outputChatBox ("Vehicle variant unsuccessfully set.", thePlayer, 255, 255, 0)
        end
    end
end

addCommandHandler ("setvehvar", setMyVehicleVariants) -- Create the command

Requirements

Minimum supported server version 1.2.0
Minimum supported client version 1.5.8-9.20693

Note: Using this function/event requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.2.0" client="1.5.8-9.20693" />

See Also

* UPDATED IN VERSION 1.5.9 (BETA: 1.5.8 r20693):