GetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added an example.)
m (Changed the wording.)
Line 18: Line 18:
==Returns==
==Returns==
If successful, one of the following integers will be returned:
If successful, one of the following integers will be returned:
* '''0:''' Shut (Undamaged) (also returned if no such door exists on the vehicle)
* '''0:''' Shut, intact (also returned if the door does not exist)
* '''1:''' Open (Undamaged)
* '''1:''' Ajar, intact
* '''2:''' Shut (Damaged)
* '''2:''' Shut, damaged
* '''3:''' Open (Damaged)
* '''3:''' Ajar, damaged
* '''4:''' Fallen off
* '''4:''' Missing




Revision as of 05:28, 24 December 2011

This function returns the current state of the specifed door on the vehicle.

Syntax

int getVehicleDoorState ( vehicle theVehicle, int door )

Required Arguments

  • theVehicle: The vehicle you want to get the door status of.
  • door: A whole number representing which door to get the status of. Valid values are:
    • 0: Hood
    • 1: Trunk
    • 2: Front left
    • 3: Front right
    • 4: Rear left
    • 5: Rear right

Returns

If successful, one of the following integers will be returned:

  • 0: Shut, intact (also returned if the door does not exist)
  • 1: Ajar, intact
  • 2: Shut, damaged
  • 3: Ajar, damaged
  • 4: Missing


Example

This example implements a doesVehicleHaveDoorOpen() function, that returns true if any of the doors on a vehicle are open. 

function doesVehicleHaveDoorOpen(vehicle)
	local isDoorAjar = false
	for i=0,5 do
		local doorState = getVehicleDoorState(vehicle, i)
		if doorState == 1 or doorState == 3 or doorState == 4 then
			isDoorAjar = true
		end
	end
	
	return isDoorAjar
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleDoorState?oldid=28807"