onTrainLeave

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This is called when a train departs from a train station.

Syntax

function onTrainLeave( int train, int station )

Arguments

• train - The ID of the train in question
• station - The station the train left from. See a list of constants here.

Returns

This event does not handle return values.

Example

This example will message the player when their train leaves from a station.

 
function onTrainLeave( train, station )
{
     if ( train == FindLocalPlayer().Train )
     {
          Message( "You departed from " + GetTrainStationName( station ) + " Station" );
     }
     
     return 1;
}
 
function GetTrainStationName( station )
{
     switch ( station )
     {
     // L-train
     case STATION_STMARKS:
          return "Baillie";
     case STATION_HEPBURN:
          return "Rothwell";
     case STATION_CHINATOWN:
          return "Kurowski";
 
     // Subway
     case STATION_PORTLAND:
          return "Portland";
     case STATION_ROCKFORD:
          return "Rockford";
     case STATION_TERMINAL:
          return "Shoreside Terminal";
     case STATION_STAUNTON:
          return "Staunton South";
     }
 
     return "Train";
}
 

Notes

The functions Message, FindLocalPlayer and Player.Train were used in this example. More info about them can be found in the corresponding pages.

Related Events

• onClientVehicleDamage
• onClientEnteredTrain
• onClientEnteredVehicle
• onClientEnteringTrain
• onClientEnteringVehicle
• onClientExitedTrain
• onClientExitedVehicle
• onClientExitingTrain
• onClientExitingVehicle
• onClientFailedVehicleEntry
• onTrainArrive
• onTrainLeave
• onClientVehicleShot