GetVehicleSirens - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:03:38Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:03, 7 November 2024
Line 57:		Line 57:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~==Requirements==~~
	~~{{Requirements\|1.3.0-9.03968\|1.3.0-9.03968\|}}~~

	==See Also==		==See Also==
	{{Vehicle_functions}}		{{Vehicle_functions}}

AlexTMjugador: Grammar fixes

2015-08-06T10:35:31Z

Grammar fixes

← Older revision		Revision as of 10:35, 6 August 2015
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	{{New feature/item\|3.0130\|1.3.0\|3968\|		{{New feature/item\|3.0130\|1.3.0\|3968\|
	This function ~~get~~ the properties of a ~~vehicles~~ sirens.		This function gets the properties of a vehicle's sirens.
	}}		}}

Line 11:		Line 11:
	{{OOP\|\|[[vehicle]]:getSirens\|sirens\|setVehicleSirens}}		{{OOP\|\|[[vehicle]]:getSirens\|sirens\|setVehicleSirens}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The vehicle to get siren information on		*'''theVehicle:''' The vehicle to get siren information of.

	===Returns===		===Returns===
	If the vehicle ~~its~~ invalid, it returns ''false''. Otherwise, returns a ''table'' with sub tables containing the properties of each siren point in the following manner:		If the vehicle is invalid, it returns ''false''. Otherwise, returns a ''table'' with sub tables containing the properties of each siren point in the following manner:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

AlexTMjugador: Typo fix

2015-08-06T10:33:27Z

Typo fix

← Older revision		Revision as of 10:33, 6 August 2015
Line 45:		Line 45:
	outputChatBox("RGB siren colour: " .. sirenData[1].Red .. ", " .. sirenData[1].Green .. ", " .. sirenData[1].Blue .. ".", player)		outputChatBox("RGB siren colour: " .. sirenData[1].Red .. ", " .. sirenData[1].Green .. ", " .. sirenData[1].Blue .. ".", player)
	outputChatBox("Maximum alpha (during bad visibility conditions): " .. sirenData[1].Alpha .. ", minimum alpha (during good visibility conditions): " .. sirenData[1].Min_Alpha .. ".", player)		outputChatBox("Maximum alpha (during bad visibility conditions): " .. sirenData[1].Alpha .. ", minimum alpha (during good visibility conditions): " .. sirenData[1].Min_Alpha .. ".", player)
	outputChatBox("Siren light position: " .. sirenData[1).x .. ", " .. sirenData[1].y .. ", " .. sirenData[1].z .. ".", player)		outputChatBox("Siren light position: " .. sirenData[1].x .. ", " .. sirenData[1].y .. ", " .. sirenData[1].z .. ".", player)
	end		end

AlexTMjugador: Minor textual fix at /* Example */

2015-08-06T10:31:10Z

Minor textual fix at Example

← Older revision		Revision as of 10:31, 6 August 2015
Line 29:		Line 29:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example returns the siren properties when the player presses G.		This example returns the siren properties when the player presses Z.
	<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter", root, function(player, seat)		<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter", root, function(player, seat)
	if seat == 0 then -- If a player starts driving a vehicle...		if seat == 0 then -- If a player starts driving a vehicle...

AlexTMjugador: Fixed /* Example */ and improved its readability

2015-08-06T10:29:36Z

Fixed Example: and improved its readability

← Older revision		Revision as of 10:29, 6 August 2015
Line 29:		Line 29:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example returns the siren properties when the player presses g. ~~(Returns nil for some reason)~~		This example returns the siren properties when the player presses G.
	<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter",root,function(player,seat)		<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter", root, function(player, seat)
	if~~(player)and(~~seat==0)then		if seat == 0 then -- If a player starts driving a vehicle...
	addVehicleSirens(source,1,1)		-- ... customize the vehicle sirens and bind a key to ouput info about them to the driver
	setVehicleSirens(source,1,0,0,0,100,0,100,255,122)		addVehicleSirens(source, 1, 1)
	bindKey(player,"g","up",~~getSiren~~,source)		setVehicleSirens(source, 1, 0, 0, 0, 100, 0, 100, 255, 122)
			bindKey(player, "z", "up", outputSirenInfoToPlayer, source)
	end		end
	end)		end)

	function ~~getSiren~~(player,~~button~~,~~state~~,vehicle)		function outputSirenInfoToPlayer(player, _, _, vehicle)
			-- Get vehicle's siren data and output it to the player in the chatbox
	local sirenData = getVehicleSirens(vehicle)		local sirenData = getVehicleSirens(vehicle)
	outputChatBox("~~Here's~~ the properties of your vehicle ~~sirens~~: ~~Red~~,~~Green~~,~~Blue~~: "..~~tostring(~~sirenData[1]~~[0])~~..","..~~tostring(~~sirenData[1][1])..","..~~tostring(~~sirenData[1]~~[2])~~..", ~~X,Y,Z~~: "..~~tostring(~~sirenData[1]~~[3])~~..","..~~tostring(~~sirenData[1~~][4]~~)..","..~~tostring(~~sirenData[1]~~[5])~~..", ~~minAlpha:~~ "..~~tostring(~~sirenData[1]~~[6])~~..".",player)		outputChatBox("These are the properties of your vehicle's siren:", player, 0, 255, 0)
			outputChatBox("RGB siren colour: " .. sirenData[1].Red .. ", " .. sirenData[1].Green .. ", " .. sirenData[1].Blue .. ".", player)
			outputChatBox("Maximum alpha (during bad visibility conditions): " .. sirenData[1].Alpha .. ", minimum alpha (during good visibility conditions): " .. sirenData[1].Min_Alpha .. ".", player)
			outputChatBox("Siren light position: " .. sirenData[1).x .. ", " .. sirenData[1].y .. ", " .. sirenData[1].z .. ".", player)
	end		end

	addEventHandler("~~onVehicleExit~~",root,function(player,seat)		addEventHandler("onVehicleStartExit", root, function(player, seat)
	if~~(player)and(~~seat==0)then		if seat == 0 then -- If a player stops driving a vehicle...
			-- ... remove vehicle's sirens and unbind the key
	removeVehicleSirens(source)		removeVehicleSirens(source)
	unbindKey(player,"g","up",~~getSiren~~)		unbindKey(player, "z", "up", outputSirenInfoToPlayer)
	end		end
	end)		end)

AlexTMjugador: Forgot one little detail

2015-07-30T18:21:19Z

Forgot one little detail

← Older revision		Revision as of 18:21, 30 July 2015
Line 14:		Line 14:

	===Returns===		===Returns===
	~~Returns~~ a ''table'' with sub tables containing the properties of each siren point in the following manner:		If the vehicle its invalid, it returns ''false''. Otherwise, returns a ''table'' with sub tables containing the properties of each siren point in the following manner:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

AlexTMjugador at 18:20, 30 July 2015

2015-07-30T18:20:03Z

← Older revision		Revision as of 18:20, 30 July 2015
Line 20:		Line 20:
	[float] SirenData[sirenPoint].y		[float] SirenData[sirenPoint].y
	[float] SirenData[sirenPoint].z		[float] SirenData[sirenPoint].z
	[int] SirenData[sirenPoint].Red		[int] SirenData[sirenPoint].Red
	[int] SirenData[sirenPoint].Green		[int] SirenData[sirenPoint].Green
	[int] SirenData[sirenPoint].Blue		[int] SirenData[sirenPoint].Blue
	[int] SirenData[sirenPoint].Alpha		[int] SirenData[sirenPoint].Alpha
	[int] SirenData[sirenPoint].Min_Alpha		[int] SirenData[sirenPoint].Min_Alpha
	</syntaxhighlight>		</syntaxhighlight>

AlexTMjugador: Corrected some big mistakes at /* Returns */

2015-07-30T18:19:39Z

Corrected some big mistakes at Returns

← Older revision		Revision as of 18:19, 30 July 2015
Line 14:		Line 14:

	===Returns===		===Returns===
	Returns a ''table'' with sub tables containing the properties of ~~the~~ siren point in the following ~~order:~~		Returns a ''table'' with sub tables containing the properties of each siren point in the following manner:

	~~Red, Green, Blue, Alpha, x, y, z, minAlpha or returns false on failure. Example~~:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~sirenData = {~~		[float] SirenData[sirenPoint].x
	[1] ~~= { Red, Green, Blue, Alpha, x,~~ y, z~~, minAlpha },~~		[float] SirenData[sirenPoint].y
	[2] ~~= {~~ Red, Green~~, Blue, Alpha, x, y, z, minAlpha },~~		[float] SirenData[sirenPoint].z
	[3] ~~= { Red, Green,~~ Blue~~, Alpha, x, y, z, minAlpha },~~		[int] SirenData[sirenPoint].Red
	[4] ~~= { Red, Green, Blue,~~ Alpha~~, x, y, z, minAlpha },~~		[int] SirenData[sirenPoint].Green
	}		[int] SirenData[sirenPoint].Blue
			[int] SirenData[sirenPoint].Alpha
			[int] SirenData[sirenPoint].Min_Alpha
	</syntaxhighlight>		</syntaxhighlight>

Strix at 23:59, 17 December 2014

2014-12-17T23:59:18Z

← Older revision		Revision as of 23:59, 17 December 2014
Line 9:		Line 9:
	table getVehicleSirens ( vehicle theVehicle )		table getVehicleSirens ( vehicle theVehicle )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[vehicle]]:getSirens\|sirens}}		{{OOP\|\|[[vehicle]]:getSirens\|sirens\|setVehicleSirens}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The vehicle to get siren information on		*'''theVehicle:''' The vehicle to get siren information on

Strix: OOP

2014-12-17T23:55:22Z

OOP

← Older revision		Revision as of 23:55, 17 December 2014
Line 9:		Line 9:
	table getVehicleSirens ( vehicle theVehicle )		table getVehicleSirens ( vehicle theVehicle )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getSirens\|sirens}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle:''' The vehicle to get siren information on		*'''theVehicle:''' The vehicle to get siren information on