Create Wiki

Appearance

MethodDescription
assemble()Assembles a new train at the station
disassemble()Disassembles the currently present train
setAssemblyMode(assemblyMode)Sets the station's assembly mode
isInAssemblyMode()Whether the station is in assembly mode
getStationName()Gets the station's current name
setStationName(name)Sets the station's name
isTrainPresent()Whether a train is present at the station
isTrainImminent()Whether a train is imminent to the station
isTrainEnroute()Whether a train is enroute to the station
getTrainName()Gets the currently present train's name
setTrainName(name)Sets the currently present train's name
hasSchedule()Whether the currently present train has a schedule
getSchedule()Gets the currently present train's schedule
setSchedule(schedule)Sets the currently present train's schedule
canTrainReach(destination)Checks if a route to a given station is possible
distanceTo(destination)Measures the distance to a given station
EventDescription
train_imminentTriggers when a train is imminent
train_arrivalTriggers when a train arrives to station
train_departureTriggers when a train departs from station

assemble() ​

Assembles a new train at the station. The station must be in assembly mode before calling this function.

This function also causes the station to exit assembly mode after the train is done assembling.

Throws

  • If the station is not in assembly mode.
  • If the station is not connected to a track.
  • If the train failed to assemble.
  • If the station failed to exit assembly mode.

See also

disassemble() ​

Disassembles the station's currently present train. The station must not be in assembly mode.

Throws

  • If the station is in assembly mode.
  • If the station is not connected to a track.
  • If there is currently no train present at the station.
  • If the train failed to disassemble.

See also

setAssemblyMode(assemblyMode) ​

Sets the station's assembly mode.

Parameters

  • assemblyMode: boolean Whether the station should be in assembly mode.

Throws

  • If the station fails to enter or exit assembly mode.
  • If the station is not connected to a track.

isInAssemblyMode() ​

Checks whether the station is in assembly mode.

Returns

  • boolean Whether the station is in assembly mode.

getStationName() ​

Gets the station's current name.

Returns

  • string The station's current name.

Throws

  • If the station is not connected to a track.

setStationName(name) ​

Sets the station's name.

Parameters

  • name: string What to set the station's name to.

Throws

  • If the station name fails to be set.
  • If the station is not connected to a track.

isTrainPresent() ​

Checks whether a train is currently present at the station.

Returns

  • boolean Whether a train is present at the station.

Throws

  • If the station is not connected to a track.

isTrainImminent() ​

Checks whether a train is imminently arriving at the station.

Imminent is defined as being within 30 blocks of the station.

This will not be true if the train has arrived and stopped at the station.

Returns

  • boolean Whether a train is imminent to the station.

Throws

  • If the station is not connected to a track.

See also

isTrainEnroute() ​

Checks whether a train is enroute and navigating to the station.

Returns

  • boolean Whether a train is enroute to the station.

Throws

  • If the station is not connected to a track.

getTrainName() ​

Gets the currently present train's name.

Returns

  • string The currently present train's name.

Throws

  • If the station is not connected to a track.
  • If there is currently no train present at the station.

setTrainName(name) ​

Sets the currently present train's name.

Parameters

  • name: string What to set the currently present train's name to.

Throws

  • If the station is not connected to a track.
  • If there is currently no train present at the station.

hasSchedule() ​

Checks whether the currently present train has a schedule.

Returns

  • boolean Whether the currently present train has a schedule.

Throws

  • If the station is not connected to a track.
  • If there is currently no train present at the station.

getSchedule() ​

Gets the currently present train's schedule.

Returns

  • table The train's schedule

Throws

  • If the station is not connected to a track.
  • If there is currently no train present at the station.
  • If the present train doesn't have a schedule.

See also

setSchedule(schedule) ​

Sets the currently present train's schedule. This will overwrite the currently set schedule.

Parameters

  • schedule: table The schedule to set the present train to.

Throws

  • If the station is not connected to a track.
  • If there is currently no train present at the station.

See also

canTrainReach(destination) ​

Tests if a route to the station named destination is possible from this station.

Parameters

  • destination: string The name of the station to test the route to.

Returns

  • boolean true if the route is possible, false if not.
  • string Reason why the route isn't possible if applicable. "no-target" if no path is found, "cannot-reach" if there's something in the way.

Throws

  • If the station is not connected to a track.

distanceTo(destination) ​

Measures the distance between the station named destination and this station.

Parameters

  • destination: string The name of the station to measure the route to.

Returns

  • number the distance to the target station in meters (blocks) or nil if impossible.
  • string Reason why the route isn't possible if applicable. "no-target" if no path is found, "cannot-reach" if there's something in the way.

Throws

  • If the station is not connected to a track.

Events

The following are events that can be accessed with os.pullEvent(filter).

Event: train_imminent ​

Triggers whenever a train's arrival is imminent.

Imminent is defined as being within 30 blocks of the station.

Returns

  • string Name of train.

Event: train_arrival ​

Triggers whenever a train arrives at the station.

Returns

  • string Name of train.

Event: train_departure ​

Triggers whenever a train departs from the station.

Returns

  • string Name of train.