GetTrainPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (shared)
(Added example)
Line 14: Line 14:
Returns a float that represents how along the track it is, ''false'' if there is problem with train element.
Returns a float that represents how along the track it is, ''false'' if there is problem with train element.


==Example==
==Example==  
 
<section class="server" name="Server script" show="true">
{{Example}}
This example adds a command called "/getpos", allowing you to get the position of the train.
<syntaxhighlight lang="lua">
function position(player)
  if player and isElement(player) then
    if isPedInVehicle(player) then -- make sure we're actually in a vehicle
        local vehicle = getPedOccupiedVehicle(player)
  if vehicle then
  local vehType = getVehicleType (vehicle)
      if vehType == "Train" then -- make sure we're in a train
local position = getTrainPosition (vehicle)
outputChatBox("The Train position is: "..position)
      else
outputChatBox("You are not in a train!")
      end
  end
else
  outputChatBox("You are not in a vehicle!")
end
    end
end
addCommandHandler("getpos",position)
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Vehicle functions}}
{{Vehicle functions}}

Revision as of 18:14, 1 July 2016

Gets the position the train is currently on the track

Syntax

float getTrainPosition ( vehicle train )

OOP Syntax Help! I don't understand this!

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


Required Arguments

  • train: the train to get the position of

Returns

Returns a float that represents how along the track it is, false if there is problem with train element.

Example

Click to collapse [-]
Server script

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

function position(player)
  if player and isElement(player) then 
     if isPedInVehicle(player) then -- make sure we're actually in a vehicle
        local vehicle = getPedOccupiedVehicle(player)
	  if vehicle then 
	   local vehType = getVehicleType (vehicle) 
	      if vehType == "Train" then -- make sure we're in a train
		 local position = getTrainPosition (vehicle)
		 outputChatBox("The Train position is: "..position)
	      else
		 outputChatBox("You are not in a train!")
	      end
	   end
	else
	  outputChatBox("You are not in a vehicle!")
	end 
    end 
end
addCommandHandler("getpos",position)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetTrainPosition?oldid=47955"