SetTrafficLightsLocked

From Multi Theft Auto: Wiki
Revision as of 11:54, 12 August 2010 by The Ex (talk | contribs) (→‎Example)
Jump to navigation Jump to search

Toggles whether you want the traffic lights to be locked. If the lights are locked, it means they won't change unless you do setTrafficLightState.

Syntax

bool setTrafficLightsLocked ( bool toggle )

Required Arguments

  • toggle: A bool indicating whether you want the traffic lights to change automatically, or not

Returns

Returns true if the successful, false otherwise.

Example

This example toggles traffic lights between 'locked' and 'unlocked'.

function toggleTrafficLights()
    if areTrafficLightsLocked() then -- See if traffic lights are currently locked
	setTrafficLightsLocked(false) -- unlock traffic lights if they are currently locked
    else
	setTrafficLightsLocked(true) -- lock traffic lights if they are not locked
    end
end
-- add command handler for command which toggles lights
addCommandHandler("toggletrafficlights",toggleTrafficLights)

See Also