GetVehicleSirens: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Corrected some big mistakes at →‎Returns)
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>



Revision as of 18:19, 30 July 2015

This function get the properties of a vehicles sirens.

Syntax

table getVehicleSirens ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getSirens(...)
Variable: .sirens
Counterpart: setVehicleSirens


Required Arguments

  • theVehicle: The vehicle to get siren information on

Returns

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

[float]   SirenData[sirenPoint].x
[float]   SirenData[sirenPoint].y
[float]   SirenData[sirenPoint].z
[int]   SirenData[sirenPoint].Red
[int]   SirenData[sirenPoint].Green
[int]   SirenData[sirenPoint].Blue
[int]   SirenData[sirenPoint].Alpha
[int]   SirenData[sirenPoint].Min_Alpha

Example

Click to collapse [-]
Server

This example returns the siren properties when the player presses g. (Returns nil for some reason)

addEventHandler("onVehicleEnter",root,function(player,seat)
   if(player)and(seat==0)then
      addVehicleSirens(source,1,1)
      setVehicleSirens(source,1,0,0,0,100,0,100,255,122)
      bindKey(player,"g","up",getSiren,source)
   end
end)

function getSiren(player,button,state,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)
end

addEventHandler("onVehicleExit",root,function(player,seat)
   if(player)and(seat==0)then
      removeVehicleSirens(source)
      unbindKey(player,"g","up",getSiren)
   end
end)

Requirements

This template will be deleted.

See Also