TrainzOnline - User contributions [en]

KIND Enginesound

2009-03-19T02:16:57Z

Bloodnok: /* speedup */

[[KIND Enginesound]] assets are locomotive enginesounds.

There are three types - Diesel, Electric, and Steam.

Diesel enginesounds are formed of a number of separate wave files. These are 'steady state' sounds (one for each runlevel from 1 up to 8) and 'transition' sounds (used when going between one runlevel and the next one up, or next one down).

Electric enginesounds play one wave file, but pitch shift it to produce a continuously variable sound linked to the speed of the train. (Note: If your electric needs it's enginesound linked to throttle position rather than train speed, it's better to use a 'diesel' style 'ramping' sound).

Steam enginesounds play a number of individual 'chuff' files at low speed, and switch to a series of pitch-shifted loop sounds at higher speeds.

Random note: How does Trainz know that a specific enginesound is a 'steam' enginesound? Because it's tagged for use on a steam loco...

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "enginesound"
speedup 2.2
isramping 1
isfading 0
number-slow-sounds 4
number-cylinders 2
number-power-strokes 2

====speedup====
:Type: Decimal
:Desc: Controls the rate of pitch change for an electric type enginesound. A value of 1.0 would mean the top frequency used is as much again as the base frequency - in other words, the frequency of the sound played would double over the speed range of the vehicle.

====isramping====
:Type: Boolean
:Desc: 'Ramping' diesel enginesounds have transition sounds between each level state.

====isfading====
:Type: Boolean
:Desc: For diesel engine sounds, 'fading' sounds do not have transition sounds between each level state - instead, one sound is faded into the next to 'fake' a transition. For electric enginesounds, 'fading' sounds are quieter at low speed and louder at high speed - whereas 'non-fading' sounds are more constant across the speed range.

====number-slow-sounds====
:Type: Integer
:Desc: Number of 'chuff' sounds available in a steam enginesound.

====number-cylinders====
:Type: Integer
:Desc: Number of cylinders in the locomotive the steam sound was recorded from.

====number-power-strokes====
:Type: Integer
:Desc: Number of power strokes in the locomotive the steam enginesound was recorded from (should generally be left at the default, 2).

==Example Config.txt==
====Diesel====
Sample [[config.txt file]] for a diesel type 'enginesound' asset, with the Standard Tags excluded for brevity:

kind "enginesound"
isramping 1
isfading 0

====Electric====
Sample [[config.txt file]] for an electric type 'enginesound' asset, with the Standard Tags excluded for brevity:

kind "enginesound"
isramping 0
isfading 0
speedup 4.0

====Steam====
Sample [[config.txt file]] for a steam type 'enginesound' asset, with the Standard Tags excluded for brevity:

kind "enginesound"
number-slow-sounds 4
number-cylinders 2
number-power-strokes 2

==Wave file naming==
====Diesel====
In a 'fading' diesel enginesound, the following sound files are used:

idle 1.wav (engine idle / notch 1 sound)
idle 2.wav (notch 2 sound)
idle 3.wav (notch 3 sound)
idle 4.wav (notch 4 sound)
idle 5.wav (notch 5 sound)
idle 6.wav (notch 6 sound)
idle 7.wav (notch 7 sound)
idle 8.wav (notch 8 sound)

In a 'ramping' diesel enginesound, the following ''additional'' sound files are also used:

start.wav (engine startup)
stop.wav (engine shutdown)
up 1 - 2.wav (transition between notch 1 and notch 2)
up 2 - 3.wav (transition between notch 2 and notch 3)
up 3 - 4.wav (transition between notch 3 and notch 4)
up 4 - 5.wav (transition between notch 4 and notch 5)
up 5 - 6.wav (transition between notch 5 and notch 6)
up 6 - 7.wav (transition between notch 6 and notch 7)
up 7 - 8.wav (transition between notch 7 and notch 8)
down 2 - 1.wav (transition between notch 2 and notch 1)
down 3 - 2.wav (transition between notch 3 and notch 2)
down 4 - 3.wav (transition between notch 4 and notch 3)
down 5 - 4.wav (transition between notch 5 and notch 4)
down 6 - 5.wav (transition between notch 6 and notch 5)
down 7 - 6.wav (transition between notch 7 and notch 6)
down 8 - 7.wav (transition between notch 8 and notch 7)

====Electric====

The one sound file for an electric engine is named engine_loop.wav.

====Steam====

loco_stationary_fast.wav
loco_stationary_med.wav
loco_stationary_slow.wav

These are background sounds for when the loco is stationary. The fast will be played when the loco has just stopped, and if it is left for a while, the sound will progress down to 'med' and then eventually 'slow'.

piston_stroke1.wav
piston_stroke2.wav
piston_stroke3.wav
piston_stroke4.wav

... and on up to the number specified in the 'number-slow-sounds' tag. These sounds are the low speed 'chuff' sounds.

smoke_stack_hiss.wav

This is a background hiss noise that appears to be played continually.

steam_loop_30RPM.wav
steam_loop_35RPM.wav
steam_loop_40RPM.wav
steam_loop_50RPM.wav
steam_loop_60RPM.wav
steam_loop_75RPM.wav
steam_loop_90RPM.wav
steam_loop_100RPM.wav
steam_loop_125RPM.wav
steam_loop_150RPM.wav
steam_loop_175RPM.wav
steam_loop_200RPM.wav
steam_loop_250RPM.wav
steam_loop_300RPM.wav
steam_loop_350RPM.wav
steam_loop_400RPM.wav
steam_loop_500RPM.wav
steam_loop_600RPM.wav
steam_loop_700RPM.wav
steam_loop_800RPM.wav
steam_loop_1000RPM.wav
steam_loop_1200RPM.wav
steam_loop_1400RPM.wav
steam_loop_1600RPM.wav
steam_loop_2000RPM.wav

These loops are played as the loco picks up speed. They are individually stretched or squashed in length (also incurring pitch shifting in the process) to match the wheel rotation speed so the audible 'chuffs' within the loop maintain synchronisation with the drive bogie animation.

It should be noted that unlike the earlier steam loop, which was based on track speed, rather than wheel rotation speed, this system enables sound files to be shared between locomotives with different wheel sizes. 30RPM on a 2 cylinder loco will produce one chuff per second irrespective of wheel size - the only difference this makes is what speed the train will be doing when the loco is running at 30RPM.

Any individual file can be omitted from this set - the system will use what files are available and use adjacent files to cover for any missing files.

It is anticipated that a sound creator will pick and choose which wave files are used based on what recordings are available, and that a released enginespec will not have all sound files present - particularly the higher speed ones, which are likely to be irrelevant for most locos, but are provided just in case...

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND Hornsound

2009-01-07T00:28:45Z

Bloodnok:

[[KIND Hornsound]] assets are horn or whistle sounds for locomotives.

For a single part horn sound, the horn sound should be named 'horn.wav', and the bell sound 'idle 1.wav'.

For a two part horn sound, the lead-in sound should be named 'horn_start.wav', the loop should be named 'horn_loop.wav', and the bell 'idle 1.wav'.

For a three part hornsound, the sounds for the horn are placed in a subdirectory called 'horn'. The lead-in sound should be named 'start.wav', the loop should be named 'idle 1.wav' and the lead-out sound should be named 'stop.wav'. The bell sound is as for a single part or two part horn.

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "hornsound"
two-part 0
three-part 0

====two-part====
:Type: Boolean
:Desc: Hornsound is two-part.

====three-part====
:Type: Boolean
:Desc: Hornsound is three-part.

==Example Config.txt==
Sample [[config.txt file]] for a Tracksound asset, with the Standard Tags excluded for brevity:

kind "hornsound"
two-part 1
three-part 0

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND Traincar

2009-01-06T03:10:59Z

Bloodnok:

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

==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
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
origin "AU"
pantograph (KUID)
smoke_shade 0.09
smoke_random 2.9
smoke_slowlife 3
smoke_fastlife 0
smoke_height 0.8
smoke_fastspeed 10
tender 0
use-coupler-sounds 1
fonts-path ""
[[Bogeys_container|bogeys]]
{
}
paintshed-template-used (KUID)
paintshed-skin-used (KUID)
product-id ""
product-version ?
product-type ""
disable-extra-track-sounds 0
max-tractive-effort 0

====cabinsway====
:Type: Decimal
: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
:Desc: Text string to indicate which railway company or organisation this vehicle is in service with as represented.
====ditch_color====
:Type: Colour(RGB)
:Desc: Colour of ditch lights (values are integer between 0 and 255, comma separated for red, green, and blue).
====low_beam_value====
: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.
====high_beam_value====
: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.
====flash_scale====
:Type: Decimal
:Desc: Sets the speed that the ditch lights flash at.
====engine====
:Type: Boolean
: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.
====real-engine====
:Type: Boolean
:Desc: ''TBD''
====enginespec====
:Type: KUID
:Desc: [[KIND Engine|Enginespec Asset]] to use with this locomotive. Defines locomotive performance characteristics.

====enginesound====
:Type: KUID
:Desc: [[KIND Enginesound|Enginesound Asset]] to use with this locomotive.
====fonts====
:Type: Integer
:Desc: Number of running-number fonts to use on this locomotive.
====hornsound====
:Type: KUID
:Desc: [[KIND Hornsound|Hornsound Asset]] to play when locos horn is blown.
====cabin_muffle====
: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.)
====light_color====
:Type: Colour(RGB)
:Desc: Colour of headlight (values are integer between 0 and 255, comma separated for red, green, and blue).
====mass====
:Type: Decimal
: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
: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.
====origin====
:Type: Text
:Desc: ''Obsolete''
====pantograph====
:Type: KUID
:Desc: [[KIND Pantograph|Pantograph Asset]] to attach to pantograph attachment points.
====smoke_shade====
:Type: Decimal
:Desc: Value in the range (0.0 .. 1.0) which controls the colour (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_random====
:Type: Decimal
:Desc: Controls the amount of randomness introduced into the direction of new smoke particles. Larger numbers == more randomness.
====smoke_slowlife====
:Type: Decimal
:Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'slow'.
====smoke_fastlife====
:Type: Decimal
:Desc: Length of time (seconds) smoke particles will exist for when vehicle is moving 'fast'.
====smoke_height====
:Type: Decimal
:Desc: Additional speed for 'slow' smoke to make it drift higher from the traincar.
====smoke_fastspeed====
:Type: Decimal
:Desc: Speed (m/s) at which traincar is considered to be moving 'fast'.
====tender====
:Type: Boolean
: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
:Desc: Enables or disables the coupler slack sounds for this specific vehicle.
====fonts-path====
: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.
====bogeys====
:Type: [[Bogeys_container|Bogeys Container]]
:Desc: Specifies what bogies are attached where, and with what modifiers. Documented separately [[Bogeys_container|here]].
====paintshed-template-used====
:Type: KUID
:Desc: ''Obsolete''. Was KUID of paintshed template used to create this reskin - used by Paintshed to reload the reskin for further editing.
====paintshed-skin-used====
:Type: KUID
:Desc: ''Obsolete''. Was KUID of paintshed skin used to create this reskin - used by Paintshed to reload the reskin for further editing.
====product-id====
:Type: Text String
:Desc: ''Obsolete''. Was used by Paintshed to indicate that this asset was for use with paintshed.
====product-version====
:Type: Decimal
:Desc: ''Obsolete''. Was the version number of Paintshed that the model was intended to be used with.
====product-type====
:Type: Text String
:Desc: ''Obsolete''. Was used with Paintshed, to mark out a traincar as being repaintable in paintshed, but not for placement in-game.

====disable-extra-track-sounds====
:Type: Boolean
: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.
====max-tractive-effort====
:Type: Decimal
: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.)

==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"

[[%22mesh-table%22_Container|mesh-table]] {
default {
mesh "traincar-body.im"
auto-create 1
}
shadow {
mesh "shadow\traincar-shadow.im"
}
}

[[Bogeys_container|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.

==Categories==
[[Category:Asset KIND]]

KIND Steam-engine

2008-12-19T05:39:06Z

Bloodnok:

[[KIND Steam-engine]] assets contain steam loco engine performance characteristics.

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "steam-engine"
[[throttle-power_container|throttle-power]]
{
}
[[dynamic-brake_container|dynamic-brake]]
{
}
[[pressure_container|pressure]]
{
}
[[mass_container|mass]]
{
}
[[motor_container|motor]]
{
}
[[flowsize_container|flowsize]]
{
}
[[volume_container|volume]]
{
}
[[steam_container|steam]]
{
}
[[steam-power_container|steam-power]]
{
}
scale ""

====throttle-power====
:Type: [[throttle-power_container|throttle-power Container]]
:Desc: ''Not used on steam locos''

====dynamic-brake====
:Type: [[dynamic-brake_container|dynamic-brake Container]]
:Desc: ''Not used on steam locos''

====pressure====
:Type: [[pressure_container|pressure Container]]
:Desc:

====mass====
:Type: [[mass_container|mass Container]]
:Desc:

====motor====
:Type: [[motor_container|motor Container]]
:Desc:

====flowsize====
:Type: [[flowsize_container|flowsize Container]]
:Desc:

====volume====
:Type: [[volume_container|volume Container]]
:Desc:

====steam====
:Type: [[steam_container|steam Container]]
:Desc:

====steam-power====
:Type: [[steam-power_container|steam-power Container]]
:Desc: ''No longer used''

====scale====
:Type: Obsolete
:Desc: Obsolete

==Example Config.txt==
Sample [[config.txt file]] for a steam enginespec asset, with the Standard Tags excluded for brevity:

''TBD''

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

"Dynamic-brake" container

2008-12-19T05:36:34Z

Bloodnok:

The Dynamic-brake container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] assets.

==Supported Tags==

The Dynamic-brake container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.

Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a braking force (kN) value. Together, these points define a braking force graph for a specific throttle notch.

==Example dynamic-brake container==

Here is an example dynamic-brake container. (Several notches have been omitted - the format is identical throughout).

dynamic-brake
{
0
{
0 0
}

1
{
1.333 0
2 30
5 25
10 15
12 0
}

2
{
1.333 0
3 50
10 35
14 20
15 0
}

....

7
{
1.333 0
5 250
10 100
32 60
36 0
}

8
{
1.33 0
5 250
10 100
36 50
40 0
}
}

Note that the graph is clamped to zero at a low speed - dynamic brakes are only effective in specific speed ranges, and become ineffective at low speed.

[[Category:Config Container]]

"Throttle-power" container

2008-12-19T05:32:20Z

Bloodnok:

The Throttle-power container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] assets.

==Supported Tags==

The Throttle-power container has a sequence of numeric subcontainers. Each one refers to a specific throttle notch.

Within each subcontainer, there are a series of numeric named lines. Each line specifies a speed (m/s) and a tractive effort (kN) value. Together, these points define a tractive effort graph for a specific throttle notch.

==Example throttle-power container==

Here is an example throttle-power container. (Several notches have been omitted for brevity - the format is identical throughout).

throttle-power
{
0
{
0 0
}

1
{
0 165
2.2 83
4.4 55
6.6 41
8.8 33
13.0 0
}

....

8
{
0 1320
2.2 800
4.4 750
5.5 700
6.6 480
8.8 250
11.25 200
13.3 195
28.5 190
30.0 26
31.0 0
}
}

Note that the high notch values are way beyond what the loco can actually put into the track at low speed - this loco cannot be opened up to full throttle at very low speeds, otherwise it's wheels will slip. The max tractive effort it can put into the rails before slipping is configured in the loco config file - the reason for this is that the weight of the loco (also set in the loco config file) will affect this value.

[[Category:Config Container]]

"Motor" container

2008-12-19T05:23:40Z

Bloodnok:

The Motor container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] and [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Motor container supports the following tags. Each tag is show here with its default value.

motor
{
resistance 1.7
adhesion 5.0
maxvoltage 600.0
maxspeed 33.3
brakeratio 55000
max-accel 3500
max-decel 9000
throttle-notches 8
axle-count 6
surface-area 80.0
moving-friction-coefficient 0.03
air-drag-coefficient 0.00017
full-throttle-speed 33.0
driving-wheel-weight-ratio 1.0
}

====resistance====
:Type: Decimal
:Desc: ''Not used''

====adhesion====
:Type: Decimal
:Desc: ''Not used''

====maxvoltage====
:Type: Decimal
:Desc: Voltage to ''traction motors''. This is used to scale the ammeter displayed in the cab. (Power is volts times amps - increasing the voltage means reducing the ammeter...)

====maxspeed====
:Type: Decimal
:Desc: Maximum speed in DCC mode.

====brakeratio====
:Type: Decimal
:Desc:

====max-accel====
:Type: Decimal
:Desc: Accelerative force available in DCC mode. Note - this is a force, not a rate of acceleration. The rate of acceleration will depend on the mass of the train as well.

====max-decel====
:Type: Decimal
:Desc: Decelerative force available in DCC mode. Note - this is a force, not a rate of deceleration. The rate of deceleration will depend on the mass of the train as well.

====throttle-notches====
:Type: Integer
:Desc: Number of throttle notches

====axle-count====
:Type: Integer
:Desc: Number of axles on this vehicle. Used in rolling resistance calculations.

====surface-area====
:Type: Decimal
:Desc: frontal surface area (sq ft) of vehicle. Used in air resistance calculations.

====moving-friction-coefficient====
:Type: Decimal
:Desc: Used in rolling resistance calculations.

====air-drag-coefficient====
:Type: Decimal
:Desc: Used in air resistance calculations.

====full-throttle-speed====
:Type: Decimal
:Desc:

====driving-wheel-weight-ratio====
:Type: Decimal
:Desc: Ratio (between 0.0 and 1.0) of the weight of this vehicle bearing down on driven wheels. Used by steam locos only.

==Example motor container==

''TBD''

[[Category:Config Container]]

"Pressure" container

2008-12-19T05:04:30Z

Bloodnok:

The Pressure container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] and [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Pressure container supports the following tags. Each tag is show here with its default value.

pressure
{
scale 1.0
compressor 0.00946941
mainreservoir 0.00946941
highspeedexhauster 0.0
brakepipe 0.00595441
brakeinitial 0.00560291
brakefull 0.00398601
indbrakefull 0.00398601
trainbrakepipe_start 0.00440781
epreservoirpipe_start 0.0
no3pipe_start 0.0
no4pipe_start 0.0
auxreservoir_start 0.00504051
autobrakecylinder_start 0.00489991
vacuumbrakepipe_start 0.0
vacuumbrakereservoir_start 0.0
vacuumbrakecylinder_start 0.0
mainreservoir_start 0.00876641
equaliser_start 0.00440781
independantbrakecylinder_start 0.00489991
}

====scale====
:Type: Decimal
:Desc:

====compressor====
:Type: Decimal
:Desc:

====mainreservoir====
:Type: Decimal
:Desc:

====highspeedexhauster====
:Type: Decimal
:Desc:

====brakepipe====
:Type: Decimal
:Desc:

====brakeinitial====
:Type: Decimal
:Desc:

====brakefull====
:Type: Decimal
:Desc:

====indbrakefull====
:Type: Decimal
:Desc:

====trainbrakepipe_start====
:Type: Decimal
:Desc:

====epreservoirpipe_start====
:Type: Decimal
:Desc:

====no3pipe_start====
:Type: Decimal
:Desc:

====no4pipe_start====
:Type: Decimal
:Desc:

====auxreservoir_start====
:Type: Decimal
:Desc:

====autobrakecylinder_start====
:Type: Decimal
:Desc:

====vacuumbrakepipe_start====
:Type: Decimal
:Desc:

====vacuumbrakereservoir_start====
:Type: Decimal
:Desc:

====vacuumbrakecylinder_start====
:Type: Decimal
:Desc:

====mainreservoir_start====
:Type: Decimal
:Desc:

====equaliser_start====
:Type: Decimal
:Desc:

====independantbrakecylinder_start====
:Type: Decimal
:Desc:

==Example pressure container==

''TBD''

[[Category:Config Container]]

"Volume" container

2008-12-19T04:57:56Z

Bloodnok:

The Volume container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] and [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Volume container supports the following tags. Each tag is show here with its default value.

volume
{
scale 1.0
trainbrakepipe 0.2
epreservoirpipe 0.2
no3pipe 0.2
no4pipe 0.2
auxreservoir 0.0384678
autobrakecylinder 0.00969387
vacuumbrakepipe 0.0
vacuumbrakereservoir 0.0
vacuumbrakecylinder 0.0
mainreservoir 1.0
equaliser 0.5
independantbrakecylinder 0.0103239
}

====scale====
:Type: Decimal
:Desc:

====trainbrakepipe====
:Type: Decimal
:Desc:

====epreservoirpipe====
:Type: Decimal
:Desc:

====no3pipe====
:Type: Decimal
:Desc:

====no4pipe====
:Type: Decimal
:Desc:

====auxreservoir====
:Type: Decimal
:Desc:

====autobrakecylinder====
:Type: Decimal
:Desc:

====vacuumbrakepipe====
:Type: Decimal
:Desc:

====vacuumbrakereservoir====
:Type: Decimal
:Desc:

====vacuumbrakecylinder====
:Type: Decimal
:Desc:

====mainreservoir====
:Type: Decimal
:Desc:

====equaliser====
:Type: Decimal
:Desc:

====independantbrakecylinder====
:Type: Decimal
:Desc:

==Example volume container==

''TBD''

[[Category:Config Container]]

"Flowsize" container

2008-12-19T04:51:19Z

Bloodnok:

The Flowsize container is a top-level [[config.txt file]] entry used by [[KIND Engine|Enginespec]] and [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Flowsize container supports the following tags. Each tag is show here with its default value.

flowsize
{
trainbrakepipe 170000
epreservoirpipe 0.1
no3pipe 0.1
no4pipe 0.1
auxreservoirvent 0.1
auxreservoir_no3 0.1
auxreservoir_trainbrakepipe 0.1
autobrakecylindervent 0.1
equaliser_mainreservoir 0.06
equaliservent 0.06
equaliserventhandleoff 0.1
equaliserventemergency 0.1
no3pipevent 1.5
no3pipe_mainreservoir 0.1
compressor 5
trainbrakepipe_reservoir 1
trainbrakepipevent 0.06
no3pipe_autobrakecylinder 0.1
epreservoirpipe_autobrakecylinder 0.1
mainreservoir_ep 0.1
vacuumbrakepipe 0.1
vacuumbrakepipereleasevent 0.1
vacuumbrakepipevent 0.1
vacuumbrakereservoir_vacuumbrakepipe 0.1
vacuumbrakecylinder_vacuumbrakepipe 0.1
highspeedexhauster_vacuumbrakepipe 0.1
}

====trainbrakepipe====
:Type: Decimal
:Desc:

====epreservoirpipe====
:Type: Decimal
:Desc:

====no3pipe====
:Type: Decimal
:Desc:

====no4pipe====
:Type: Decimal
:Desc:

====auxreservoirvent====
:Type: Decimal
:Desc:

====auxreservoir_no3====
:Type: Decimal
:Desc:

====auxreservoir_trainbrakepipe====
:Type: Decimal
:Desc:

====autobrakecylindervent====
:Type: Decimal
:Desc:

====equaliser_mainreservoir====
:Type: Decimal
:Desc:

====equaliservent====
:Type: Decimal
:Desc:

====equaliserventhandleoff====
:Type: Decimal
:Desc:

====equaliserventemergency====
:Type: Decimal
:Desc:

====no3pipevent====
:Type: Decimal
:Desc:

====no3pipe_mainreservoir====
:Type: Decimal
:Desc:

====compressor====
:Type: Integer
:Desc:

====trainbrakepipe_reservoir====
:Type: Integer
:Desc:

====trainbrakepipevent====
:Type: Decimal
:Desc:

====no3pipe_autobrakecylinder====
:Type: Decimal
:Desc:

====epreservoirpipe_autobrakecylinder====
:Type: Decimal
:Desc:

====mainreservoir_ep====
:Type: Decimal
:Desc:

====vacuumbrakepipe====
:Type: Decimal
:Desc:

====vacuumbrakepipereleasevent====
:Type: Decimal
:Desc:

====vacuumbrakepipevent====
:Type: Decimal
:Desc:

====vacuumbrakereservoir_vacuumbrakepipe====
:Type: Decimal
:Desc:

====vacuumbrakecylinder_vacuumbrakepipe====
:Type: Decimal
:Desc:

====highspeedexhauster_vacuumbrakepipe====
:Type: Decimal
:Desc:

==Example flowsize container==

''TBD''

[[Category:Config Container]]

KIND Engine

2008-12-18T04:23:34Z

Bloodnok:

[[KIND Engine]] assets contain diesel or electric loco engine performance characteristics.

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "engine"
[[throttle-power_container|throttle-power]]
{
}
[[dynamic-brake_container|dynamic-brake]]
{
}
[[pressure_container|pressure]]
{
}
[[mass_container|mass]]
{
}
[[motor_container|motor]]
{
}
[[flowsize_container|flowsize]]
{
}
[[volume_container|volume]]
{
}
scale ""
epbrakes ""

====throttle-power====
:Type: [[throttle-power_container|throttle-power Container]]
:Desc:

====dynamic-brake====
:Type: [[dynamic-brake_container|dynamic-brake Container]]
:Desc:

====pressure====
:Type: [[pressure_container|pressure Container]]
:Desc:

====mass====
:Type: [[mass_container|mass Container]]
:Desc:

====motor====
:Type: [[motor_container|motor Container]]
:Desc:

====flowsize====
:Type: [[flowsize_container|flowsize Container]]
:Desc:

====volume====
:Type: [[volume_container|volume Container]]
:Desc:

====scale====
:Type: Obsolete
:Desc: Obsolete

====epbrakes====
:Type: Obsolete
:Desc: Obsolete

==Example Config.txt==
Sample [[config.txt file]] for an enginespec asset, with the Standard Tags excluded for brevity:

''TBD''

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

"Levels" container

2008-12-17T23:49:53Z

Bloodnok:

The Levels container is a top-level [[config.txt file]] entry used by [[KIND Tracksound|Tracksound]] assets.

==Supported Tags==
The levels container has a series of numeric tags in strict ascending sequence, starting with zero. These correspond to the "idle ''n''.wav" sound files in the asset. Each takes a decimal number, which is the maximum speed (in metres per second) that the wave file will be played at - beyond that, the next one up will be used.

==Example levels container==

levels {
0 0.1
1 5.0
2 10.0
3 20.0
}

This will not play a sound below 0.1m/s, play "idle 1.wav" between 0.1m/s and 5.0m/s, play "idle 2.wav" between 5.0m/s and 10.0m/s, play "idle 3.wav" between 10.0m/s, and play "idle 4.wav" above 20.0m/s.

[[Category:Config Container]]

KIND Tracksound

2008-12-17T23:43:07Z

Bloodnok:

[[KIND Tracksound]] assets are configurable tracksounds (that is, the rail-wheel 'whoosh' noise, not the 'clickety-clack' noise). They can be tagged onto track splines to change the character of the sound depending on location - e.g. tunnels and bridges using a different sound to plain track.

Wave files are to be named similar to a diesel enginesound - e.g. 'idle 1.wav', 'idle 2.wav', etc, etc.

How many wave files there are, and when to switch between them, is defined by the [[levels_container|'levels' container]].

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "tracksound"
[[levels_container|levels]]
{
}
min-distance 0
max-distance 0

====levels====
:Type: [[levels_container|Levels Container]]
:Desc: Controls when to switch between different wave files.

====min-distance====
:Type: Decimal
:Desc: Distance from source to observer in metres within which the sound is played at maximum volume

====max-distance====
:Type: Decimal
:Desc: Distance from source to observer in metres outside which the sound is not heard at all

==Example Config.txt==
Sample [[config.txt file]] for a Tracksound asset, with the Standard Tags excluded for brevity:

kind "tracksound"
[[levels_container|levels]] {
0 0.1
1 10
}
min-distance 10
max-distance 300

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

"Driver-settings" container

2008-12-17T23:28:24Z

Bloodnok:

The driver-settings container is a top-level [[config.txt file]] entry used by [[KIND Activity|Scenarios]].

=Supported Tags=
The driver-settings container supports the following tags. Each tag is shown here with its default value.

autopilotmode 0
startingtime 0.0
timerate 1
deraillevel 0
showhelp 0
controlmethod 0
weather 0
changeability 0

====autopilotmode====
:Type: Choice
:Desc: Controls whether non-player controlled trains are automatically driven by an autopilot, or controlled by the scenario script.

0 - script controlled
1 - autopilot controlled

====startingtime====
:Type: Decimal
:Desc: A value between 0.0 to 1.0, representing the time of day between 12:00 noon on one day and 12:00 noon on the next day. A value of 0.125 would be 3pm, and a value of 0.75 would be 6am.

====timerate====
:Type: Choice
:Desc: How fast should the game clock run compared to real time?

0 = 1x
1 = 2x
2 = 4x
3 = 8x
4 = 16x
5 = 32x
6 = 60x
7 = 120x
8 = 240x
9 = 360x
10 = 480x
11 = 720x
12 = 960x
13 = 1200x
14 = 1440x

====deraillevel====
:Type: Choice
:Desc: Three 'derailment realism' options are available - 0 (none), 1 (arcade) and 2 (realistic). This controls how much overspeed the trains must be when cornering before they will derail. It does not affect derailments caused by running off the end of the track, or as a result of the traincars being pulled apart too far (e.g. when splitting a switch, or trailing one that is too sharp to be trailed).

====showhelp====
:Type: Boolean
:Desc: Sets whether or not to display the on screen help overlay (i.e. the junction direction arrows).

====controlmethod====
:Type: Choice
:Desc: Which control method should the scenario be played in?

0 = DCC mode
1 = Cab mode

====weather====
:Type: Choice
:Desc: What weather type should the scenario start with?

0 = clear
1 = cloudy
2 = drizzle
3 = rain
4 = stormy
5 = light snow
6 = medium snow
7 = heavy snow

====changeability====
:Type: Choice
:Desc: How changeable should the weather be in the scenario?

0 = none
1 = periodic
2 = extreme

[[Category:Config Container]]

KIND Drivercommand

2008-12-17T22:59:11Z

Bloodnok:

[[KIND Drivercommand]] assets are AI orders for use in sessions.

==KIND Hierarchy==
===Parent Classes===
* ''none.''
===Child Classes===
* ''none.''

==Supported Tags==

kind "drivercommand"
supports-null-driver-character 0

====supports-null-driver-character====
:Type: Boolean
:Desc: Order is written in such a way that it can be issued with a null driver character. If this is true, the order can be issued in surveyor.

==Example Config.txt==
''TBD''

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND MOSignal

2008-12-17T22:48:29Z

Bloodnok: /* Custom Logic */

''Warning: This page is a work in progress and any details or metrics included here may be subject to change as TS2009 development continues.''

Classics 3 introduced an updated Signalling system, which is being extended further for TS2009.

Config entries specific to signals are:

[[TagName_Kind|kind]] mosignal
[[TagName_Type|type]] Trackside
[[TagName_Function|function]] TrackSignal
[[TagName_Trainz-build|trainz-build]] 2.8
[[TagName_Distant|distant]] 0
[[TagName_Home|home]] 0
[[TagName_Repeater|repeater]] 0
[[TagName_Always-controlled|always-controlled]] 0
[[TagName_Double-blocking|double-blocking]] 0
[[TagName_Overlap|overlap]] 183
[[TagName_Overlap-track-circuited|overlap-track-circuited]] 1
[[%22Signals%22_container|signals]] {
1 {
light 2
speed 6.71
}
4 {
light 1
}
7 {
light 1
flash 1
flash-offset 0
}
8 {
light 0
}
}
[[%22Lights%22_container|lights]] {
0 {
corona "corona_green.tga"
}
1 {
corona "corona_yellow.tga"
}
2 {
corona "corona_red.tga"
}
}

===Notes on the default signalling logic===

The signalling system now knows about, and uses, a lot more states than it did previously. This means you have to be a lot more careful of including the correct states in your signals than you did before.

If a signal is supposed to be permissive, include state '1' rather than state '0'. The Autopilot will now treat it as a permissive signal, and drive past it, queueing up behind the train in the next section.

A distant signal should not include state '0' or '1' at all.

A fixed distant can be made by specifying 'distant 1' and including only state '4'. All trains approaching (whether the line ahead is clear or not) will slow down when approaching it.

A repeater should not show state '0' - use state '1' for this instead, otherwise the Autopilot will stop at the repeater, and not at the signal it is repeating.

Some signalling systems (such as cab signalling systems or automatic train operation systems) use two danger indications in rear of a train, as they cannot prevent trains from passing the start of a block, only stop them once they have entered. To reproduce this behaviour, include both state '0' and state '1' in your signal, and use the double-blocking tag. This will give a (permissive) safety block, with an absolute stop indication at the end of it, which should produce the correct behaviour for both the human driver and the Autopilot.

If you want a particular state, but don't have a light to use for it, use "light -1". This is enough to make the state valid, but not use a light for that state.

If you don't specify any states at all, the signal is assumed to be a Pre-v1.3 style signal, which can display Stop, Caution and Proceed via the attachments a.red, a.orange, and a.green. This behaviour is deprecated - so please don't rely on it. It's main use at present appears to be buffer stops and fixed distant boards, which don't actually have the attachment points anyway. I suggest taking advantage of the 'light -1' behaviour to add specific relevant states to these kind of signals. (Fixed buffer stops should have state 0 only, fixed distants state 4 only, and the 'distant 1' tag).

===Custom Logic===

Signals can implement custom logic in script, should the improved default logic not be adequate for the signalling system being modelled. Make your signal script a subclass of 'Signal' like this:

include "signal.gs"

class MyCustomLogicSignal isclass Signal {

Remember to call inherited(); in your Init() method: (THIS IS IMPORTANT!)

void Init(void) {
inherited();

and then override the function 'DetermineUpdatedState' like this:

Soup DetermineUpdatedState(void) {
Soup sigSoup = inherited();

// your code goes here ...

}

to implement custom logic, and/or the function 'ApplyUpdatedState' like this:

void ApplyUpdatedState(Soup sigSoup) {
inherited(sigSoup);

// your code goes here ...

}

to implement custom state display.

Note: You do not need to override both functions. You can override only one if that is all you need to do. I expect a lot of people will want to override 'ApplyUpdatedState' but not need to override 'DetermineUpdatedState'.

The soup that DetermineUpdatedState needs to return contains two records - the integer tag "state" set to one of the signal display states, and the string tag "reason" set to the reason string to use. Default strings are available in Trainz - these are called up by name (starting with a dollar sign) - e.g. "$signal_nextblockbusy_lbl". If none of the default strings are appropriate, you can load a string from the asset's string table in the usual way and pass that in directly.

The soup that you get back from inherited(); will have the values that the default logic thinks you should use, so you can implement specific cases and allow the "default" values through if those cases are not hit.

ApplyUpdatedState takes a soup in the same format (though it only cares about the state, not the reason), and from that, sets up the visual representation of the signal as required. This is very useful for animated signals (e.g. semaphores).

HEALTH WARNING: It is VERY easy to totally destroy the performance of Trainz using these functions. In Classics 3, they are called twice a second for every signal in the map, so they need to be very fast and efficient.

FUTURE BUG WARNING: Do NOT rely on the half second interval between updates. TS2009 does not call signals every half a second. It calls them when it believes they might want to change based on what they queried via GSTrackSearch in their DetermineUpdatedState phase. This could result in intervals of minutes at a time without an update. (This does not, however, mean you can be any less efficient - signals may still be called up to twice a second).

SECOND HEALTH WARNING: Do NOT make a [[KIND Scenery-trackside]] object a subclass of 'Signal' in script. This will cause script errors. The correct TrainzScript class for a Scenery-Trackside object is 'Trackside'.

==Categories==
[[Category:Asset KIND]]

KIND Scenery-trackside

2008-12-17T22:42:44Z

Bloodnok:

[[KIND Scenery-trackside]] provides the basis for all track-attached scenery assets, such as trackside signs and devices.

This asset type inherits all map object characteristics except positioning, and adds trackside positioning and [[TrackSearch]] semantics.

The [[config.txt file]] for a [[KIND Scenery-trackside]] asset has the same ''kind scenery'' entry as [[KIND Scenery]] for historical reasons, however the two kinds are quite distinct and should not be confused. A [[KIND Scenery-trackside]] will contain a ''trackside'' tag, whereas [[KIND Scenery]] does not.

==KIND Hierarchy==
===Parent Classes===
* [[KIND Scenery]]
===Child Classes===
* [[KIND MOSpeedboard]]
* [[KIND MOSignal]]

==Supported Tags==
Each trackside asset supports the following tags. Each tag is shown here with its default value.

trackside 0
speedlimit 0
buffer-speed 0
follow-gradient 0
trackmark 0
search-limit 0

====trackside====
:Type: Decimal
:Desc: The distance, in meters, the object will be placed from the center of the track. Negative values will put the object on the left side of the track, and positive values will place it on the right.
====speedlimit====
:Type: Decimal
:Desc: Sets the speed limit, in meters per second, for the track it is placed on, after the object. If this tag is provided with no value, the speed limit will be set to 100m/s.
====buffer-speed====
:Type: Decimal
:Desc: Used for buffers, this sets the maximum speed, in meters per second, at which the buffer can stop a train. If the Train passes the track-side object travelling faster than the buffer speed it will derail. If it's traveling below, or equal, to the buffer speed the train will stop harmlessly.
====follow-gradient====
:Type: Boolean
:Desc: Specifies that the object should be vertically perpendicular to the track gradient when placed. If 0 (default) the asset will point straight up.
====trackmark====
:Type: Boolean
:Desc: Specifies if the object is a trackmark. Trackmarks can be used to place consists in [[Scripting|TrainzScript]].
====search-limit====
:Type: Boolean
:Desc: Search limit objects are used by the Driver AI and indicate the direction of travel for a section of track.

==Example Config.txt==
Sample [[config.txt file]] for a trackside asset, with the Standard Tags excluded for brevity:

[[TagName_Kind|kind]] "scenery"
[[TagName_Trackside|trackside]] -2.8
[[TagName_Light|light]] 1
[[TagName_Follow-Gradient|follow-gradient]] 0
[[%22mesh-table%22_Container|mesh-table]]
{
default
{
mesh "CatchPoint.im"
auto-create 1
}
}

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND MOSpeedboard

2008-12-17T22:42:16Z

Bloodnok:

[[KIND MOSpeedboard]] is a trackside speed limit sign.

This asset type inherits all [[KIND Scenery-trackside]] characteristics.

==KIND Hierarchy==
===Parent Classes===
* [[KIND Scenery-trackside]]
===Child Classes===
* ''none.''

==Supported Tags==
MOSpeedboards do not introduce new tags - all speed limit functionality is contained in the parent [[KIND Scenery-trackside]] object.

kind mospeedboard

==Example Config.txt==
''TBD''

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

KIND Pantograph

2008-12-17T06:18:33Z

Bloodnok:

[[KIND Pantograph]] objects are used to represent current collecting apparatus on electric locomotives. They are animated, and can be raised and lowered within Trainz.

==KIND Hierarchy==
===Parent Classes===
* [[KIND mesh-object]]
===Child Classes===
* ''none.''

==Supported Tags==
Kind Pantograph does not introduce new tags. A [[%22mesh-table%22_Container|mesh-table]] container is used to define the mesh and animation for a pantograph.

==Example Config.txt==
Sample [[config.txt file]] for a Pantograph asset, with the Standard Tags excluded for brevity:

''TBD''

==Downloads==
''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]