SetTrainPosition

From Multi Theft Auto: Wiki
Revision as of 16:06, 2 January 2016 by Qaisjp (talk | contribs) (fix typo)
Jump to navigation Jump to search

Sets the position the train is currently on the track

Syntax

bool setTrainPosition ( vehicle train, float position )

OOP Syntax Help! I don't understand this!

Method: vehicle:setTrainPosition(...)
Variable: .trainPosition
Counterpart: getTrainPosition


Required Arguments

  • train: the train of which to set the track
  • position: the position along the track

Returns

Returns true if the train position was set, false otherwise.

Example

Click to collapse [-]
Example 1
local function setMyPosition(player, _, position)
	local veh = player.vehicle
	if not veh then
		player:outputChat("You are not in a vehicle!")
		return
	end

	if veh.vehicleType ~= "Train" then
		player:outputChat("You are not in a train!")
		return
	end

	-- convert position to a number
	position = tonumber(position)

	-- if position cannot be converted to a number
	if not position then
		player:outputChat("Syntax: /settrainpos <position>")
		player:outputChat("position: number between 0 and 1")
		return
	end

	if (position < 0) or (position > 1) then
		player:outputChat("position must be between 0 and 1!")
	end

	veh.position = position
end
addCommandHandler("settrainpos", setMyPosition)

See Also