IsTrainChainEngine

From Multi Theft Auto: Wiki
Jump to: navigation, search

This function checks if a train is a chain engine (moves the rest of the chain's carriages) or not.

Syntax

bool isTrainChainEngine ( vehicle theTrain )   

OOP Syntax Help! I don't understand this!

Method: vehicle:isTrainChainEngine(...)
Variable: .chainEngine

Arguments

  • theTrain: a train to check if it's a chain engine or not.

Returns

  • true if a train was passed to the function and if it's a chain engine.
  • false otherwise.

Example

The next code snippet adds a /isthistrainachainengine, which checks if the train occupied by the player who types the command is a chain engine or not.

function checkTrainChainEngine()
   if isPedInVehicle(localPlayer) then
      local train = getPedOccupiedVehicle(localPlayer)
      if getVehicleType(train) == "Train" then
	 outputChatBox("Your train " .. (isTrainChainEngine(train) and "is" or "isn't") .. " a chain engine.", 255, 128, 0)
      else
	 outputChatBox("You need to be in a train to use this command.", 255, 0, 0)
      end
   end
end
addCommandHandler("isthistrainachainengine", checkTrainChainEngine)

See also

FROM VERSION 1.6 r7485 ONWARDS
FROM VERSION 1.6 r7485 ONWARDS