GetVehicleSirenParams: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{New feature/item|4.0120|1.4|3966|
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{New feature/item|3.0130|1.3.0|3968|
This function get the parameters of a vehicles siren.
This function get the parameters of a vehicles siren.
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
getVehicleSirenParams ( vehicle theVehicle )
table getVehicleSirenParams ( vehicle theVehicle )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[vehicle]]:getSirenParams|sirenParams}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The vehicle to get the siren parameters of
*'''theVehicle:''' The vehicle to get the siren parameters of
Line 16: 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>


==Example==
==Example==
{{Example}}
<section name="Server" class="server" show="true">
}}
This example returns the vehicle parameters when the players presses g.
 
<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter",root,function(player,seat)
==Requirements==
  if(player)and(seat==0)then
{{Requirements|1.4-3966|1.4-3966|}}
      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)
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle_functions}}
{{Vehicle_functions}}
[[Category:Needs_Example]]

Latest revision as of 17:03, 7 November 2024

This function get the parameters of a vehicles siren.

Syntax

table getVehicleSirenParams ( vehicle theVehicle )

OOP Syntax Help! I don't understand this!

Method: vehicle:getSirenParams(...)
Variable: .sirenParams


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)

See Also


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