KIND Traincar

KIND Traincar provides the basis for all individual train Vehicles, for example, a single item of the locomotive, a single item of rollingstock, or a single tender.

This asset type inherits all trackside positioning and mesh display characteristics, and adds Vehicle-specific functionality such as physics and control mechanisms.

This page describes trainz-build 4.1.

KIND Hierarchy

Parent Classes

KIND Scenery-trackside

Child Classes

none.

Supported Tags

Each traincar asset supports the following tags. Each tag is shown here with its default value.

kind "traincar"
cabinsway 1.0
company "QueenslandRail"
ditch_color 0,0,0
low_beam_value 2,2,2
high_beam_value 1,1,1
interior-light-texture ""
interior-light-color 0.0, 0.0, 0.0
flash_scale 1
engine 0
real-engine 1
enginespec (KUID)
enginesound (KUID)
fonts 1
hornsound (KUID)
cabin_muffle 0.4
light_color 0,0,0
mass 37000
max-coupler-gap 0.08
pantograph (KUID)
smoke_shade 0.09
smoke_random 2.9
smoke_slowlife 3
smoke_fastlife 0
smoke_height 0.8
smoke_fastspeed 10
suspension-stiffness 0.75
suspension-damping 0.3
suspension-pitch-limit 1.0
suspension-roll-limit 5.0
tender 0
use-coupler-sounds 1
disable-extra-track-sounds 0
max-tractive-effort 0
fonts-path ""
vehicle-running-numbers
{
}
classification-signals
{
}
bogeys
{
}
origin "AU"                    (obsolete)
paintshed-template-used (KUID) (obsolete)
paintshed-skin-used (KUID)     (obsolete)
product-id ""                  (obsolete)
product-version ?              (obsolete)
product-type ""                (obsolete)

cabin_muffle

Type: Decimal

Compulsory: No

Default: Steam 1.0, Other 0.4

Desc: Amount that the enginesound volume should be reduced to when in-cab. Default of 0.4 is 40% volume, intended to represent a fully enclosed and noise deadened cab. Steam locos default to no muffling at all (steam loco cabs are very frequently not fully enclosed, let alone fitted with noise deadening material).

cabinsway

Type: Decimal

Compulsory: No

Default: 1.0

Desc: Controls the amount of 'sway' the interior view has as the vehicle takes corners. A bigger number will result in more sway.

company

Type: English Text String

Compulsory: No

Default: Queensland Rail

Desc: Text string to indicate which railway company or organisation this vehicle is in service with as represented.

disable-extra-track-sounds

Type: Boolean

Compulsory: No

Default: 0 (false)

Desc: Disables extra track sounds for this vehicle. Useful for making drivable ships, aircraft, road vehicles, etc. - anything that should not make wheel-on-rail type sounds.

ditch_color

Type: Color(RGB)

Compulsory: No

Default: 0,0,0

Desc: Color of ditch lights (values are integer between 0 and 255, comma separated for red, green, and blue).

engine

Type: Boolean

Compulsory: Yes (from 3.4)

Default: 0

Desc: If 1, vehicle is a locomotive, if 0, vehicle is an unpowered traincar. Locomotives are expected to have cab interiors, hornsounds, enginesounds, and so on.

enginesound

Type: KUID

Compulsory: No

Default: Nothing

Desc: Enginesound Asset to use with this locomotive.

enginespec

Type: KUID

Compulsory: Yes

Desc: Enginespec Asset to use with this locomotive. Defines locomotive performance characteristics.

flash_scale

Type: Decimal

Compulsory: No

Default: 1

Desc: Sets the speed that the ditch lights flash at.

fonts

Type: Integer

Compulsory: No

Default: 1

Desc: Number of running-number fonts to use on this locomotive. The value must be from 0 to 5.

See Alpha Numbers for further information regarding Alpha Numbers (aka running-numbers) on traincars.

fonts-path

Type: Text

Compulsory: No

Default: Nothing

Desc: Text to use when determining where running numbers are stored. This text will be concatenated with "_alpha_numbers" to provide the path to the images to be used for the running numbers. For example if the supplied text is "my_loco" then the path, relative to the asset folder, will be "my_loco_alpha_numbers".

See Alpha Numbers for further information regarding Alpha Numbers (aka running-numbers) on traincars.

high_beam_value

Type: Decimal array

Compulsory: No

Default: 1,1,1

Desc: Comma separated sequence of decimal values. Used to configure the brightness of the lights when in high beam mode. First number applies to first headlight point, and so on. Values are divisors - e.g. a value of 2 means half brightness.

interior-light-texture

Type: Texture_file

Compulsory: No

Default: Nothing

Desc: The name of the texture resource (with the '.texture.txt' part omitted) that you want to illuminate the interior. The effect will be applied to ALL materials which use the specified texture.

interior-light-color

Type: Decimal array

Compulsory: No

Default: 0.75,0.75,0.75

Desc: This specifies the RGB level of self-illumination to be applied. The default is a reasonable starting point. The effect will be on by default but can be turned off by script or via the traincar's property editor. When it is on the effect is independent of the time of day. As a result the interior mesh will appear to be lit by night and also brighter by day, you may have to increase the opacity of your windows to compensate for this. The effect is independent of traincar headlights or any night-mesh containers.

hornsound

Type: KUID

Compulsory: No

Default: Nothing

Desc: Hornsound Asset to play when loco's horn is blown.

light_color

Type: Color(RGB)

Compulsory: No

Default: 0,0,0

Desc: Color of headlight (values are integer between 0 and 255, comma separated for red, green, and blue).

low_beam_value

Type: Decimal array

Compulsory: No

Default: 2,2,2

Desc: Comma separated sequence of decimal values. Used to configure the brightness of the lights when in low beam mode. First number applies to first headlight point, and so on. Values are divisors - e.g. a value of 2 means half brightness.

mass

Type: Decimal

Compulsory: Yes (from 3.4)

Default: 37000

Desc: Mass of the vehicle in Kilograms when empty - i.e. the tare weight, not the gross weight. The mass of any products loaded into queues will be added to this by the game.

max-coupler-gap

Type: decimal

Compulsory: No

Default: 0.08

Desc: Specifies the amount of permissible coupler slack on this vehicle in Metres. Note: The observable slack between any two vehicles will be the average of the values for each vehicle. Cannot be zero.

max-tractive-effort

Type: Decimal

Compulsory: No

Default: 0

Desc: Maximum tractive effort this vehicle can put into the track in Newtons. (Only used for Diesel and Electric locos - Steam locos use a different system defined in the enginespec.)

pantograph

Type: KUID

Compulsory: No

Default: Nothing

Desc: Pantograph Asset to attach to pantograph attachment points.

smoke_fastlife

Type: Decimal

Compulsory: No

Default: 0

Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'fast'.

smoke_fastspeed

Type: Decimal

Compulsory: No

Default: 10

Desc: Speed (m/s) at which traincar is considered to be moving 'fast'.

smoke_height

Type: Decimal

Compulsory: No

Default: 0.8

Desc: Additional speed for 'slow' smoke to make it drift higher from the traincar.

smoke_random

Type: Decimal

Compulsory: No

Default: 2.9

Desc: Controls the amount of randomness introduced into the direction of new smoke particles. Larger numbers mean more randomness.

smoke_shade

Type: Decimal

Compulsory: No

Default: 0.09

Desc: Value in the range (0.0 ... 1.0) which controls the color (including Alpha - so 0.0 will be transparent, 0.1 a dark mist, 1.0 a thick white) of each smoke particle. The alpha value will decay to zero (transparent) over the life of the particle.

smoke_slowlife

Type: Decimal

Compulsory: No

Default: 3

Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'slow'.

suspension-damping

Type: Float

Compulsory: No

Default: 0.3

Desc: Degree of suspension damping, where 0.0 to < 1.0 is under-damped (will oscillate back and forward to gradually settle), 1.0 is critically damped (will move back to equilibrium as quickly as possible), >1.0 is overdamped (will move back to equilibrium more slowly). Defaults to 0.3. The value must be positive.

suspension-stiffness

Type: Float

Compulsory: No

Default: 0.75

Desc: The stiffness of the suspension, from 0.0 to 1.0 where 0.0 is floppy and 1.0 is completely rigid. Defaults to 0.75.

suspension-pitch-limit

Type: Float

Compulsory: No

Default: 1.0

Desc: Maximum pitch angle of the vehicle, in degrees. Must be positive.

suspension-roll-limit

Type: Float

Compulsory: No

Default: 5

Desc: Maximum roll angle of the vehicle, in degrees. Must be positive.

tender

Type: Boolean

Compulsory: No

Default: 0 (False)

Desc: Used by the AI to determine if it should take this vehicle with the loco when doing orders like 'run round'.

use-coupler-sounds

Type: Boolean

Compulsory: No

Default: 1 (True)

Desc: Enables or disables the coupler slack sounds for this specific vehicle.

classification-signals

Type: classification-signals container

Compulsory: No

Default: Nothing

Desc: Lists the supported classification signals. Added in Trainz A New Era.

vehicle-running-numbers

Type: vehicle-running-numbers container

Compulsory: No

Default: Nothing

Desc: Defines the behaviour of automatic random running-number generation. Added in Trainz A New Era.

tunnelcamoffset

Type: Decimal Array

Compulsory: No

Default: 0,0,5

Desc: Defines the position of the camera, relative to the cab viewpoint, when the vehicle is travelling in a tunnel.

tail-lights

Type: tail-lights container

Compulsory: No

Default: Nothing

Desc: Lists the supported tail lights. Added in Trainz A New Era.

bogeys

Type: Bogeys Container

Compulsory: Yes (from 3.4)

Default: Nothing

Desc: Specifies what bogies are attached where, and with what modifiers. Documented separately here.

Obsolete Tags

The following tags will be recognised as valid in earlier builds, but obsolete for this build.

max_permitted_speed
bluestar_coupler
bluestar_brake
bluestar_multiple
bluestar_shell
bluestar_walk
bluestar_trainheat
origin
backlength
backpivot
frontlength
frontpivot
paintshed-template-used
paintshed-skin-used
real-engine

Attachment Point Usage

KIND Traincar assets have a variety of system-defined attachment points names.

mesh-table Usage

KIND Traincar assets have some system-defined "mesh-table" container names which are reserved for the following uses:

"default-night" - A regular mesh with this name will be shown in "night conditions" while the train headlights are active. No custom rendering effects are applied to this mesh. It is recommended that this mesh is set as "auto-create 0". You may wish to consider setting an emissive color on this mesh in your modelling software (eg. Max.)
"default-night-forward" - A regular mesh with this name will be shown when the forward-facing headlights are lit. No custom rendering effects are applied to this mesh. It is recommended that this mesh is set as "auto-create 0". You may wish to consider setting an emissive color on this mesh in your modelling software (eg. Max.)
"default-night-backward" - A regular mesh with this name will be shown when the backward-facing headlights are lit. No custom rendering effects are applied to this mesh. It is recommended that this mesh is set as "auto-create 0". You may wish to consider setting an emissive color on this mesh in your modelling software (eg. Max.)

Example Config.txt

Sample config.txt file for a traincar asset, with the Standard Tags excluded for brevity:

kind                   "traincar"
engine                 1
mass                   100000
max-tractive-effort    400000

max-coupler-gap        0.1

interior               <kuid:523:666>
enginespec             <kuid:-1:42004221>
enginesound            <kuid:-1:42003000>
hornsound              <kuid:-1:42003101>
pantograph             <kuid:-1:101395>

smoke_shade            0.3
smoke_random           2.5
smoke_slowlife         6
smoke_fastlife         0.8
smoke_height           1.7
smoke_fastspeed        1.6

fonts                  2
fonts-path             "traincar"
interior-light-texture "traincar-interior"
interior-light-color 0.75, 0.75, 0.75

mesh-table {
  default {
    mesh               "traincar-body.im"
    auto-create        1
  }
  shadow {
    mesh               "shadow\traincar-shadow.im"
  }
}

bogeys {
  0 {
    reversed           0
    rotation-permitted 0
    sideplay-permitted 0
    bogey              <KUID2:xxxxx:yyyyy:zzz>
  }
  1 {
    reversed           0
    bogey              <KUID2:xxxxx:yyyyy:zzz>
  }
  2 {
    reversed           0
    sideplay-permitted 1
    bogey              <KUID2:xxxxx:yyyyy:zzz>
  }
  3 {
    reversed           0
    sideplay-permitted 1
    bogey              <KUID2:xxxxx:yyyyy:zzz>
  }
}

company                "Company Name"
description            "Textual description of traincar in English"

Downloads

Media:SD40-2.zip - The MAX source for the Auran TS2009 SD40-2 traincar. Distributed from the TrainzDev site for education purposes only. No license for the reproduction or redistribution of the included model or textures is granted.

KIND Traincar

Contents

KIND Hierarchy

Parent Classes

Child Classes

Supported Tags

cabin_muffle

cabinsway

company

disable-extra-track-sounds

ditch_color

engine

enginesound

enginespec

flash_scale

fonts

fonts-path

high_beam_value

interior-light-texture

interior-light-color

hornsound

light_color

low_beam_value

mass

max-coupler-gap

max-tractive-effort

pantograph

smoke_fastlife

smoke_fastspeed

smoke_height

smoke_random

smoke_shade

smoke_slowlife

suspension-damping

suspension-stiffness

suspension-pitch-limit

suspension-roll-limit

tender

use-coupler-sounds

classification-signals

vehicle-running-numbers

tunnelcamoffset

tail-lights

bogeys

Obsolete Tags

Attachment Point Usage

mesh-table Usage

Example Config.txt

Downloads

Categories

Views

Personal tools

Navigation

Search

Toolbox