GetVehicleSirenParams: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Example: To example maker: Try to figure out why an example would return nil before actually posting it. A faulty example is as good as no example at all.)
(→‎Returns: Hopefully cleared up the return table for this function)
Line 17: Line 17:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
sirenParams = { sirenCount, sirenType, { is360, doLOSCheck, useRandomiser, silent } }
[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
</syntaxhighlight>
</syntaxhighlight>


Revision as of 14:38, 3 May 2012

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

This template will be deleted.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleSirenParams?oldid=30267"