# Functions
FromHex() parses a "css/html" hex color-string, either in the 3 "#f0c" or 6 "#ff1034" digits form.
InitializeLogger creates the Logger for the simulation module.
No description provided by the author
NextSignalPosition returns the position of the next signal in front of the given position.
ParseTime returns a Time object from its string representation in format 15:04:05.
RegisterLineItemManager registers the given line manager in the simulation.
RegisterPointsItemManager registers the given points manager in the simulation.
RegisterRoutesManager registers the given route manager in the simulation.
RegisterSignalItemManager registers the signal manager in the simulation.
RegisterTrainsManager registers the given trains manager in the simulation.
# Constants
Activated = The route is active but will be destroyed by the first train using it.
Possible action targets for trains to apply signal actions.
Possible action targets for trains to apply signal actions.
Possible action targets for trains to apply signal actions.
Events that can be send to clients that add a listener to them.
Deactivated = The route is not active.
Destroying = The route is currently being destroyed by a train.
DirectionCurrent : special position used in functions so as not to change points position.
DirectionFailed : Points or points sensors have a failure.
DirectionNormal : Point is set at normal.
DirectionReversed : Point is set for cross over.
DirectionUnknown : No direction is returned by the points sensors.
EndOfService means the train has finished its service and no new service assigned.
Inactive means not yet entered on the scene.
Events that can be send to clients that add a listener to them.
NoMorePlace is a large float used to represent a non existent service line index.
Events that can be send to clients that add a listener to them.
Out means the train exited the area.
Persistent = The route is set and will remain after train passage.
Events that can be send to clients that add a listener to them.
Events that can be send to clients that add a listener to them.
Running with a positive speed.
Events that can be send to clients that add a listener to them.
Events that can be send to clients that add a listener to them.
Stopped at a station.
Events that can be send to clients that add a listener to them.
Events that can be send to clients that add a listener to them.
Events that can be send to clients that add a listener to them.
Events that can be send to clients that add a listener to them.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Available track item types.
Version of the software, mostly used for file format.
VeryHighSpeed is the speed limit set when there are no speed limits.
Waiting means an unscheduled stop, e.g.
# Variables
No description provided by the author
# Structs
An BoolObject is a SimObject that wraps a single boolean value.
A Colour stored as RGB values.
A Condition on the current simulation context used for defining signal state.
DelayGenerator is a probability distribution for a duration in seconds and is used to generate random delays for trains.
An EndItem is an invisible item to which the free ends of other Trackitem instances must be connected to prevent the simulation from crashing.
Event is a wrapper around an object that is sent to the server hub to notify clients of a change.
An IntObject is a SimObject that wraps a single integer value.
InvisibleLinkItem behave like line items, but clients are encouraged not to represented them on the scenery.
ItemInconsistentLinkError is returned when a TrackItem is linked to another one, but the latter is not linked to the former.
An ItemNotLinkedAtError is returned when a TrackItem instance has no connected item at the given end.
An ItemsNotLinkedError is returned when two TrackItem instances that are assumed to be linked are not.
A LineItem is a resizable TrackItem that represent a simple railway line and is used to connect two TrackItem's together.
Message is one message emitted to the MessageLogger of the simulation.
MessageLogger holds all Message instances that have been emitted to it.
nextActiveRoute is true if a route starting from this Signal is active.
NextSignalAspects is true if the next signal is showing one of the aspects given.
Options struct for the simulation.
A Place is a special TrackItem representing a physical location such as a station or a passing point.
PlatformItem's are usually represented as a colored rectangle on the scene to symbolise the platform.
Point type represents a point on the scenery.
A PointsItem is a three-way railway junction (known as Point, Switch, Turnout..)
The three ends are called `common end`, `normal end` and `reverse end`
____________ reverse / common ___________/______________normal
Trains can go from the common end to normal or reverse ends depending on the state of the points, but they cannot go from the normal end to reverse end.
A Position object is a point on a TrackItem.
previousActiveRoute is true if a route ending at this Signal is active.
A Route is a path between two signals.
RouteExitSignalAspects is true if the exit signal of the route starting at this signal is showing one of the aspects given.
RouteSet is true if at least one of the routes, the id of which is defined by custom property is active.
RouteSetAcross is true if a route is active across this signal, in the same direction but neither starting nor ending at this signal.
A Service is mainly a predefined schedule that trains are supposed to follow with a few additional informations.
A ServiceAction is an action that can be performed on a train.
ServiceLine is a line of the definition of the Service.
SignalAction defines an action that must be performed by a train when seeing a SignalAspect.
SignalAspect class represents an aspect of a signal, that is a combination of on and off lights with a meaning for the train driver.
SignalItem is the "logical" item for signals.
SignalLibrary holds the information about the signal types and signal aspects available in the simulation.
A SignalState is an aspect of a signal with a set of conditions to display this aspect.
A SignalType describes a type of signals which can have different aspects and the logic for displaying aspects.
Simulation holds all the game logic.
TextItem "displays simple text" on the scenery layout.
Time type for the simulation (HH:MM:SS).
Train is a stock of `TrainType` running on a track at a certain speed and to which is assigned a `Service`.
TrainNotPresentBeforeNextSignal is true if there is no train ahead of this signal and before the next signal on the line.
TrainNotPresentOnItems is true if there is no train on the track items defined by params.
TrainNotPresentOnNextRoute is true if there is no train ahead of this signal and before the end of the next active route.
TrainPresentOnItems is true if there a train on all the track items defined by custom property.
TrainType defines a rolling stock type.
# Interfaces
A ConditionType is a type of condition that can be used for defining a signal state.
A LineItemManager manages breakdowns of line track circuits.
A PointsItemManager simulates the physical points, in particular delay in points position and breakdowns.
A RoutesManager checks if a route is activable or deactivable.
A SignalItemManager is in charge of computing the aspect of a signal.
A SimObject can be serialized in an event.
A TrackItem is a piece of scenery and is "the base interface" for others such as SignalItem, EndItem, PointsItem.
A TrainsManager defines a driver behaviour which impacts the speed of trains.
# Type aliases
ActionTarget defines when a speed limit associated with a signal aspect must be applied.
A CustomProperty is a map to hold track item properties that are defined by the user.
An EventName is the name of a event.
MessageType defines the type of message of the Logger.
PointDirection are constants that represent the "physical state" of a PointsItem.
RouteState represents the state of a Route at a given time and instance.
A TrackItemType holds the type of a track item.
The TrainStatus describe the current state of a train.