RemoveVehicleSirens: Difference between revisions

Latest revision as of 19:01, 23 January 2021

This function removes sirens from a vehicle.

Syntax

bool removeVehicleSirens ( vehicle theVehicle )

Required Arguments

theVehicle: The vehicle to remove the sirens of

Returns

Returns true if sirens were successfully removed from the vehicle, false otherwise.

Example

This example adds a vehicle siren on entering a vehicle and removes a vehicle siren on exiting.

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

addEventHandler("onVehicleExit",root,function(player,seat)
   if(player)and(seat==0)then
      removeVehicleSirens(source)
   end
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|4.0120|1.4|3966|
 __NOTOC__
 {{Server function}}
+{{New feature/item|3.0130|1.3.0|3968|
 This function removes sirens from a vehicle.
+}}
 ==Syntax==
 <syntaxhighlight lang="lua">
-removeVehicleSirens ( vehicle theVehicle )
+bool removeVehicleSirens ( vehicle theVehicle )
 </syntaxhighlight>
@@ Line 16: / Line 17: @@
 ==Example==
-{{Example}}
+This example adds a vehicle siren on entering a vehicle and removes a vehicle siren on exiting.
-}}
+<syntaxhighlight lang="lua">
+addEventHandler("onVehicleEnter",root,function(player,seat)
+   if(player)and(seat==0)then
+      addVehicleSirens(source,1,1)
+   end
+end)
+addEventHandler("onVehicleExit",root,function(player,seat)
+   if(player)and(seat==0)then
+      removeVehicleSirens(source)
+   end
+end)
+</syntaxhighlight>
 ==Requirements==
-{{Requirements|1.4-3966|n/a|}}
+{{Requirements|1.3.0-9.03968|n/a|}}
 ==See Also==
 {{Vehicle_functions}}
-[[Category:Needs_Example]]