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

setTrainPosition

Client-side
Server-side
Shared

Pair: getTrainPosition

Manual Review Required

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

Sets the position the train is currently on the track

OOP Syntax Help! I don't understand this!

  • Method:vehicle:setTrainPosition(...)
  • Variable: .trainPosition

Syntax 

bool setTrainPosition ( vehicle train, float position )
Required Arguments
  • train: the train of which to set the track
  • position: the position along the track (0 - 18107 a complete way round)

Returns

  • bool: value

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

Code Examples

shared

This example adds a command called "/settrainpos", allowing you to set the position of the train.

local function setMyPosition(player, _, position)
  -- grab the vehicle, if it exists
  local veh = player.vehicle


  -- make sure we're actually in a vehicle
  if not veh then
    player:outputChat("You are not in a vehicle!")
    return
  end


  -- make sure we're in a train
  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>")
    return
  end


  -- finally set the train position
  veh.trainPosition = position
end
addCommandHandler("settrainpos", setMyPosition)

See Also

Vehicle Functions
Vehicle Events
Reference