AddVehicleSirens

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

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

This example adds a vehicle siren on entering a vehicle and removes a vehicle siren on exiting. (TESTED!)

addEventHandler("onVehicleEnter", root, function(player, seat)
   if (player) and (seat == 0) then
      addVehicleSirens(source, 1, 2)
   end
end)

addEventHandler("onVehicleExit", root, function(player, seat)
   if (player) and (seat == 0) then
      removeVehicleSirens(source)
   end
end)

Requirements

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

Note: Using this function/event 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" />

See Also