SetVehicleModel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Server client function}}
__NOTOC__
__NOTOC__
This function changes the model of the specified vehicle. If the new vehicle model has less seats than the current model, any excess passenger will be removed from the vehicle.
{{Deprecated|setElementModel}}
This function changes the model of the specified vehicle. If the new vehicle model has less seats than the current model, any excess passengers will be removed from the vehicle.


==Syntax==
==Syntax==
Line 31: Line 32:
</section>
</section>
After the above code is executed, a player can get in any vehicle and execute e.g. the command "/changeveh 520" to change it into a hydra.
After the above code is executed, a player can get in any vehicle and execute e.g. the command "/changeveh 520" to change it into a hydra.
==See Also==
{{Vehicle functions}}

Latest revision as of 12:51, 3 July 2014


Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use setElementModel instead.

This function changes the model of the specified vehicle. If the new vehicle model has less seats than the current model, any excess passengers will be removed from the vehicle.

Syntax

bool setVehicleModel ( vehicle theVehicle, int model )

Required Arguments

  • theVehicle: the vehicle you want to change the model of.
  • model: the new model you want to set.

Returns

Returns true if the new model was successfully applied, false if it failed.

Example

This very simple example that allows a player to change the vehicle he is in with a console command. In actual gamemodes the function can be used for more interesting things, like vehicle change pickups.

Click to collapse [-]
Server
addCommandHandler("changeveh",
    function(thePlayer, command, newModel)
        local theVehicle = getPlayerOccupiedVehicle(thePlayer)  -- get the vehicle the player is in
        newModel = tonumber(newModel)                           -- try to convert the string argument to a number
        if theVehicle and newModel then                         -- make sure the player is in a vehicle and specified a number
            setVehicleModel(theVehicle, newModel)
        end
    end
)

After the above code is executed, a player can get in any vehicle and execute e.g. the command "/changeveh 520" to change it into a hydra.

See Also