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

setVehicleSirensOn

Client-side
Server-side
Shared

Pair: getVehicleSirensOn

Manual Review Required

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

This function changes the state of the sirens on the specified vehicle.

OOP Syntax Help! I don't understand this!

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

Syntax 

bool setVehicleSirensOn ( vehicle theVehicle, bool sirensOn )
Required Arguments
  • theVehicle: The vehicle that will have the sirens set
  • sirensOn: The state to set the sirens to

Returns

  • bool: value

Returns true if the sirens are set for the specified vehicle, false if the sirens can't be set 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, jacked )
  --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