GetTrainDirection: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Needs example)
m (fix oop typo)
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool getTrainDirection ( vehicle train )</syntaxhighlight>
<syntaxhighlight lang="lua">bool getTrainDirection ( vehicle train )</syntaxhighlight>
 
{{OOP||[[vehicle]]:getDirection|direction|setTrainDirection}}
===Required Arguments===
===Required Arguments===
*'''train:''' the train of which to get the driving direction.
*'''train:''' the train of which to get the driving direction.
Line 13: Line 13:


==Example==
==Example==
This example outputs to the player the direction the train they're driving is travelling.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function trainDir(thePlayer,command)
if (isPedInVehicle(thePlayer)) then -- Check if they're even in a vehicle.
if (getVehicleType(getPedOccupiedVehicle(thePlayer)) == "Train") then -- Check if they're in a train.
local direction = getTrainDirection(getPedOccupiedVehicle(thePlayer)) -- Get the train's direction.
if (direction) then
outputChatBox("You're driving clockwise.",thePlayer,255,255,0) -- Output that they're driving clockwise.
else
outputChatBox("You're driving anti-clockwise.",thePlayer,255,255,0) -- Output that they're driving anti-clockwise.
end
else
outputChatBox("You must be in a train to use this command.",thePlayer,255,0,0) -- Output that they're not in a train.
end
else
outputChatBox("You must be in a train to use this command.",thePlayer,255,0,0) -- Output that they're not in a vehicle.
end
end
addCommandHandler("direction",trainDir)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}
[[Category:Needs Example]]

Latest revision as of 12:44, 6 September 2015

Gets the direction in which a train is driving (clockwise or counterclockwise).

Syntax

bool getTrainDirection ( vehicle train )

OOP Syntax Help! I don't understand this!

Method: vehicle:getDirection(...)
Variable: .direction
Counterpart: setTrainDirection


Required Arguments

  • train: the train of which to get the driving direction.

Returns

Returns true if the train is driving clockwise on the train track, false if it is going counterclockwise or a failure occured.

Example

This example outputs to the player the direction the train they're driving is travelling. 

function trainDir(thePlayer,command)
	if (isPedInVehicle(thePlayer)) then -- Check if they're even in a vehicle.
		if (getVehicleType(getPedOccupiedVehicle(thePlayer)) == "Train") then -- Check if they're in a train.
			local direction = getTrainDirection(getPedOccupiedVehicle(thePlayer)) -- Get the train's direction.
				if (direction) then
					outputChatBox("You're driving clockwise.",thePlayer,255,255,0) -- Output that they're driving clockwise.
				else
					outputChatBox("You're driving anti-clockwise.",thePlayer,255,255,0) -- Output that they're driving anti-clockwise.
				end
		else
			outputChatBox("You must be in a train to use this command.",thePlayer,255,0,0) -- Output that they're not in a train.
		end
	else
		outputChatBox("You must be in a train to use this command.",thePlayer,255,0,0) -- Output that they're not in a vehicle.
	end
end
addCommandHandler("direction",trainDir)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetTrainDirection?oldid=45898"