AddVehicleSirens: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{New feature/item|4.0120|1.4|3966|
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
{{New feature/item|4.0140|1.4|3966|
This function adds sirens to a vehicle.
This function adds sirens to a vehicle.
}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<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 360flag = false, bool checkLosFlag = true, bool useRandomiser flag = true, bool silentFlag = false )
</syntaxhighlight>  
</syntaxhighlight>  


Line 25: Line 26:
==Example==
==Example==
{{Example}}
{{Example}}
}}


==Requirements==
==Requirements==

Revision as of 20:27, 2 April 2012

ADDED/UPDATED IN VERSION 1.4 r3966:

This function adds sirens to a vehicle.

Syntax

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

Required Arguments

  • theVehicle: The vehicle to add sirens
  • sirenCount: The amount of siren points on the vehicle
  • 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)
  • 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

Accessories-text-editor.png Script Example Missing Function AddVehicleSirens needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.
-- TODO


Requirements

Minimum server version 1.4-3966
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.4-3966" />

See Also