Open Rails

Orts.Formats.Msts Namespace

Namespace Hierarchy

Classes

Class Description
AceFile  
AceInfo  
Activation  
ActivityFailedSignals  
ActivityFile Parse and *.act file. Naming for classes matches the terms in the *.act file.
ActivityObject  
ActivityObjects Parses ActivityObject objects and saves them in ActivityObjectList.
ActivityRestrictedSpeedZone  
ActivityRestrictedSpeedZones  
anim_node  
anim_nodes  
animation  
animations  
ApproachControlLimits Describes a signal object shape and the set of signal heads and other sub-objects that are present on this.
BaseObj  
CabViewControl  
CabViewControls  
CabViewFile  
Camera Individual camera object from the config file
CameraConfigurationFile Object used by ORTS.Cameras to set up views (3dviewer\camera.cs)
CarSpawnerFile  
CarSpawnerFile.CarSpawnerItemData  
CarSpawnerItem Represent a Car Spawner: the place where cars start to appear or disappear again
CarSpawnerObj  
CarSpawnerObj.TrItemId  
colors  
ConsistFile Work with consist files
controller  
controllers  
CrossoverItem Describes a cross-over track item
cullable_prims  
CVCDial  
CVCDigital  
CVCDigitalClock  
CVCDiscrete  
CVCFirebox  
CVCGauge  
CVCMultiStateDisplay  
CVCSignal  
CVCWithFrames  
Deactivation  
DisableTrigger  
Discrete_Trigger  
Dist_Travelled_Trigger  
distance_level  
distance_level_header  
distance_levels  
distance_levels_header  
Duration  
DyntrackObj  
DyntrackObj.TrackSection  
DyntrackObj.TrackSections  
EmptyItem represent an empty item (which probably should only happen for badly defined routes?)
EnableTrigger  
EngineFile Work with engine files
ENVFileSkyLayer  
ENVFileSkySatellite  
EnvironmentFile  
EnvironmentFile.ENVFileWaterLayer  
Event The 3 types of event are inherited from the abstract Event class.
EventCategoryAction Parses all types of action events. Save type of action event in Type. MSTS syntax isn't fully hierarchical, so using inheritance here instead of Type would be awkward.
EventCategoryLocation  
EventCategoryTime  
Events Parses Event objects and saves them in EventList.
ForestObj  
ForestObj.ForestArea  
ForestObj.ScaleRange  
ForestObj.TreeSize  
FrequencyCurve  
geometry_info  
geometry_node  
geometry_nodes  
HazardFile  
HazardObj  
HazzardItem Represends a hazard, a place where something more or less dangerous happens
images  
indexed_trilist  
Initial_Trigger  
JNodePosn  
KeyPosition  
LevelCrItem Representa a level Crossing item (so track crossing road)
LevelCrossingObj  
LevelCrossingObj.LevelCrData  
LevelCrossingObj.LevelCrParameters  
LevelCrossingObj.LevelCrTiming  
LevelCrossingObj.TrItemId  
Light The Light class encapsulates the data for each Light object in the Lights block of an ENG/WAG file.
light_material  
light_materials  
light_model_cfg  
light_model_cfgs  
LightCollection A Lights object is created for any engine or wagon having a Lights block in its ENG/WAG file. It contains a collection of Light objects. Called from within the MSTSWagon class.
LightState A LightState object encapsulates the data for each State in the States subblock.
LightTableEntry Describes how to draw a light in its illuminated state
LightTexture Defines a single light texture, used as background to draw lit lights onto signals
linear_key  
linear_pos  
lod_control  
lod_controls  
matrices  
matrix  
Matrix3x3  
MaxVelocity  
MstsUtility  
normals  
ORTRKData  
ORTSWeatherChange  
Outcomes  
PathFile Paths for both player train as well as AI trains. This class reads and stores the MSTS .pat file. Because of the format of the .pat file it is easier to have an intermediate format that just contains the data of the .pat file and create the wanted data scructure from that. It is the intention that it is only used for * ORTS main menu * postprocessing by TrainPath.
PickupItem Represents a pickup, a place to pickup fuel, water, ...
PickupObj Pickup objects supply fuel (diesel, coal) or water.
PickupObj.PickupAnimDataItem PickupAnimDataItem specifies 2 values. The first represents different pickup animation options. The second represents the animation speed which will be used. For the moment PickupOptions may not be used.
PickupObj.PickupCapacityItem Creates the object. The units of measure have been assumed and, once parsed, the values are not currently used.
PickupObj.SpeedRangeItem SpeedRangeItem specifies the acceptable range of speeds (meters/sec) for using a pickup. Presumably non-zero speeds are intended for water troughs or, perhaps, merry-go-round freight.
PlatformData  
PlatformItem Represents either start or end of a platform (a place where trains can stop).
PlatformNumPassengersWaiting  
PlatformObj Empty sub-class distinguishes platform objects from siding objects.
Player_Service_Definition  
Player_Traffic_Definition  
Player_Traffic_Item  
PlayOneShot  
points  
Position  
prim_state  
prim_states  
primitive  
primitives  
Random_Trigger  
ReleaseLoopRelease  
ReleaseLoopReleaseWithJump  
RoadDatabaseFile RDBFile is a representation of the .rdb file, that contains the road data base. The database contains the same kind of objects as TDBFile, apart from a few road-specific items.
RoadLevelCrItem Represents a Level crossing Item on the road (i.e. where cars must stop when a train is passing).
RoadTrackDB This class represents the Road Track Database. This is pretty similar to the (rail) Track Database. So for more details see there
RouteFile  
RouteStart  
RouteTrackSection  
ScalabiltyGroup  
scrReadInfo  
SectionCurve  
SectionIdx  
SectionSize  
Service_Definition  
Service_Item  
ServiceFile Work with Service Files
SetStreamVolume  
shader_names  
shape  
shape_header  
ShapeDescriptorFile  
ShapeDescriptorFile.ESD_Bounding_Box  
ShapeDescriptorFile.SDShape  
ShapeFile  
SharedSMSFileManager Utility class to avoid loading multiple copies of the same file.
SidingItem Represents either start or end of a siding.
SidingObj Empty sub-class distinguishes siding objects from platform objects.
SignalAspect Describes an signal aspect, a combination of a signal indication state and what it means to be in that state.
SignalConfigurationFile Object containing a representation of everything in the MSTS sigcfg.dat file Not everythin of the representation will be used by OpenRails
SignalDrawLight Describes a single light to be drawn as part of a draw state
SignalDrawState Describes a draw state: a single combination of lights and semaphore arm positions that go together.
SignalItem Describes a signal item
SignalLight Describes the a light on a signal, so the location and size of a signal light, as well as a reference to a light from the lights table
SignalObj  
SignalScripts  
SignalScripts.SCRScripts  
SignalScripts.SCRScripts.SCRBlock  
SignalScripts.SCRScripts.SCRConditionBlock  
SignalScripts.SCRScripts.SCRConditions  
SignalScripts.SCRScripts.SCRParameterType  
SignalScripts.SCRScripts.SCRStatement  
SignalScripts.SCRScripts.SCRStatTerm  
SignalShape  
SignalShape.SignalSubObj Describes a sub-object belonging to a signal shape
SignalType Signal Type which defines the attributes of a type or category of signal-heads
SignalUnit  
SignalUnits  
SimisAceChannel  
SimisAceImage  
slerp_rot  
SMSStream  
SMSStreams  
sort_vectors  
SoundCommand  
SoundManagmentFile Represents the hiearchical structure of the SMS File
SoundPlayCommand  
SoundRegionItem Represents a region where a sound can be played.
SpeedpostDatFile  
SpeedPostItem Describes SpeedPost of MilePost (could be Kilometer post as well)
SpeedPostObj  
SpeedPostObj.Speed_Sign_Shape  
SpeedPostObj.Speed_Text_Size  
StartLoop  
StartLoopRelease  
StartTime  
StaticObj  
STFPositionItem  
STFQDirectionItem  
sub_object  
sub_object_header  
sub_objects  
tcb_key  
tcb_pos  
tcb_rot  
TempSpeedPostItem  
terrain  
terrain_patchset  
terrain_patchset_patch  
terrain_samples  
terrain_shader  
terrain_texslot  
terrain_uvcalc  
terrain_water_height_offset  
TerrainAltitudeFile  
TerrainFile  
TerrainFlagsFile  
texture  
texture_filter_names  
textures  
TileName  
TimeTable  
Tr_Activity  
Tr_Activity_File  
Tr_Activity_Header  
Tr_HazardFile  
Tr_RouteFile  
Tr_SMS  
Tr_Worldfile  
TR_WorldSoundFile  
TrackCircuitSectionXref To make it possible for a MSTS (vector) TrackNode to have information about the TrackCircuitSections that represent that TrackNode, this class defines the basic information of a single of these TrackCircuitSections.
TrackCircuitXRefList Class to make it possible for a MSTS (vector) TrackNode to have information about the TrackCircuitSections that represent that TrackNode.
TrackDatabaseFile TDBFile is a representation of the .tdb file, that contains the track data base. The database contains two kinds of items: TrackNodes and TrItems (Track Items).
TrackDB This class represents the Track Database.
TrackNode Represents a TrackNode. This is either an endNode, a junctionNode, or a vectorNode. A VectorNode is a connection between two junctions or endnodes.
TrackObj  
TrackPath  
TrackPDP  
TrackSection  
TrackSections  
TrackSectionsFile  
TrackShape  
TrackShapes  
TrackTypesFile  
TrackTypesFile.TrackType  
Traffic_Definition Parses Service_Definition objects and saves them in ServiceDefinitionList.
Traffic_Service_Definition Parses Traffic Definition Items in Traffic Definitions in Traffic File
Traffic_Traffic_Definition Parses Traffic Definitions in Traffic File
Traffic_Traffic_Item  
TrafficFile Work with Traffic Files
Train_Config  
TrainCfg  
TransferObj  
Trigger  
Triggers  
TrItem Describes a Track Item, that is an item located on the track that interacts with the train or train operations This is a base class.
TrItemId  
TrJunctionNode Describes details of a junction
TRKEnvironment  
TrObject Super-class for similar track items SidingObj and PlatformObj.
TrObject.TrItemId  
TrPathNode  
TrPin Represents a pin, being the link from a tracknode to another.
TrVectorNode Describes the details of a vectorNode, a connection between two junctions (or endnodes). A vectorNode itself is made up of various sections. The begin point of each of these sections is stored (as well as its direction). As a result, VectorNodes have a direction. Furthermore, a number of TrItems (Track Items) can be located on the vector nodes.
TrVectorSection Describes a single section in a vector node.
TSectionIdx  
TWorldDirection  
TWorldPosition  
UiD Contains the location and initial direction (as an angle in 3 dimensions) of a node (junction or end), as well as a cross reference to the entry in the world file
uv_op  
uv_op_copy  
uv_op_nonuniformscale  
uv_op_reflectmapfull  
uv_op_uniformscale  
uv_ops  
uv_points  
Variable_Trigger  
vertex  
vertex_idx  
vertex_idxs  
vertex_set  
vertex_sets  
vertices  
vol_sphere  
VolumeCurve  
volumes  
vtx_state  
vtx_states  
Wagon  
WagonFile Work with wagon files
WagonList  
WorkOrderWagon Parses a wagon from the WagonList. Do not confuse with older class Wagon below, which parses TrainCfg from the *.con file.
WorldFile  
WorldObject  
WorldSoundFile  
WorldSoundRegion  
WorldSoundSource  

Structures

Structure Description
color  
CurvePoint  
point  
SignalItem.StrTrSignalDir Struct to describe details of the signal for junctions
uv_point  
vector  

Enumerations

Enumeration Description
ActivityMode  
CABViewControlStyles  
CABViewControlTypes  
CABViewControlUnits  
Difficulty  
EventType  
LightControlCondition Specifies on which types of trains (AI, player) the wagon light is illuminated.
LightCouplingCondition Specifies on which units of a consist by coupling (front, rear, both) the wagon light is illuminated.
LightHeadlightCondition Specifies in which headlight positions (off, dim, bright) the wagon light is illuminated.
LightPenaltyCondition Specifies in which penalty states (no, yes) the wagon light is illuminated.
LightServiceCondition Specifies in which in-service states (no, yes) the wagon light is illuminated.
LightTimeOfDayCondition Specifies during which times of day (day, night) the wagon light is illuminated.
LightType Specifies whether a wagon light is glow (simple light texture) or cone (projected light cone).
LightUnitCondition Specifies on which units of a consist (first, middle, last) the wagon light is illuminated.
LightWeatherCondition Specifies in which weather conditions (clear, rain, snow) the wagon light is illuminated.
MstsBlockState Describe the various states a block (roughly a region between two signals) can be in.
MstsSignalAspect Describe the various aspects (or signal indication states) that MSTS signals can have. Within MSTS known as SIGASP_ values. Note: They are in order from most restrictive to least restrictive.
MstsSignalFunction Describe the function of a particular signal head. Only SIGFN_NORMAL signal heads will require a train to take action (e.g. to stop). The other values act only as categories for signal types to belong to. Within MSTS known as SIGFN_ values.
PathFlags  
SeasonType  
SignalScripts.SCRAndOr  
SignalScripts.SCRExternalFloats  
SignalScripts.SCRExternalFunctions  
SignalScripts.SCRNegate  
SignalScripts.SCRTermCondition  
SignalScripts.SCRTermOperator  
SignalScripts.SCRTermType  
SignalType.FnTypes Describe the function of a particular signal head. Only SIGFN_NORMAL signal heads will require a train to take action (e.g. to stop). The other values act only as categories for signal types to belong to. Within MSTS and scripts known as SIGFN_ values.
SimisAceChannelId  
SimisAceFormatOptions  
SoundCommand.SelectionMethods  
StaticFlag  
TileName.Zoom  
TrItem.trItemType Describes the various types of Track Items
Variable_Trigger.Events  
VolumeCurve.Controls  
WeatherType