GetVehicleDoorState - Revision history

Pirulax: /* Syntax */

2017-07-14T19:47:18Z

Syntax

← Older revision		Revision as of 19:47, 14 July 2017
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}}		{{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.

2014-12-17T23:39:55Z

← Older revision		Revision as of 23:39, 17 December 2014
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]]:~~getCompatibleUpgrades~~}}		{{OOP\|\|[[vehicle]]:getDoorState}}
	==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.

2014-10-13T15:58:08Z

OOP

← Older revision		Revision as of 15:58, 13 October 2014
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]]:getCompatibleUpgrades}}
	==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

2011-12-24T05:28:21Z

Changed the wording.

← Older revision		Revision as of 05:28, 24 December 2011
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

2011-12-24T04:01:17Z

Added an example.

← Older revision		Revision as of 04:01, 24 December 2011
Line 26:		Line 26:

	==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}}

2011-12-24T03:40:02Z

Made the argument and return sections clearer.

← Older revision		Revision as of 03:40, 24 December 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function returns the current state of a specifed door on the vehicle.		This function returns the current state of the specifed door on the vehicle.

	==Syntax==		==Syntax==
Line 7:		Line 7:

	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' ~~A handle to the [[~~vehicle~~]] that~~ you ~~wish~~ to ~~know~~ the door ~~state~~ of.		*'''theVehicle:''' The vehicle you want to get the door status of.
	*'''door:''' A whole number, 0 ~~(hood),~~ 1 ~~(trunk),~~ 2 ~~(front~~ left), 3 ~~(front~~ right), 4 ~~(rear~~ left), 5 ~~(rear~~ right)		*'''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==		==Returns==
	~~Returns 4 [[int]]s indicating the states~~ of the ~~door. These values can~~ be:		If successful, one of the following integers will be returned:
	* '''0:''' Shut (Undamaged)		* '''0:''' Shut (Undamaged) (also returned if no such door exists on the vehicle)
	* '''1:''' Open (Undamaged)		* '''1:''' Open (Undamaged)
	* '''2:''' Shut (Damaged)		* '''2:''' Shut (Damaged)
	* '''3:''' Open (Damaged)		* '''3:''' Open (Damaged)
	* '''4:''' Fallen off		* '''4:''' Fallen off


	==Example==		==Example==

2007-08-26T17:14:13Z

← Older revision		Revision as of 17:14, 26 August 2007
Line 8:		Line 8:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.
	*'''~~Door~~:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)		*'''door:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)

	==Returns==		==Returns==

2007-08-15T14:03:05Z

Required Arguments

← Older revision		Revision as of 14:03, 15 August 2007
Line 8:		Line 8:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.
	*'''Door:''' A whole number, 0 (hood), 1 (~~boot~~), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)		*'''Door:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)

	==Returns==		==Returns==

2007-08-13T16:09:51Z

Syntax

← Older revision		Revision as of 16:09, 13 August 2007
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int getVehicleDoorState ( theVehicle, door )</syntaxhighlight>		<syntaxhighlight lang="lua">int getVehicleDoorState ( vehicle theVehicle, int door )</syntaxhighlight>

	==Required Arguments==		==Required Arguments==

2007-08-11T11:08:31Z

Required Arguments

← Older revision		Revision as of 11:08, 11 August 2007
Line 8:		Line 8:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.		*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the door state of.
	*'''Door:''' A whole number ~~between 0 and 5. (~~ 0 (hood), 1 (boot), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right) )		*'''Door:''' A whole number, 0 (hood), 1 (boot), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)

	==Returns==		==Returns==