SetVehicleTaxiLightOn: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (void -> bool)
(Replaced code example with something less messy)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
[[Category:Needs_Example]]
{{Server client function}}
{{client function}}
This function will set the taxi light on in a taxi (vehicle ID's 420 and 438)
This function will set the taxi light on in a taxi (vehicle ID's 420 and 438)


Line 8: Line 7:
bool setVehicleTaxiLightOn ( vehicle taxi, bool LightState )               
bool setVehicleTaxiLightOn ( vehicle taxi, bool LightState )               
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:setTaxiLightOn|taxiLightOn|isVehicleTaxiLightOn}}
===Required Arguments===  
===Required Arguments===  
*'''taxi:''' The vehicle element of the taxi that you wish to turn the light on.
*'''taxi:''' The vehicle element of the taxi that you wish to turn the light on.
Line 17: Line 16:


==Example==
==Example==
This example allows the driver of a taxi to toggle on/off taxi light with a command
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TODO
function toggleTaxiLight()
local vehicle = getPedOccupiedVehicle(localPlayer)
if vehicle and getVehicleController(vehicle) == localPlayer then
local vehModel = getElementModel(vehicle)
if (vehModel) == 420 or (vehModel) == 438 then
setVehicleTaxiLightOn (vehicle, not isVehicleTaxiLightOn(vehicle))
else
outputChatBox ("You're not in a Taxi!", 255, 0, 0, true)
end
end
end
addCommandHandler("taxilight",toggleTaxiLight)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Client vehicle functions}}
{{vehicle functions}}

Latest revision as of 02:25, 1 August 2018

This function will set the taxi light on in a taxi (vehicle ID's 420 and 438)

Syntax

bool setVehicleTaxiLightOn ( vehicle taxi, bool LightState )              

OOP Syntax Help! I don't understand this!

Method: vehicle:setTaxiLightOn(...)
Variable: .taxiLightOn
Counterpart: isVehicleTaxiLightOn


Required Arguments

  • taxi: The vehicle element of the taxi that you wish to turn the light on.
  • LightState: whether the light is on. True for on, False for off.

Returns

Returns true if the state was successfully set, false otherwise.

Example

This example allows the driver of a taxi to toggle on/off taxi light with a command

function toggleTaxiLight()
	local vehicle = getPedOccupiedVehicle(localPlayer)
		if vehicle and getVehicleController(vehicle) == localPlayer then
		local vehModel = getElementModel(vehicle)
			if (vehModel) == 420 or (vehModel) == 438 then
			setVehicleTaxiLightOn (vehicle, not isVehicleTaxiLightOn(vehicle))
		else
			outputChatBox ("You're not in a Taxi!", 255, 0, 0, true)
		end
	end 
end
addCommandHandler("taxilight",toggleTaxiLight)

See Also