Open Rails - Standard Light Parameters
Aim - this section describes the basic standard physics parameters required to correctly define lights in Open Rails Train Simulator.
If you wish to provide any feedback on this page, please use the contact page. It would be great to have some feedback as this helps to ensure the accuracy of the information and models.
Index
Note: The default unit of measure (UoM) shown in the "Recommended Input Units" column is the UoM value that OR assumes if no UoM is included in the parameter statement.
| Parameter | ENG or WAG | Description | Recommended Input Units | Suggested settings | New or Existing | Typical Examples |
|---|---|---|---|---|---|---|
| Lights - General | ||||||
| Type ( x ) | WAG | Can either be a glow or cone type of light. A glow light is typically used for the headlight, as it lights up an area, whereas a glow does not light up the surrounding area. | Number | x = 0 is glow, x = 1 is cone. | Existing | Type( 1 ) |
| FadeIn ( x ) | WAG | Time taken for light to "turn on". | Time - secs Default - Seconds only | As per light specification. | Existing | FadeIn ( 0.5 ) |
| FadeOut ( x ) | WAG | Time taken for light to "turn off". | Time - secs Default - Seconds only | As per light specification. | Existing | FadeOut ( 0.5 ) |
| Cycle ( x ) | WAG | Sets the cycle sequence for multiuple light states. (Does not appear to be operational in OR at this time.) | Time - secs Default - Seconds only | As per light specification. x = 0, cycles forwards and backwards through states continuously, x = 1, cycles forwards in order only. | Existing | Cycle ( 0 ) |
| ShapeHierarchy ( x ) | WAG | Allows attachment of the light to a sub object within the main object | Text | As per object placement. Shape Viewer can be used to determine the hierarchy name of a particular object in the shape file. | New | ShapeHierarchy ( "BOGIE1" ) |
| Lights - Control | ||||||
| Headlight ( x ) | WAG | Determines when the headlight is lit. | Numeric | As per light specification. x = 0, ignore headlight control (H key), x = 1, headlight control is Off, x = 2, headlight is turned on in Dim mode, x = 3, headlight is turned on in Bright mode, x = 4, headlight is turned on in both dim and bright mode, x = 5, headlignt is turned on in both off and dim mode, x = 6, headlight is turned on in both off and bright mode, x = 7, headlight is always on in dim mode regardless of Unit(), headlight is on in bright mode depending on Unit (). | Existing | Headlight (3) |
| Unit ( x ) | WAG | Lights are lit when unit is as specified. | Numeric | As per light specification. x = 0, ignore unit status, x = 1, unit anywhere in the train, x = 2, unit is at front of the train, x = 3, unit is at rear of train, x = 4, unit is at rear of train and reversed, x = 5, unit is at front of train and reversed. | Existing | Unit (3) |
| Penalty ( x ) | WAG | Lights are lit due to a penalty brake application. | Numeric | As per light specification. x = 0, ignore penalty status, x = 1, train has not stopped due to a penalty brake application, x = 2, train has stopped due to a penalty brake application. | Existing | Penalty (2) |
| Control ( x ) | WAG | Lights are lit depending upon whether it is a player or AI train. | Numeric | As per light specification. x = 0, ignore control status, x = 1, AI train, x = 2, Player train. | Existing | Control (2) |
| Service ( x ) | WAG | Lights are lit depending upon whether train is in service (player or AI), or out of service (loose consist). | Numeric | As per light specification. x = 0, ignore service status, x = 1, train is out of service, x = 2, train in service. | Existing | Service (1) |
| TimeOfDay ( x ) | WAG | Lights are lit depending upon the time of day. | Numeric | As per light specification. x = 0, ignore time of day status, x = 1, light at daytime, x = 2, light at nighttime. | Existing | TimeOfDay (2) |
| Weather ( x ) | WAG | Lights are lit when weather matches. | Numeric | As per light specification. x = 0, ignore weather status, x = 1, light lit if fine, x = 2, light lit if raining, x = 3, light lit if snowing. | Existing | Weather (3) |
| Coupling ( x ) | WAG | Lights are lit depending upon how unit is coupled. | Numeric | As per light specification. x = 0, ignore coupling status, x = 1, light if front of wagon coupled, x = 2, light if rear of wagon coupled, x = 3, light if both ends of wagon coupled. | Existing | Coupling (3) |
| ORTSBattery ( x ) | WAG | Responds to the state of the battery switch. | Numeric | As per light specification. x = 0, ignore battery status (default), x = 1, light if battery switch on, x = 2, light if battery switch off. | New | ORTSBattery (1) |
| Brake ( x ) | WAG | Responds to the state of the friction brake system (ie not the dynamic brake). | Numeric | As per light specification. x = 0, ignore brake status (default), x = 1, light if brake system released, x = 2, light if brake system applied. | New | Brake (1) |
| Reverser ( x ) | WAG | Light indication based upon locomotive direction of travel. (NB Steam locomotive cutoff values between -10% and 10% are ignored) | Numeric | As per light specification. x = 0, ignore direction (default), x = 1, must be forward, x = 2, must be reversed, x = 3, must be neutral, x = 4, must be forward or reverse, x = 5, must be forward or neutral, x = 6, must be reverse or neutral. | New | Reverser (1) |
| Reverser ( x ) | WAG | Light indication based upon locomotive direction of travel. (NB Steam locomotive cutoff values between -10% and 10% are ignored) | Numeric | As per light specification. x = 0, ignore direction (default), x = 1, must be forward, x = 2, must be reversed, x = 3, must be neutral, x = 4, must be forward or reverse, x = 5, must be forward or neutral, x = 6, must be reverse or neutral. | New | Reverser (1) |
| Horn ( x ) | WAG | Indication light for horn. Requires ORTSHornLightsTimer( x ) to be set. | Numeric | As per light specification. x = 0, ignore horn (default), x = 1, horn not sounded recently, x = 2, horn sounded recently. | New | Horn (1) |
| ORTSHornLightsTimer( x ) | ENG | Horn indication timer | Numeric | The standard timer is 30 seconds, but can be changed by placing a x = value. If x = 0 is set, the lights will only activate while the horn is sounding and immediately stop afterward. | New | Horn (1) |
| Doors ( x ) | WAG | Indicator lights to show stae of passenger doors. | Numeric | As per light specification. x = 0, ignore doors (default), x = 1, all doors closed, x = 2, left hand doors opened, x = 3, right hand doors opened, x = 4, doors on both sides opened, x = 5, doors on either side are opened. | New | Doors (1) |
| Lights - State | ||||||
| Duration ( x ) | WAG | Duration of the light state. | Time - secs Default - Seconds only | As per light specification. x = 0.0, ignore duration. | Existing | Duration ( 0.0 ) |
| LightColour(aarrggbb) | WAG | Hexadecimal value specifying the colour and translucency of the light. | Numeric - Hexadecimal | As per light specification. aa = translucency of light, rr = red component, gg = green component, bb = blue component. (Colour code selector) | Existing | LightColour ( 80ff0000 ) |
| Position ( x y z ) | WAG | Position of the light relative to the reference point of the wagon (usually the centre). | Distance - m Default - Metres only | As per light specification. x = right (+ve), left (-ve), y = up (+ve), down (-ve), z = front (+ve), rear (-ve). | Existing | Position ( -1.2 3.0 -2.875 ) |
| Radius ( x ) | WAG | Radius of the light. | Distance - m Default - Metres only | As per light specification. | Existing | Radius ( 0.4 ) |
| Azimuth ( x y z ) | WAG | Defines the direction that the light is facing (rotation around the Y-axis). | Degrees | As per light specification. x = minimum y = centre, z = maximum | Existing | Azimuth ( -45.0 0.0 45.0 ) |
| Elevation ( x y z ) | WAG | Defines the direction that the light is facing (rotation around the X-axis). | Degrees | As per light specification. x = minimum y = centre, z = maximum | Existing | Elevation ( -45.0 0.0 45.0 ) |
| Transition ( x ) | WAG | Defines the time for a light transitions from one state to another. | Time - secs Default - Seconds only | As per light specification. If x = 0.0, transition is instantaneous. | Existing | Transition ( 0.0 ) |
| Angle ( x ) | WAG | Defines the radius of light (cone light only). | Degrees | As per light specification. If x = 0.0, transition is instantaneous. | Existing | Angle ( 15.0 ) |