AddVehicleSirens: Difference between revisions

Latest revision as of 10:54, 11 October 2021

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)

Requirements

Minimum server version	1.3.0-9.03968
Minimum client version	n/a

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.3.0-9.03968" />

@@ Line 1: / Line 1: @@
-{{New feature/item|3.0120|1.4|3964|
 __NOTOC__
 {{Server function}}
+{{New feature/item|3.0130|1.3.0|3968|
 This function adds sirens to a vehicle.
+}}
 ==Syntax==
 <syntaxhighlight lang="lua">
-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>
+{{OOP||[[vehicle]]:addSirens}}
 ===Required Arguments===
 *'''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)
 ===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
 *'''useRandomiser:''' Randomise the light order, false for sequential
@@ Line 21: / Line 22: @@
 ===Returns===
 Returns ''true'' if sirens were successfully added to the vehicle, ''false'' otherwise.
 ==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)
+addEventHandler('onPlayerVehicleExit', root, function(vehicle, seat)
+   removeVehicleSirens(vehicle)
+end)
+</syntaxhighlight>
+</section>
 ==Requirements==
-{{Requirements|This function has not yet been merged|n/a|}}
+{{Requirements|1.3.0-9.03968|n/a|}}
 ==See Also==
 {{Vehicle_functions}}
-[[Category:Needs_Example]]