getVehicleSirensOn | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getVehicleSirensOn

Client-side
Server-side
Shared

Pair: setVehicleSirensOn

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function returns whether the sirens are turned on for the specified vehicle.

OOP Syntax Help! I don't understand this!

  • Method:vehicle:areSirensOn(...)
  • Variable: .sirensOn

Syntax 

bool getVehicleSirensOn ( vehicle theVehicle )
Required Arguments
  • theVehicle: The vehicle that will be checked.

Returns

  • bool: value

Returns true if the sirens are turned on for the specified vehicle, false if the sirens are turned off for the specified vehicle, if the vehicle doesn't have sirens or if invalid arguments are specified.

Code Examples

shared

This example toggles siren state when a player enters a vehicle as a driver.

function example_onVehicleEnter ( thePlayer, seat )
  --If the player entered as a driver
  if ( seat == 0 ) then
    --If siren was off
    if not getVehicleSirensOn ( source ) then
      setVehicleSirensOn ( source, true ) --Turn it on
    else
      setVehicleSirensOn ( source, false ) --Turn it off
    end
  end
end
addEventHandler ( "onVehicleEnter", getRootElement(), example_onVehicleEnter )

See Also

Vehicle Functions
Vehicle Events
Reference