GetVehicleDoorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Made the argument and return sections clearer.)
 
(4 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">int getVehicleDoorState ( vehicle theVehicle, int door )</syntaxhighlight>
<syntaxhighlight lang="lua">int getVehicleDoorState ( vehicle theVehicle, int door )</syntaxhighlight>
{{OOP||[[vehicle]]:getDoorState||setVehicleDoorState}}


==Required Arguments==
==Required Arguments==
*'''theVehicle:''' The vehicle you want to get the door status of.
*'''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:
*'''door:''' a whole number representing which door to get the status of. Valid values are:
** '''0:''' Hood
** '''0:''' Hood
** '''1:''' Trunk
** '''1:''' Trunk
Line 18: Line 19:
==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




==Example==
==Example==
<syntaxhighlight lang="lua">local newcar = createVehicle ( 520, 1024, 1024, 1024 )
This example implements a doesVehicleHaveDoorOpen() function, that returns true if any of the doors on a vehicle are open.
local state = getVehicleDoorState ( newcar, 2 )
<syntaxhighlight lang="lua">function doesVehicleHaveDoorOpen(vehicle)
outputChatBox ( "The 3rd door state on this car: " .. state )</syntaxhighlight>
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</syntaxhighlight>


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

Latest revision as of 19:47, 14 July 2017

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

Syntax

int getVehicleDoorState ( vehicle theVehicle, int door )

OOP Syntax Help! I don't understand this!

Method: vehicle:getDoorState(...)
Counterpart: setVehicleDoorState


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=51651"