KIND Traincar

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Sorted tags to make easier to find. Moved obsolete tags to end (these should be removed?))
(→‎real-engine)
 
(58 intermediate revisions by 5 users not shown)
Line 3: Line 3:
  
 
This asset type inherits all trackside positioning and mesh display characteristics, and adds Vehicle-specific functionality such as physics and control mechanisms.
 
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==
 
==KIND Hierarchy==
Line 19: Line 21:
 
  low_beam_value 2,2,2
 
  low_beam_value 2,2,2
 
  high_beam_value 1,1,1
 
  high_beam_value 1,1,1
 +
interior-light-texture ""
 +
interior-light-color 0.0, 0.0, 0.0
 
  flash_scale 1
 
  flash_scale 1
 
  engine 0
 
  engine 0
Line 37: Line 41:
 
  smoke_height 0.8
 
  smoke_height 0.8
 
  smoke_fastspeed 10
 
  smoke_fastspeed 10
 +
suspension-stiffness 0.75
 +
suspension-damping 0.3
 +
suspension-pitch-limit 1.0
 +
suspension-roll-limit 5.0
 
  tender 0
 
  tender 0
 
  use-coupler-sounds 1
 
  use-coupler-sounds 1
 +
disable-extra-track-sounds 0
 +
max-tractive-effort 0
 
  fonts-path ""
 
  fonts-path ""
−
  [[Bogeys_container|bogeys]]
+
  [[vehicle-running-numbers_container|vehicle-running-numbers]]
 +
{
 +
}
 +
[[classification-signals_container|classification-signals]]
 +
{
 +
}
 +
[[bogeys_container|bogeys]]
 
  {
 
  {
 
  }
 
  }
−
disable-extra-track-sounds 0
 
−
max-tractive-effort 0
 
 
  origin "AU"                    (obsolete)
 
  origin "AU"                    (obsolete)
 
  paintshed-template-used (KUID) (obsolete)
 
  paintshed-template-used (KUID) (obsolete)
Line 52: Line 66:
 
  product-type ""                (obsolete)
 
  product-type ""                (obsolete)
 
   
 
   
−
 
−
 
−
====bogeys====
 
−
:Type: [[Bogeys_container|Bogeys Container]]
 
−
:Desc: Specifies what bogies are attached where, and with what modifiers. Documented separately [[Bogeys_container|here]].
 
  
 
====cabin_muffle====
 
====cabin_muffle====
 
:Type: Decimal
 
:Type: Decimal
−
: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. Note: Steam locos have a different default. They default to 1.0 - no muffling at all. (Steam loco cabs are very frequently not fully enclosed, let alone fitted with noise deadening material.)
+
: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====
 
====cabinsway====
 
:Type: Decimal
 
: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.
 
:Desc: Controls the amount of 'sway' the interior view has as the vehicle takes corners. A bigger number will result in more sway.
  
 
====company====
 
====company====
 
:Type: English Text String
 
: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.
 
:Desc: Text string to indicate which railway company or organisation this vehicle is in service with as represented.
  
 
====disable-extra-track-sounds====
 
====disable-extra-track-sounds====
 
:Type: Boolean
 
: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.
 
: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====
 
====ditch_color====
 
:Type: Color(RGB)
 
: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).
 
:Desc: Color of ditch lights (values are integer between 0 and 255, comma separated for red, green, and blue).
  
 
====engine====
 
====engine====
 
:Type: Boolean
 
: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.
 
: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====
 
====enginesound====
 
:Type: KUID
 
:Type: KUID
 +
:Compulsory: No
 +
:Default: Nothing
 
:Desc: [[KIND Enginesound|Enginesound Asset]] to use with this locomotive.
 
:Desc: [[KIND Enginesound|Enginesound Asset]] to use with this locomotive.
  
 
====enginespec====
 
====enginespec====
 
:Type: KUID
 
:Type: KUID
 +
:Compulsory: Yes
 
:Desc: [[KIND Engine|Enginespec Asset]] to use with this locomotive. Defines locomotive performance characteristics.
 
:Desc: [[KIND Engine|Enginespec Asset]] to use with this locomotive. Defines locomotive performance characteristics.
  
 
====flash_scale====
 
====flash_scale====
 
:Type: Decimal
 
:Type: Decimal
 +
:Compulsory: No
 +
:Default: 1
 
:Desc: Sets the speed that the ditch lights flash at.
 
:Desc: Sets the speed that the ditch lights flash at.
  
 
====fonts====
 
====fonts====
 
:Type: Integer
 
:Type: Integer
−
:Desc: Number of running-number fonts to use on this locomotive.
+
: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|Alpha Numbers]] for further information regarding Alpha Numbers (aka running-numbers) on traincars.
  
 
====fonts-path====
 
====fonts-path====
 
:Type: Text
 
:Type: Text
−
:Desc: Asset name to use when determining where running numbers are stored. Used in the same way 'asset-filename' used to be on v2.4 and earlier assets.
+
: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|Alpha Numbers]] for further information regarding Alpha Numbers (aka running-numbers) on traincars.
  
 
====high_beam_value====
 
====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|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
 
:Type: Decimal array
−
: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.
+
: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====
 
====hornsound====
 
:Type: KUID
 
:Type: KUID
−
:Desc: [[KIND Hornsound|Hornsound Asset]] to play when locos horn is blown.
+
:Compulsory: No
 +
:Default: Nothing
 +
:Desc: [[KIND Hornsound|Hornsound Asset]] to play when loco's horn is blown.
  
 
====light_color====
 
====light_color====
 
:Type: Color(RGB)
 
: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).
 
:Desc: Color of headlight (values are integer between 0 and 255, comma separated for red, green, and blue).
  
 
====low_beam_value====
 
====low_beam_value====
 
:Type: Decimal array
 
:Type: Decimal array
−
: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.
+
: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====
 
====mass====
 
:Type: Decimal
 
: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.
 
: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====
 
====max-coupler-gap====
 
:Type: decimal
 
: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.
 
: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====
 
====max-tractive-effort====
 
:Type: Decimal
 
: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.)
 
: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====
 
====pantograph====
 
:Type: KUID
 
:Type: KUID
 +
:Compulsory: No
 +
:Default: Nothing
 
:Desc: [[KIND Pantograph|Pantograph Asset]] to attach to pantograph attachment points.
 
:Desc: [[KIND Pantograph|Pantograph Asset]] to attach to pantograph attachment points.
−
 
−
====real-engine====
 
−
:Type: Boolean
 
−
:Desc: This will enable an unpowered vehicle to have an audible horn and visible headlights when set to 0. This is useful for cab cars, driving trailers, and unpowered end cars of multiple units.
 
  
 
====smoke_fastlife====
 
====smoke_fastlife====
 
:Type: Decimal
 
:Type: Decimal
 +
:Compulsory: No
 +
:Default: 0
 
:Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'fast'.
 
:Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'fast'.
  
 
====smoke_fastspeed====
 
====smoke_fastspeed====
 
:Type: Decimal
 
:Type: Decimal
 +
:Compulsory: No
 +
:Default: 10
 
:Desc: Speed (m/s) at which traincar is considered to be moving 'fast'.
 
:Desc: Speed (m/s) at which traincar is considered to be moving 'fast'.
  
 
====smoke_height====
 
====smoke_height====
 
:Type: Decimal
 
:Type: Decimal
 +
:Compulsory: No
 +
:Default: 0.8
 
:Desc: Additional speed for 'slow' smoke to make it drift higher from the traincar.
 
:Desc: Additional speed for 'slow' smoke to make it drift higher from the traincar.
  
 
====smoke_random====
 
====smoke_random====
 
:Type: Decimal
 
:Type: Decimal
−
:Desc: Controls the amount of randomness introduced into the direction of new smoke particles. Larger numbers == more randomness.
+
: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====
 
====smoke_shade====
 
:Type: Decimal
 
:Type: Decimal
−
: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.
+
: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====
 
====smoke_slowlife====
 
:Type: Decimal
 
:Type: Decimal
 +
:Compulsory: No
 +
:Default: 3
 
:Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'slow'.
 
: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====
 
====tender====
 
:Type: Boolean
 
: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'.
 
: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====
 
====use-coupler-sounds====
 
:Type: Boolean
 
:Type: Boolean
 +
:Compulsory: No
 +
:Default: 1 (True)
 
:Desc: Enables or disables the coupler slack sounds for this specific vehicle.
 
:Desc: Enables or disables the coupler slack sounds for this specific vehicle.
  
−
==Obsolete tags==
+
====classification-signals====
 +
:Type: [[classification-signals_container|classification-signals container]]
 +
:Compulsory: No
 +
:Default: Nothing
 +
:Desc: Lists the supported classification signals. Added in [[Trainz A New Era]].
  
−
====origin====
+
====vehicle-running-numbers====
−
:Type: Text
+
:Type: [[vehicle-running-numbers_container|vehicle-running-numbers container]]
−
:Desc: ''Obsolete''
+
:Compulsory: No
 +
:Default: Nothing
 +
:Desc: Defines the behaviour of automatic random running-number generation. Added in [[Trainz A New Era]].
  
−
====paintshed-template-used====
+
====tunnelcamoffset====
−
:Type: KUID
+
:Type: Decimal Array
−
:Desc: ''Obsolete''. Was KUID of paintshed template used to create this reskin - used by Paintshed to reload the reskin for further editing.
+
: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.
  
−
====paintshed-skin-used====
+
====tail-lights====
−
:Type: KUID
+
:Type: [[tail-lights_container|tail-lights container]]
−
:Desc: ''Obsolete''. Was KUID of paintshed skin used to create this reskin - used by Paintshed to reload the reskin for further editing.
+
:Compulsory: No
 +
:Default: Nothing
 +
:Desc: Lists the supported tail lights. Added in [[Trainz A New Era]].
  
−
====product-id====
+
====bogeys====
−
:Type: Text String
+
:Type: [[Bogeys_container|Bogeys Container]]
−
:Desc: ''Obsolete''. Was used by Paintshed to indicate that this asset was for use with paintshed.
+
:Compulsory: Yes (from 3.4)
 +
:Default: Nothing
 +
:Desc: Specifies what bogies are attached where, and with what modifiers. Documented separately [[Bogeys_container|here]].
  
−
====product-type====
+
==Obsolete Tags==
−
:Type: Text String
+
The following tags will be recognised as valid in earlier builds, but obsolete for this build.
−
:Desc: ''Obsolete''. Was used with Paintshed, to mark out a traincar as being repaintable in paintshed, but not for placement in-game.
+
* 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
  
−
====product-version====
 
−
:Type: Decimal
 
−
:Desc: ''Obsolete''. Was the version number of Paintshed that the model was intended to be used with.
 
  
 +
==Attachment Point Usage==
 +
[[KIND Traincar]] assets have a variety of [[Vehicle Attachment Points|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==
 
==Example Config.txt==
Line 221: Line 350:
 
  fonts                  2
 
  fonts                  2
 
  fonts-path            "traincar"
 
  fonts-path            "traincar"
 +
interior-light-texture "traincar-interior"
 +
interior-light-color 0.75, 0.75, 0.75
 
   
 
   
 
  [[%22mesh-table%22_Container|mesh-table]] {
 
  [[%22mesh-table%22_Container|mesh-table]] {

Latest revision as of 16:33, 25 September 2018

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.

Contents

[edit] KIND Hierarchy

[edit] Parent Classes

[edit] Child Classes

  • none.

[edit] 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)

[edit] 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).

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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).

[edit] 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.

[edit] enginesound

Type: KUID
Compulsory: No
Default: Nothing
Desc: Enginesound Asset to use with this locomotive.

[edit] enginespec

Type: KUID
Compulsory: Yes
Desc: Enginespec Asset to use with this locomotive. Defines locomotive performance characteristics.

[edit] flash_scale

Type: Decimal
Compulsory: No
Default: 1
Desc: Sets the speed that the ditch lights flash at.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.

[edit] hornsound

Type: KUID
Compulsory: No
Default: Nothing
Desc: Hornsound Asset to play when loco's horn is blown.

[edit] 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).

[edit] 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.

[edit] 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.

[edit] 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.

[edit] 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.)

[edit] pantograph

Type: KUID
Compulsory: No
Default: Nothing
Desc: Pantograph Asset to attach to pantograph attachment points.

[edit] smoke_fastlife

Type: Decimal
Compulsory: No
Default: 0
Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'fast'.

[edit] smoke_fastspeed

Type: Decimal
Compulsory: No
Default: 10
Desc: Speed (m/s) at which traincar is considered to be moving 'fast'.

[edit] smoke_height

Type: Decimal
Compulsory: No
Default: 0.8
Desc: Additional speed for 'slow' smoke to make it drift higher from the traincar.

[edit] 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.

[edit] 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.

[edit] smoke_slowlife

Type: Decimal
Compulsory: No
Default: 3
Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'slow'.

[edit] 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.

[edit] 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.

[edit] suspension-pitch-limit

Type: Float
Compulsory: No
Default: 1.0
Desc: Maximum pitch angle of the vehicle, in degrees. Must be positive.

[edit] suspension-roll-limit

Type: Float
Compulsory: No
Default: 5
Desc: Maximum roll angle of the vehicle, in degrees. Must be positive.

[edit] 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'.

[edit] use-coupler-sounds

Type: Boolean
Compulsory: No
Default: 1 (True)
Desc: Enables or disables the coupler slack sounds for this specific vehicle.

[edit] classification-signals

Type: classification-signals container
Compulsory: No
Default: Nothing
Desc: Lists the supported classification signals. Added in Trainz A New Era.

[edit] 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.

[edit] 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.

[edit] tail-lights

Type: tail-lights container
Compulsory: No
Default: Nothing
Desc: Lists the supported tail lights. Added in Trainz A New Era.

[edit] 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.

[edit] 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


[edit] Attachment Point Usage

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

[edit] 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.)

[edit] 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"

[edit] 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.


[edit] Categories

Retrieved from "https://game.ts2009.com/mediaWiki/index.php?title=KIND_Traincar&oldid=16467"
Personal tools