SetVehicleDoorState - Revision history

LordHenry: /* Example */

2022-10-04T17:38:27Z

Example

← Older revision		Revision as of 17:38, 4 October 2022
Line 40:		Line 40:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- create a new vehicle		-- create a new vehicle
	local newcar = createVehicle ( ~~520~~, ~~1024~~, ~~1024~~, ~~1024~~ )		local newcar = createVehicle (420, 2472.5, -1688, 13.3)
	-- break its front left door off		-- break its front left door off
	~~state =~~ setVehicleDoorState ( newcar, 2, 4 )		setVehicleDoorState (newcar, 2, 4)
			-- make its hood disapear
			setTimer (setVehicleDoorState, 100, 1, newcar, 0, 4, false)
	</syntaxhighlight>		</syntaxhighlight>

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

LordHenry: /* Optional Arguments */

2022-10-04T17:30:38Z

Optional Arguments

← Older revision		Revision as of 17:30, 4 October 2022
Line 30:		Line 30:
	{{OptionalArg}}		{{OptionalArg}}
	{{New feature/item\|9.0158\|1.5.8\|20319\|		{{New feature/item\|9.0158\|1.5.8\|20319\|
			{{Note\|This parameter doesn't work during the vehicle creation. You need a [[SetTimer]] if you need to create the vehicle using this parameter.}}
	*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.		*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.
	}}		}}

Woovie: /* Required Arguments */

2020-10-10T21:07:55Z

Required Arguments

← Older revision		Revision as of 21:07, 10 October 2020
Line 29:		Line 29:
	===Optional Arguments===		===Optional Arguments===
	{{OptionalArg}}		{{OptionalArg}}
	{{New feature/item\|9.~~0160~~\|1.6.0\|20319\|		{{New feature/item\|9.0158\|1.5.8\|20319\|
	*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.		*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.
	}}		}}

Woovie: /* Syntax */

2020-10-10T21:07:16Z

Syntax

← Older revision		Revision as of 21:07, 10 October 2020
Line 7:		Line 7:
	{{OOP\|\|[[vehicle]]:setDoorState\|\|getVehicleDoorState}}		{{OOP\|\|[[vehicle]]:setDoorState\|\|getVehicleDoorState}}

	{{New feature/item\|9.~~0160~~\|1.6.0\|20319\|		{{New feature/item\|9.0158\|1.5.8\|20319\|
	<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )</syntaxhighlight>
	}}		}}

Botder at 01:15, 15 October 2019

2019-10-15T01:15:18Z

← Older revision		Revision as of 01:15, 15 October 2019
Line 30:		Line 30:
	{{OptionalArg}}		{{OptionalArg}}
	{{New feature/item\|9.0160\|1.6.0\|20319\|		{{New feature/item\|9.0160\|1.6.0\|20319\|
	*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component ~~and~~ <nowiki>state == 4</nowiki>.		*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component with <nowiki>state == 4</nowiki>.
	}}		}}

Botder: Add spawnFlyingComponent

2019-10-14T14:23:56Z

Add spawnFlyingComponent

← Older revision		Revision as of 14:23, 14 October 2019
Line 6:		Line 6:
	<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>		<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
	{{OOP\|\|[[vehicle]]:setDoorState\|\|getVehicleDoorState}}		{{OOP\|\|[[vehicle]]:setDoorState\|\|getVehicleDoorState}}

			{{New feature/item\|9.0160\|1.6.0\|20319\|
			<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state [, bool spawnFlyingComponent = true ] )</syntaxhighlight>
			}}

	==Required Arguments==		==Required Arguments==
Line 22:		Line 26:
	**'''3:''' Ajar, damaged (aka Slightly open, damaged)		**'''3:''' Ajar, damaged (aka Slightly open, damaged)
	**'''4:''' Missing		**'''4:''' Missing

			===Optional Arguments===
			{{OptionalArg}}
			{{New feature/item\|9.0160\|1.6.0\|20319\|
			*'''spawnFlyingComponent:''' A boolean, if set to true, spawns flying doors etc. if you remove a component and <nowiki>state == 4</nowiki>.
			}}

	==Returns==		==Returns==

Jayceon: /* Required Arguments */

2019-01-29T13:01:35Z

Required Arguments

← Older revision		Revision as of 13:01, 29 January 2019
Line 17:		Line 17:
	**'''5:''' Rear right		**'''5:''' Rear right
	*'''state:''' An integer representing the state to set the door to. Valid values are:		*'''state:''' An integer representing the state to set the door to. Valid values are:
	**'''0:''' Shut, intact		**'''0:''' Shut, intact (aka Closed, undamaged)
	**'''1:''' Ajar, intact		**'''1:''' Ajar, intact (aka Slightly open, undamaged)
	**'''2:''' Shut, damaged		**'''2:''' Shut, damaged (aka Closed, damaged)
	**'''3:''' Ajar, damaged		**'''3:''' Ajar, damaged (aka Slightly open, damaged)
	**'''4:''' Missing		**'''4:''' Missing

Skully: Added OOP syntax.

2018-04-06T22:21:19Z

Added OOP syntax.

← Older revision		Revision as of 22:21, 6 April 2018
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">bool setVehicleDoorState ( vehicle theVehicle, int door, int state )</syntaxhighlight>
	bool setVehicleDoorState ( vehicle theVehicle, int door, int state )		{{OOP\|\|[[vehicle]]:setDoorState\|\|getVehicleDoorState}}
	</syntaxhighlight>

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

John: Clarified some things.

2011-12-24T05:25:57Z

Clarified some things.

← Older revision		Revision as of 05:25, 24 December 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function sets the ~~damage~~ state of a specified door on a vehicle.		This function sets the state of the specified door on a vehicle.

	==Syntax==		==Syntax==
Line 10:		Line 10:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' The [[vehicle]] that you wish to change the door state of.		*'''theVehicle:''' The [[vehicle]] that you wish to change 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:''' An integer representing which door to set the state of. Valid values are:
	*'''state:''' An integer ~~determining~~ the ~~new~~ state of the door:		**'''0:''' Hood
	**'''0:''' intact		**'''1:''' Trunk
	**'''1:''' ~~swinging free~~		**'''2:''' Front left
	**'''2:''' ~~bashed~~		**'''3:''' Front right
	**'''3:''' ~~bashed and swinging free~~		**'''4:''' Rear left
	**'''4:''' ~~missing~~		**'''5:''' Rear right
			*'''state:''' An integer representing the state to set the door to. Valid values are:
			**'''0:''' Shut, intact
			**'''1:''' Ajar, intact
			**'''2:''' Shut, damaged
			**'''3:''' Ajar, damaged
			**'''4:''' Missing

	==Returns==		==Returns==
	Returns ''true'' if the door state was successfully set, ''false'' ~~if invalid arguments, invalid door IDs or invalid state IDs are passed~~.		Returns ''true'' if the door state was successfully set, ''false'' otherwise.

	==Example==		==Example==

Will: /* Required Arguments */

2011-09-09T12:05:01Z

Required Arguments

← Older revision		Revision as of 12:05, 9 September 2011
Line 10:		Line 10:
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' The [[vehicle]] that you wish to change the door state of.		*'''theVehicle:''' The [[vehicle]] that you wish to change the door state of.
	*'''door:''' ~~An integer between~~ 0 ~~and~~ 5 ~~specifying the door you want to change state of.~~		*'''door:''' A whole number, 0 (hood), 1 (trunk), 2 (front left), 3 (front right), 4 (rear left), 5 (rear right)
	*'''state:''' An integer determining the new state of the door:		*'''state:''' An integer determining the new state of the door:
	**'''0:''' intact		**'''0:''' intact