SetVehicleWheelStates

2009-10-15T17:20:30Z

HomieClone:

__NOTOC__
{{Server client function}}
{{Needs Checking| In practice the argument order is vehicle, frontLeft, frontRight, backLeft, backRight. Also -1 doesn't work.}}
This function sets the state of wheels on the vehicle.

Internally, no vehicles have more than 4 wheels. If they appear to, they will be duplicating other wheels.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleWheelStates ( vehicle theVehicle, int frontLeft, [ int rearLeft = -1, int frontRight = -1, int rearRight = -1 ])</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the wheel states of.
*'''frontLeft:''' A whole number representing the wheel state (-1 for no change)

==Optional Arguments==
*'''rearLeft:''' A whole number representing the wheel state (-1 for no change)
*'''frontRight:''' A whole number representing the wheel state (-1 for no change)
*'''rearRight:''' A whole number representing the wheel state (-1 for no change)

==Wheel-State values==
* '''0:''' Inflated
* '''1:''' Flat
* '''2:''' Fallen off
* '''3:''' Collisionless

==Returns==
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.

==Example==
<section name="Server" class="server" show="true">
This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.
<syntaxhighlight lang="lua">
function scriptWheelStates ( thePlayer, command, newFLeft, newRLeft, newFRight, newRRight )
local theVehicle = getPlayerOccupiedVehicle ( thePlayer )
if ( theVehicle ) then -- check if the player is in a car
if ( newFLeft ) then -- if there's at least one argument passed, we change the wheel states
if not setVehicleWheelStates ( theVehicle, newFLeft, newRLeft, newFRight, newRRight ) then
outputChatBox ( "Bad arguments." )
end
end
local states = { [0]="inflated", [1]="flat", [2]="fallen off" } -- we store the states in a table
local frontLeft, frontRight, rearLeft, rearRight = getVehicleWheelStates ( theVehicle )
outputChatBox ( "Your vehicle's wheel states:", thePlayer ) -- output them in the chatbox
outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ] ..
", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ], thePlayer )
else
outputChatBox ( "You have to be in a vehicle to use this command.", thePlayer )
end
end
addCommandHandler ( "wheelstates", scriptWheelStates )</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

Multi Theft Auto: Wiki - User contributions [en]

SetVehicleWheelStates