AddVehicleSirens: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Number in the start of variable name looks not cool)
m (→‎Syntax: syntax error)
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType [, bool flag360 = 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}}
{{OOP||[[vehicle]]:addSirens}}
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==

Revision as of 12:59, 30 April 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

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

This template will be deleted.

See Also


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