Squirrel/Client/Events/Vehicle/onTrainArrive

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
m
m (Forgot the LU only bar)
 
Line 1: Line 1:
 
{{Squirrel/Title|onTrainArrive}}
 
{{Squirrel/Title|onTrainArrive}}
 +
{{Squirrel/LUOnly}}
 
{{ScriptingChangesIn0.1.0.11}}
 
{{ScriptingChangesIn0.1.0.11}}
 
This is called when a train arrives at a train station.
 
This is called when a train arrives at a train station.

Latest revision as of 23:53, 12 September 2011

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events
LU This function works in Liberty Unleashed only.

This is called when a train arrives at a train station.

[edit] Syntax 

  1. function onTrainArrive( int train, int station )

[edit] Arguments

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

[edit] Returns

This event does not handle return values.

[edit] Example

This example will message the player when their train arrives at a station. 

  1.  
  2. function onTrainArrive( train, station )
  3. {
  4.      if ( train == FindLocalPlayer().Train )
  5.      {
  6.           Message( "You arrived at " + GetTrainStationName( station ) + " Station" );
  7.      }
  8.      
  9.      return 1;
  10. }
  11.  
  12. function GetTrainStationName( station )
  13. {
  14.      switch ( station )
  15.      {
  16.      // L-train
  17.      case STATION_STMARKS:
  18.           return "Baillie";
  19.      case STATION_HEPBURN:
  20.           return "Rothwell";
  21.      case STATION_CHINATOWN:
  22.           return "Kurowski";
  23.  
  24.      // Subway
  25.      case STATION_PORTLAND:
  26.           return "Portland";
  27.      case STATION_ROCKFORD:
  28.           return "Rockford";
  29.      case STATION_TERMINAL:
  30.           return "Shoreside Terminal";
  31.      case STATION_STAUNTON:
  32.           return "Staunton South";
  33.      }
  34.  
  35.      return "Train";
  36. }
  37.  

[edit] Notes

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

[edit] Related Events

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Client/Events/Vehicle/onTrainArrive&oldid=3124"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox