IsTrainDerailed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
Line 1: Line 1:
__NOTOC__  
__NOTOC__
 
{{Server client function}}
{{Server client function}}
This function will check if a train or tram is derailed.
This function will check if a train or tram is derailed.
Line 10: Line 9:
{{OOP||[[vehicle]]:isDerailed|derailed|setTrainDerailed}}
{{OOP||[[vehicle]]:isDerailed|derailed|setTrainDerailed}}
===Required Arguments===  
===Required Arguments===  
*'''vehicleToCheck:''' The vehicle that you wish to check is derailed.
*'''vehicleToCheck:''' the [[vehicle]] that you wish to check is derailed.


===Returns===
===Returns===

Latest revision as of 01:45, 7 April 2018

This function will check if a train or tram is derailed.

Syntax

bool isTrainDerailed ( vehicle vehicleToCheck )

OOP Syntax Help! I don't understand this!

Method: vehicle:isDerailed(...)
Variable: .derailed
Counterpart: setTrainDerailed


Required Arguments

  • vehicleToCheck: the vehicle that you wish to check is derailed.

Returns

Returns true if the train is derailed, false if the train is still on the rails

Example

Click to collapse [-]
Example

This example lets a player check if the train they're driving has derailed. 

function checkDerailed(thePlayer)
    local theTrain = getPedOccupiedVehicle(thePlayer)
    if ( theTrain and getVehicleType(theTrain) == "Train" ) then --is the player in a vehicle and is it a train?
        if ( isTrainDerailed(theTrain) ) then --is the train derailed?
            outputChatBox("Your train is derailed", thePlayer, 255, 255, 0) --outputs a message
        else
            outputChatBox("Your train is not derailed", thePlayer, 0, 255, 0) --outputs a message
        end
    end
end
addCommandHandler("checkTrain", checkDerailed) --adds the command handler

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsTrainDerailed?oldid=54608"