IsTrainChainEngine: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (A little grammar correction at →‎Example)
mNo edit summary
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Server client function}}
{{Client function}}
__NOTOC__
__NOTOC__
{{New items|3.0140|1.4|
{{New items|3.0140|1.4|
This function checks if a [[Element/Vehicle|train]] is a chain engine (moves the rest of the chain's trains) or not.
This function checks if a [[Element/Vehicle|train]] is a chain engine (moves the rest of the chain's carriages) or not.
}}
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isTrainChainEngine( vehicle theTrain )   
bool isTrainChainEngine ( vehicle theTrain )   
</syntaxhighlight>  
</syntaxhighlight>  
 
{{New feature/item|3.0141|1.4.1|6946|{{OOP||[[Element/Vehicle|vehicle]]:isTrainChainEngine|chainEngine}}}}
===Arguments===  
===Arguments===  
*'''theTrain:''' a [[Element/Vehicle|train]] to check if it's a chain engine or not.
*'''theTrain:''' a [[Element/Vehicle|train]] to check if it's a chain engine or not.


===Returns===
===Returns===
Returns ''true'' if a [[Element/Vehicle|train]] was passed to the function and if it's a chain engine. Returns ''false'' otherwise.
* ''true'' if a [[Element/Vehicle|train]] was passed to the function and if it's a chain engine.
* ''false'' otherwise.


==Example==
==Example==
<section name="Server" class="server" show="true">
 
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.
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.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function checkTrainChainEngine(player)
function checkTrainChainEngine()
    if isPedInVehicle(player) and getVehicleType(getPedOccupiedVehicle(player)) == "Train" then
  if isPedInVehicle(localPlayer) then
        local train = getPedOccupiedVehicle(player)
      local train = getPedOccupiedVehicle(localPlayer)
        outputChatBox("Your train " .. (isTrainChainEngine(train) and "is" or "isn't") .. " a chain engine.", player, 255, 128, 0)
      if getVehicleType(train) == "Train" then
    else
outputChatBox("Your train " .. (isTrainChainEngine(train) and "is" or "isn't") .. " a chain engine.", 255, 128, 0)
        outputChatBox("You need to be in a train to use this command.", player, 255, 0, 0)
      else
    end
outputChatBox("You need to be in a train to use this command.", 255, 0, 0)
      end
  end
end
end
addCommandHandler("isthistrainachainengine", checkTrainChainEngine)
addCommandHandler("isthistrainachainengine", checkTrainChainEngine)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See also==
==See also==
{{Vehicle functions}}
{{Vehicle functions}}
[[ru:IsTrainChainEngine]]

Latest revision as of 23:13, 2 August 2016

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

Retrieved from "https://wiki.multitheftauto.com/wiki/IsTrainChainEngine?oldid=48659"