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

Lights - General

Lights - Control

Lights - State


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.

ParameterENG or WAGDescriptionRecommended Input UnitsSuggested settingsNew or ExistingTypical Examples
Lights - General
This section describe the parameters used to define the lights operation, such as the type, and turn on and off delays.
Type ( x )WAGCan 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.Numberx = 0 is glow,
x = 1 is cone.
ExistingType( 1 )
FadeIn ( x )WAGTime taken for light to "turn on".Time - secs
Default - Seconds only
As per light specification.ExistingFadeIn ( 0.5 )
FadeOut ( x )WAGTime taken for light to "turn off".Time - secs
Default - Seconds only
As per light specification.ExistingFadeOut ( 0.5 )
Cycle ( x )WAGSets 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.
ExistingCycle ( 0 )
Lights - Control
This section describe the parameters used to define when the lights are lit up and displayed. If not specified, controls are assumed to be at default (x = 0).
Headlight ( x )WAGDetermines when the headlight is lit.NumericAs 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.
ExistingHeadlight (3)
Unit ( x )WAGLights are lit when unit is as specified.NumericAs 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.
ExistingUnit (3)
Penalty ( x )WAGLights are lit due to a penalty brake application.NumericAs 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.
ExistingPenalty (2)
Control ( x )WAGLights are lit depending upon whether it is a player or AI train.NumericAs per light specification.
x = 0, ignore control status,
x = 1, AI train,
x = 2, Player train.
ExistingControl (2)
Service ( x )WAGLights are lit depending upon whether train is in service (player or AI), or out of service (loose consist).NumericAs per light specification.
x = 0, ignore service status,
x = 1, train is out of service,
x = 2, train in service.
ExistingService (1)
TimeOfDay ( x )WAGLights are lit depending upon the time of day.NumericAs per light specification.
x = 0, ignore time of day status,
x = 1, light at daytime,
x = 2, light at nighttime.
ExistingTimeOfDay (2)
Weather ( x )WAGLights are lit when weather matches.NumericAs 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.
ExistingWeather (3)
Coupling ( x )WAGLights are lit depending upon how unit is coupled.NumericAs 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.
ExistingCoupling (3)
Lights - State
This section describe the parameters used to define the state of the lights, including their colour, location, etc. The light may have a number of different states to allow for example, a strobe effect, or alternativley a single state.
Duration ( x )WAGDuration of the light state.Time - secs
Default - Seconds only
As per light specification.
x = 0.0, ignore duration.
ExistingDuration ( 0.0 )
LightColour(aarrggbb)WAGHexadecimal value specifying the colour and translucency of the light.Numeric - HexadecimalAs per light specification.
aa = translucency of light,
rr = red component,
gg = green component,
bb = blue component.
(Colour code selector)
ExistingLightColour ( 80ff0000 )
Position ( x y z )WAGPosition 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).
ExistingPosition ( -1.2 3.0 -2.875 )
Radius ( x )WAGRadius of the light.Distance - m
Default - Metres only
As per light specification.ExistingRadius ( 0.4 )
Azimuth ( x y z )WAGDefines the direction that the light is facing (rotation around the Y-axis).DegreesAs per light specification.
x = minimum
y = centre,
z = maximum
ExistingAzimuth ( -45.0 0.0 45.0 )
Elevation ( x y z )WAGDefines the direction that the light is facing (rotation around the X-axis).DegreesAs per light specification.
x = minimum
y = centre,
z = maximum
ExistingElevation ( -45.0 0.0 45.0 )
Transition ( x )WAGDefines 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.
ExistingTransition ( 0.0 )
Angle ( x )WAGDefines the radius of light (cone light only).DegreesAs per light specification.
If x = 0.0, transition is instantaneous.
ExistingAngle ( 15.0 )

top