GetVehicleVariant - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:35:48Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:35, 7 November 2024
Line 31:		Line 31:

	</section>		</section>
	~~==Requirements==~~
	~~{{Requirements\|1.2.0\|1.2.0}}~~

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

Lvrent at 12:43, 19 September 2021

2021-09-19T12:43:56Z

← Older revision		Revision as of 12:43, 19 September 2021
Line 1:		Line 1:
	{{~~Server client~~ function}}		{{Shared function}}
	__NOTOC__		__NOTOC__
	This function gets the variant of a specified vehicle. In GTA SA some vehicles are different for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default ~~GTA SA~~ variant list see: [[Vehicle variants]]		This function gets the variant of a specified vehicle. In GTA: San Andreas some vehicles are different; for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default variant list see: [[Vehicle variants]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int, int getVehicleVariant ( vehicle theVehicle )</syntaxhighlight>		<syntaxhighlight lang="lua">int, int getVehicleVariant ( vehicle theVehicle )</syntaxhighlight>
	{{OOP\|\|[[vehicle]]:getVariant\|\|setVehicleVariant}}		{{OOP\|\|[[vehicle]]:getVariant\|\|setVehicleVariant}}
	==Required Arguments==
	*'''theVehicle:''' ~~A handle to the~~ [[vehicle]] that you want to get the variant of.		===Required Arguments===
			*'''theVehicle:''' The [[vehicle]] that you want to get the variant of.

	==Returns==		==Returns==
	~~On success:~~		Returns 2 [[int]] containing the vehicle variants, ''false'' otherwise (the specified vehicle doesn't exist).
	* '''int''': An integer for the first vehicle variant see [[~~Vehicle variants~~]]
	* '''int''': An integer for the ~~second~~ vehicle ~~variant see [[Vehicle~~ variants]]
	~~On failure:~~
	* '''~~bool~~'''~~: False because~~ the specified vehicle ~~didn~~'t exist

	==Example==		==Example==
	<section name="Client" class="client" show="true">		<section name="Client example" class="client" show="true">
	This example tells the ~~person~~ in the vehicle what their vehicle variants are ~~using~~: ~~getvehvar~~		This example tells the [[player]] in the [[vehicle]] what their vehicle variants are with a command named ''getvehvar'':
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~getMyVehiclesVariant~~()		function getMyVehicleVariants()
	local myVeh = getPedOccupiedVehicle(localPlayer) -- Get the vehicle that ~~they're~~ in		local myVeh = getPedOccupiedVehicle(localPlayer) -- Get the vehicle that the player is in
	if (myVeh) then
	local ~~var1~~, ~~var2~~ = getVehicleVariant(myVeh) -- Get the ~~info~~		if myVeh then
	outputChatBox("This ~~vehicles~~ variants: "..tostring(~~var1~~).." "..tostring(~~var2~~)) -- Output the info		local variant1, variant2 = getVehicleVariant (myVeh) -- Get the vehicle variants

			outputChatBox ("This vehicle's variants are: "..tostring (variant1).." "..tostring (variant2)) -- Output the info to chatbox
	end		end
	end		end
	addCommandHandler("getvehvar", ~~getMyVehiclesVariant~~)
			addCommandHandler ("getvehvar", getMyVehicleVariants)
	</syntaxhighlight>		</syntaxhighlight>

	</section>		</section>
	==Requirements==		==Requirements==
	{{Requirements\|1.2\|1.2}}		{{Requirements\|1.2.0\|1.2.0}}

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

Strix at 22:16, 18 December 2014

2014-12-18T22:16:29Z

← Older revision		Revision as of 22:16, 18 December 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int, int getVehicleVariant ( vehicle theVehicle )</syntaxhighlight>		<syntaxhighlight lang="lua">int, int getVehicleVariant ( vehicle theVehicle )</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getVariant\|\|setVehicleVariant}}
	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you want to get the variant of.		*'''theVehicle:''' A handle to the [[vehicle]] that you want to get the variant of.

Tren GT at 09:49, 6 August 2012

2012-08-06T09:49:29Z

← Older revision		Revision as of 09:49, 6 August 2012
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	~~{{New feature/item\|3.0120\|1.2\|\|~~
	~~Only available in MTA:SA v1.2 and onwards.~~
	}}
	This function gets the variant of a specified vehicle. In GTA SA some vehicles are different for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default GTA SA variant list see: [[Vehicle variants]]		This function gets the variant of a specified vehicle. In GTA SA some vehicles are different for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default GTA SA variant list see: [[Vehicle variants]]

Ccw at 22:17, 6 December 2011

2011-12-06T22:17:40Z

← Older revision		Revision as of 22:17, 6 December 2011
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
			==Requirements==
			{{Requirements\|1.2\|1.2}}
	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}

OpenIDUser32 at 06:44, 21 November 2011

2011-11-21T06:44:20Z

← Older revision		Revision as of 06:44, 21 November 2011
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	{{New feature\|3.0120\|1.2\|		{{New feature/item\|3.0120\|1.2\|\|
	Only available in MTA:SA v1.2 and onwards.		Only available in MTA:SA v1.2 and onwards.
	}}		}}

Arran Fortuna at 23:33, 16 November 2011

2011-11-16T23:33:18Z

← Older revision		Revision as of 23:33, 16 November 2011
Line 4:		Line 4:
	Only available in MTA:SA v1.2 and onwards.		Only available in MTA:SA v1.2 and onwards.
	}}		}}
	~~Page in~~ the ~~making~~.		This function gets the variant of a specified vehicle. In GTA SA some vehicles are different for example the labelling on trucks or the contents of a pick-up truck and the varying types of a motor bike. For the default GTA SA variant list see: [[Vehicle variants]]

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int ~~getVehicleLightState~~ ( vehicle theVehicle~~, int light~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">int, int getVehicleVariant ( vehicle theVehicle )</syntaxhighlight>

	==Required Arguments==		==Required Arguments==
	*'''theVehicle:''' A handle to the [[vehicle]] that you ~~wish~~ to ~~know~~ the ~~light state~~ of.		*'''theVehicle:''' A handle to the [[vehicle]] that you want to get the variant of.
	*'''light:''' A whole number between 0 and 3

	==Returns==		==Returns==
	~~Returns 0 (working) or 1 (broken)~~		On success:
			* '''int''': An integer for the first vehicle variant see [[Vehicle variants]]
			* '''int''': An integer for the second vehicle variant see [[Vehicle variants]]
			On failure:
			* '''bool''': False because the specified vehicle didn't exist

	==Example==		==Example==
	<syntaxhighlight lang="lua">~~newcar~~ = ~~createVehicle~~ ( ~~520, 1024, 1024, 1024~~ )		<section name="Client" class="client" show="true">
	~~state~~ = ~~getVehicleLightState~~ ( ~~newcar, 0~~ )		This example tells the person in the vehicle what their vehicle variants are using: getvehvar
	outputChatBox ( "~~The front-left light state on this car~~: " .. ~~state~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">
			function getMyVehiclesVariant()
			local myVeh = getPedOccupiedVehicle(localPlayer) -- Get the vehicle that they're in
			if (myVeh) then
			local var1, var2 = getVehicleVariant(myVeh) -- Get the info
			outputChatBox("This vehicles variants: "..tostring(var1).." "..tostring(var2)) -- Output the info
			end
			end
			addCommandHandler("getvehvar", getMyVehiclesVariant)
			</syntaxhighlight>
			</section>

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

Arran Fortuna at 23:19, 16 November 2011

2011-11-16T23:19:29Z

← Older revision		Revision as of 23:19, 16 November 2011
Line 1:		Line 1:
	{{Server client function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
			{{New feature\|3.0120\|1.2\|
			Only available in MTA:SA v1.2 and onwards.
			}}
	Page in the making.		Page in the making.

Arran Fortuna: Created page with "{{Server client function}} NOTOC Page in the making. ==Syntax== int getVehicleLightState ( vehicle theVehicle, int light ) ==Required Arguments== *'''th..."

2011-11-16T23:10:30Z

Created page with "{{Server client function}} __NOTOC__ Page in the making. ==Syntax== <syntaxhighlight lang="lua">int getVehicleLightState ( vehicle theVehicle, int light )</syntaxhighlight> ==Required Arguments== *'''th..."

New page

{{Server client function}}
__NOTOC__
Page in the making.

==Syntax==
<syntaxhighlight lang="lua">int getVehicleLightState ( vehicle theVehicle, int light )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the light state of.
*'''light:''' A whole number between 0 and 3

==Returns==
Returns 0 (working) or 1 (broken)

==Example==
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
state = getVehicleLightState ( newcar, 0 )
outputChatBox ( "The front-left light state on this car: " .. state )</syntaxhighlight>

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