GetVehicleSirenParams

From Multi Theft Auto: Wiki
Revision as of 14:38, 3 May 2012 by Snert (talk | contribs) (→‎Returns: Hopefully cleared up the return table for this function)
Jump to navigation Jump to search

ADDED/UPDATED IN VERSION 1.4 r3966:

This function get the parameters of a vehicles siren.

Syntax

table getVehicleSirenParams ( vehicle theVehicle )

Required Arguments

  • theVehicle: The vehicle to get the siren parameters of

Returns

Returns a table with the siren count, siren type and a sub table for the four flags. False otherwise.

[int]   SirenParams.SirenCount
[int]   SirenParams.SirenType
[table] SirenParams.Flags
 [bool] SirenParams.Flags["360"]
 [bool] SirenParams.Flags.DoLOSCheck
 [bool] SirenParams.Flags.UseRandomiser
 [bool] SirenParams.Flags.Silent

Example

Click to collapse [-]
Server

This example returns the vehicle parameters when the players presses g.

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 sirenParams = getVehicleSirenParams(vehicle)
   outputChatBox("Here's the parameters of your vehicle sirens: Siren Points: "..tostring(sirenParams.SirenCount)..", Type of Siren: "..tostring(sirenParams.SirenType)..".",player)
end
 
addEventHandler("onVehicleExit",root,function(player,seat)
   if(player)and(seat==0)then
      removeVehicleSirens(source)
      unbindKey(player,"g","up",getSiren)
   end
end)

Requirements

Minimum server version 1.4-3966
Minimum client version 1.4-3966

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.4-3966" client="1.4-3966" />

See Also