Classification-signals container

Latest revision as of 11:26, 7 May 2019

The Classification-signals container is an optional subcontainer used by KIND Traincar assets to define US style classification lights or flags on a locomotive. Support for this subcontainer was added in Trainz A New Era as a faster alternative to various custom scripts which attempt to do the same thing.

[edit] Overview

Classification Signals are coloured lights or flags used to communicate information about a trains schedule to signalling staff and other trackside workers, particularly in the days before ubiquitous radio communication, but also in later periods particularly where 'train order' or similar safeworking systems were in use.

There are three possible options for classification lights: White - Indicates an "extra services", i.e. one not included in the timetable. Freight was often not timetabled, so this would be common. Green - Indicates that although the train is scheduled in the timetable, a second (and third, fourth, etc) section is following behind it. This could occur if passenger demand exceeded the carrying capacity of the train, for example. None - A normal timetabled train would display no special flags attached and lights would be turned off.

The lights were also generally capable of displaying a red light, used as a tail light. See Taillights

[edit] Supported Tags

The classification-signals container itself will contain sub-containers which define the classification signals. Each sub-container should be uniquely named. The subcontainers, however, support the following tags. Each tag is shown here with its default value.

 type ""
 effect ""
 display-time 0,24

[edit] type

Type: Text

Desc: Specifies the classification type, with three options (timetabled, extra, following). For example, the classification type for a 'following' train would have the type tag set as follows:

 type                   "following"

[edit] effect

Type: Text

Desc: Specifies the mesh-table 'effect' entry to be used for the classification signal.

[edit] display-time

Type: vector2

Desc: Specifies the time of day the effect is in use, with the lowest value being 0 (midnight) and the highest value being 24 (midnight). For an effect only visible between 6am and 6pm (approximate daylight hours), you would set the tag as follows:

 display-time 6,18

[edit] Configuration

Coronas are defined as effects blocks in the loco mesh table:

mesh-table
{
  default
  {
    mesh                                "loco_body/loco_body.lm"
    auto-create                         1
    
    effects
    { 
      greenleft
      {
        kind                            "corona"
        att                             "a.green_left"
        directional                     1
        object-size                     0.24
        texture-kuid                    <kuid2:354694:14101:6>
      }
     
      greenright
      {
        kind                            "corona"
        att                             "a.green_right"
        directional                     1
        object-size                     0.24
        texture-kuid                    <kuid2:354694:14101:6>
      }
     
      whiteleft
      {
        kind                            "corona"
        att                             "a.white_left"
        directional                     1
        object-size                     0.24
        texture-kuid                    <kuid2:354694:14105:6>
      }
     
      whiteright
      {
        kind                            "corona"
        att                             "a.white_right"
        directional                     1
        object-size                     0.24
        texture-kuid                    <kuid2:354694:14105:6>
      }
    }
  }
}

The effect is displayed along the negative Z axis of the attachment point. The corresponding classification-signals container is configured as follows:

classification-signals
{
  greenleft
  {
    type                                "following"
    effect                              "greenleft"
    display-time                        0,24
  }
 
  greenright
  {
    type                                "following"
    effect                              "greenright"
    display-time                        0,24
  }
 
  whiteleft
  {
    type                                "extra"
    effect                              "whiteleft"
    display-time                        0,24
  }
 
  whiteright
  {
    type                                "extra"
    effect                              "whiteright"
    display-time                        0,24
  }
}

[edit] Use within Trainz

When placing a loco in Surveyor the default setting is "Timetabled Train (off)". To change the classification in Surveyor choose "Edit properties" in the Trains tab and click the loco. Click "Timetabled Train (off)" to cycle through the options.

The classification lights will be set for an entire consist, not just that locomotive. The effect is only shown on the lead vehicle, if it uses the classification-signals system and supports that classification light option.