SetVehicleWheelStates: Difference between revisions

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


==Example==
==Example==
This example creates a new vehicle then punctures its front left wheel.
This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.
<syntaxhighlight lang="lua">local newcar = createVehicle ( 422, 1024, 1024, 1024 ) --Creates a Bobcat
<syntaxhighlight lang="lua">function scriptWheelStates ( player, command, newFLeft, newRLeft, newFRight, newRRight )
local state = setVehicleWheelStates ( newcar, 1 ) --Punctures the front-left wheel on the vehicle
  local theVehicle = getPlayerOccupiedVehicle ( player )
  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 ( "Wheel states:" ) -- output them in the chatbox
    outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ]
      .. ", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ] )
  else outputChatBox ( "You have to be in a vehicle to use this command." )
  end
end
addCommandHandler ( "wheelstates", scriptWheelStates )
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 15:16, 1 August 2007

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

setVehicleWheelStates ( vehicle theVehicle, int frontLeft, [ int rearLeft = -1, int frontRight = -1, int rearRight = -1 ])

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

Example

This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.

function scriptWheelStates ( player, command, newFLeft, newRLeft, newFRight, newRRight )
  local theVehicle = getPlayerOccupiedVehicle ( player )
  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 ( "Wheel states:" ) -- output them in the chatbox
    outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ]
      .. ", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ] )
  else outputChatBox ( "You have to be in a vehicle to use this command." )
  end
end
addCommandHandler ( "wheelstates", scriptWheelStates )

See Also