AddVehicleSirens: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(18 intermediate revisions by 12 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
{{New feature/item|4.0140|1.4|3966|
{{New feature/item|3.0130|1.3.0|3968|
This function adds sirens to a vehicle.
This function adds sirens to a vehicle.
}}
}}
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType, [bool 360flag = false, bool checkLosFlag = true, bool useRandomiser flag = true, bool silentFlag = false )
bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType [, bool flag360 = false, bool checkLosFlag = true, bool useRandomiser = true, bool silentFlag = false ] )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:addSirens}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The vehicle to add sirens
*'''theVehicle:''' The vehicle to add sirens
*'''sirenCount:''' The amount of siren points on the vehicle
*'''sirenCount:''' The amount of siren points on the vehicle (8 maximum)
*'''sirenType:''' An integer between 1 and 6 (1: invisible, 2: single, 3+: dual)
*'''sirenType:''' An integer between 1 and 6 (1: invisible, 2: single, 3+: dual)


===Optional Arguments===
===Optional Arguments===
*'''360flag:''' Visible from all directions (applies to single type only)
*'''flag360:''' Visible from all directions (applies to single type only)
*'''checkLosFlag:''' Check line of sight between camera and light so it won't draw if blocked
*'''checkLosFlag:''' Check line of sight between camera and light so it won't draw if blocked
*'''useRandomiser:''' Randomise the light order, false for sequential
*'''useRandomiser:''' Randomise the light order, false for sequential
Line 22: Line 22:


===Returns===
===Returns===
Returns ''true'' if sirens were successfully added to the vehicle, ''false'' otherwise.  
Returns ''true'' if sirens were successfully added to the vehicle, ''false'' otherwise.


==Example==
==Example==
{{Example}}
<section name="Server" class="server" show="true">
This example adds a siren for the vehicle, then sets two custom sirens at the top of the vehicle. And then removes the siren when getting out the vehicle.
<syntaxhighlight lang="lua">
addEventHandler('onPlayerVehicleEnter', root, function(vehicle, seat)
  if (seat == 0) then
      addVehicleSirens(vehicle, 2, 2)
      setVehicleSirens(vehicle, 1, -0.3, 0, 0.8, 0, 0, 255, 255, 255)
      setVehicleSirens(vehicle, 2, 0.3, 0, 0.8, 255, 0, 0, 255, 255)
      -- You can also make the sirens flash immediately with 'setVehicleSirensOn(vehicle, true)'
  end
end)


==Requirements==
addEventHandler('onPlayerVehicleExit', root, function(vehicle, seat)
{{Requirements|1.4-3966|n/a|}}
  removeVehicleSirens(vehicle)
end)
</syntaxhighlight>
</section>


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

Latest revision as of 17:03, 7 November 2024

This function adds sirens to a vehicle.

Syntax

bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType [, bool flag360 = false, bool checkLosFlag = true, bool useRandomiser = true, bool silentFlag = false ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:addSirens(...)


Required Arguments

  • theVehicle: The vehicle to add sirens
  • sirenCount: The amount of siren points on the vehicle (8 maximum)
  • sirenType: An integer between 1 and 6 (1: invisible, 2: single, 3+: dual)

Optional Arguments

  • flag360: Visible from all directions (applies to single type only)
  • checkLosFlag: Check line of sight between camera and light so it won't draw if blocked
  • useRandomiser: Randomise the light order, false for sequential
  • silentFlag: If you want the siren to be silent set this to true

Returns

Returns true if sirens were successfully added to the vehicle, false otherwise.

Example

Click to collapse [-]
Server

This example adds a siren for the vehicle, then sets two custom sirens at the top of the vehicle. And then removes the siren when getting out the vehicle. 

addEventHandler('onPlayerVehicleEnter', root, function(vehicle, seat)
   if (seat == 0) then
      addVehicleSirens(vehicle, 2, 2)
      setVehicleSirens(vehicle, 1, -0.3, 0, 0.8, 0, 0, 255, 255, 255)
      setVehicleSirens(vehicle, 2, 0.3, 0, 0.8, 255, 0, 0, 255, 255)
      -- You can also make the sirens flash immediately with 'setVehicleSirensOn(vehicle, true)'
   end
end)

addEventHandler('onPlayerVehicleExit', root, function(vehicle, seat)
   removeVehicleSirens(vehicle)
end)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AddVehicleSirens?oldid=81107"