TrainzOnline - User contributions [en]

Custom category identifier

2025-04-25T23:13:30Z

Stokia01:

The "custom-category-list" tag of [[KIND TrainzBaseSpec]] provides a mechanism by which additional machine-visible category tags may be applied to an asset. These custom additions are combined with the builtin asset categorisation to form the asset's [[Category List]]. Due to the limited use-cases and high potential for naming conflicts, it is recommended that new custom categories are introduced only after discussion with [[N3V Games]]. Other options such as [[KIND Asset-group]] are often more flexible and do not suffer from the same concerns.

Builtin category list codes and custom category identifiers do not share the same namespace, and thus it is not possible to use the "custom-category-list" tag to modify the builtin asset categorisation. In effect, every custom category identifier is prepended with a hash ("#") character to indicate that it is not a builtin code. This character should not be included in the "custom-category-list" tag, but must be used in any other scenario where you are using an asset's [[Category List]] but wish to refer to a custom code.

== Known Custom-Category-List items ==

'''Clutter Effect Layer Assets'''

Identifies KIND scenery assets to be used in [[Clutter Effect Layer|clutter effect layers.]]

Assets identified using this tag will not be visible in the [[KIND Scenery|Scenery assets]] tab in Trainz.

<pre>custom-category-list "FXCLT"</pre>

Clutter Effect Layer

2025-04-25T23:04:06Z

Stokia01: /* Asset Configuration */

[[File:Clutterexample1.jpg|right|500px]]

The [[Clutter Effect Layer]] is an [[Effect Layer]] type which is used to render small localised ground clutter (small foliage, stones, etc.) As with all effect layers, clutter is painted onto the terrain and automatically generates appropriate geometry for the area surrounding the camera.

== Surveyor Configuration ==
In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.

[[File:clutter_effect_options.jpg|right]]

====name====
The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

====clutter-density====
Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.

Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.

====spacing====
Controls the distance new clutter objects will spawn from each other. A smaller distance also means more meshes will be added, so this field can heavily impact performance.

====random-rotation====
Enables/disables random mesh rotation around the height (z) axis.

====draw-distance====
Sets the maximum distance at which this clutter effect will draw. The smaller you can make this the better your performance will be, so take the time to consider a sensible value.

====mesh-assets====
This is where you select one or more assets to be randomly generated for your clutter layer.

* Click the "Add Asset" button to add a new asset row.
* Click in the text box to show the list of available clutter assets.
* Select the asset you want to use in from the dropdown list.
* Adjust the slider next to each asset to determine how frequently to spawn this particular asset.
* Move the slider all the way to the right to give a very high spawn frequency.
* Move the slider all the way to the left stop it from spawning altogether (0 spawn frequency).
* When the slider is all the way to the left a delete button will also be displayed. Click that to remove this asset row.

Note that performance of each individual mesh asset can vary, so editing this may heavily impact performance.

====avoid-water====
Whether to avoid rendering this effect under water. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

====altitude-range====
The minimum and maximum altitude at which to render this effect. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

====gradient-range====
The minimum and maximum terrain gradient (degrees) on which to render this effect. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

====ground-texture-mask====
Causes this effect layer to only render on specific ground texture assets. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

== Asset Configuration ==

Before you start looking at creating assets for Clutter Effect Layers you should have a very good knowledge on how you go about modelling efficient meshes for each LOD level and what textures you should be using for each mesh LOD. You can find an excellent reference on how to model and texture assets under the [[Art_Recommendations#Modeling_Overview|Modelling Overview]] on the Art Recommendations Trainz wiki page.

When using a large amount of clutter objects onscreen at one time, it's best to have at least the lowest LODs (which shouldn't be very far from the camera) using a [[Texture Atlas]]. The texture atlas should be as small as it can be while maintaining good visual results (256x256 perhaps) and will hold all the images for all the assets lowest LODs. This means when the lowest LODs are showing (which should be the majority of clutter onscreen most of the time) you'll only be paying the cost of 1 material shared across all the lowest LODs.

You will also want to share as many single textures between as many assets as possible to cut-down on draw calls where possible - If you have 3 ferns all of different sizes, don't make 3 copies of the same texture.

You will want to make sure you understand how to create a Trainz [[Mesh Libraries|Mesh Library]] asset so you can utilise texture atlases and sharing of textures between multiple meshes.

Once you start to construct your Trainz mesh library asset be sure to use the [[m.clutter]] material for all your meshes. This will allow your clutter asset to fade in and out where required. You will also want to take note about the fadeInEndDistance and fadeOutEndDistance in your [[mesh metadata file|mesh metadata files]] to get your fade transitions correct.

Assets must also be identified as clutter assets using the tag [[Custom category identifier|custom-category-list]] "FXCLT". Assets identified using this tag will not be visible in the Scenery assets tab in Trainz.

== Mesh Asset Creation ==

There are several factors to consider when determining which assets you should put in a clutter layer:

# How big is the asset? Anything that has a size of ~1 metre cubed or smaller can be considered as clutter. This is not to say it must be clutter but anything larger than that you should place with the Objects tab.
# To get the nice fade-out transition (and fade-in if you've configured that) your clutter asset should use the material [[m.clutter]].
# LODs are a MUST! If your asset has no LOD or poor LOD it will be far too performance heavy for use as clutter.

You can find all the information on creating clutter mesh assets under [[m.clutter]].

It is strongly recommended that assets created for use in a clutter effect layer are small, relatively low polygon (100-500 polygons at highest LOD), with very efficient LOD (typically down to 5-10 polygons at lowest LOD) and using the [[m.clutter]] material type. It is possible to create very attractive and high-density scenery with well-built clutter assets. However inefficient asset creation can very quickly lead to very poor performance.

== See Also ==

* [[TurfFX_Effect_Layer]]
* [[Effect_Layer_Assets]]
* [[Color_effect_layer|Color Effect Layer]]

Back to [[Effect_Layer]]

[[Category:Modeling]]
[[Category:Content creation]]
[[Category:TRS19]]

"Lights" container

2024-05-15T00:03:38Z

Stokia01:

lights {
0 {
corona "corona_green.tga"
}
1 {
corona "corona_yellow.tga"
}
2 {
corona "corona_red.tga"
}
}

Defines what coronas are attached to what light attachment points.

In this case, light '0' will be shown with file 'corona_green.tga' (found in the asset directory) attached to attachment point 'a.light0' in the signal mesh. The [[Signals_container|signals container]] will refer to it as '0'.

'''Note:''' To comply with TANE onwards creators need to reference the corona via a texture.txt file for example "corona_red.tga" in the config file would need to read "corana_red.texture" So the above example would read

lights {
0 {
corona "corona_green.texture"
}
1 {
corona "corona_yellow.texture"
}
2 {
corona "corona_red.texture"
}
}

An example of the corona_red.texture.txt file would be

Primary=red_corona.tga

Tile=st

This style of referencing will also work with TS12. Each of the coronas must have a solid background and not transparent.
See also: [[KIND_MOSignal|Kind MOSignal]]

[[Category:Config Container|L]]

"Lights" container

2024-05-15T00:03:08Z

Stokia01:

"Lights" container

2024-05-14T23:58:54Z

Stokia01:

lights {
0 {
corona "corona_green.tga"
}
1 {
corona "corona_yellow.tga"
}
2 {
corona "corona_red.tga"
}
}

Defines what coronas are attached to what light attachment points.

In this case, light '0' will be shown with file 'corona_green.tga' (found in the asset directory) attached to attachment point 'a.light0' in the signal mesh. The [[Signals_container|signals container]] will refer to it as '0'.

'''Note:''' To comply with TANE onwards creators need to reference the corona via a texture.txt file for example "corona_red.tga" in the config file would need to read "corana_red.texture" So the above example would read

lights{
0 {
corona "corona_green.texture"
}
1 {
corona "corona_yellow.texture"
}
2 {
corona "corona_red.texture"
}
}

An example of the corona_red.texture.txt file would be

Primary=red_corona.tga

Tile=st

This style of referencing will also work with TS12. Each of the coronas must have a solid background and not transparent.
See also: [[https://online.ts2009.com/mediaWiki/index.php/KIND_MOSignal]]

[[Category:Config Container|L]]

"Lights" container

2024-05-14T23:54:59Z

Stokia01: Update for T:ANE and later handling of Corona textures

lights {
0 {
corona "corona_green.tga"
}
1 {
corona "corona_yellow.tga"
}
2 {
corona "corona_red.tga"
}
}

Defines what coronas are attached to what light attachment points.

In this case, light '0' will be shown with file 'corona_green.tga' (found in the asset directory) attached to attachment point 'a.light0' in the signal mesh. The [[Signals_container|signals container]] will refer to it as '0'.

'''Note:''' To comply with TANE onwards creators need to reference the corona via a texture.txt file for example "corona_red.tga" in the config file would need to read "corana_red.texture" So the above example would read

lights

{
0
{
corona "corona_green.texture"
}
1
{
corona "corona_yellow.texture"
}
2
{
corona "corona_red.texture"
}
}

An example of the corona_red.texture.txt file would be

Primary=red_corona.tga

Tile=st

This style of referencing will also work with TS12. Each of the coronas must have a solid background and not transparent.
See also: [[https://online.ts2009.com/mediaWiki/index.php/KIND_MOSignal]]

[[Category:Config Container|L]]

Terminology

2022-02-19T00:00:35Z

Stokia01: /* Aa to Bz */

{{TOL-ref-top}}
This page describes some of the more common train-related, content-creation-related, and general {{wp|computing}} terms used in the Trainz environment. Users are encouraged to add their own common terms to this page in a similar fashion. Please keep in mind that this site is dedicated to Trainz content creation, and terms which are meaningless in this context may be removed.

<div style="background:#f9f9a9; border:2px solid green; padding:3px; width:80%; margin: 3px 5% 5px 5%; align:center;">'''New Trainzers''' will find a wealth of general knowledge and terminology in the English language Wikipedia {{wp|Glossary of rail transport terms}}, the {{wp|Train}} and {{wp|Trainz}} articles, and on the {{plain link|http://en.wikibooks.org/wiki/Trainz|Trainz Wikibook}} and it's {{plain link|http://en.wikibooks.org/wiki/Trainz/Glossary|Trainz Wikibook glossary}}.
</div> {{TOCright}}

==General Train Terminology==

A note about general train terminology: even among nations where English is the official language, there are differences in terminology. For example, in England, the part of track known as a "sleeper" is called a "tie" in North America. An English railroader speaking of a "bogey", and an North American railroader speaking of a "truck" are likely talking about the same thing.

* In Advance Of - Signalling term. A signal is said to be 'in advance of' something, if a driver stopped at that signal would have to drive forwards to get there.
* In Rear Of - Signalling term. A signal is said to be 'in rear of' something, if a driver stopped at that signal would have to drive backwards to get there.

==Trainz Terms==
{{sect-stub}}
===Abbreviations===
* [[TADDaemon|TAD]] - Trainz Asset Database.
* [[Content_Manager|CM]] - Content Manager.
* [[Level_of_Detail|LOD]] - Level-Of-Detail.
* [[IM_files|IM]] - Indexed Mesh file format.
* PM - Progressive Mesh file format; this is an obsolete mesh file format that is no longer supported.
* LM - Config file representation of the [[LM.txt_file]]" file format used by [[Level of Detail]] meshes.
* TNI - Trainz Native Interface.
* PBR - [[Physically Based Rendering]]
* FBX - FilmBoX file format for meshes (Build 4.5 and higher) [[FBX file format]]

===Supported File Formats===
* {{wp|text file|.TXT files}} like [[config.txt file]], used by Trainz as a data {{Wp|INI file}} type.
* [[.texture.txt_Files|.texture.txt file]]
* .texture file
* .pm file [Note: this is an obsolete, and no longer supported format.]
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .[[trainzmesh file]] a mesh file format created for use with T:ANE and above. Created by importing meshes in the [[FBX file format]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

===Content Creation===

==== Aa to Bz====
<big>
* '''Alias''' - An asset which takes it's ''mesh'' from another asset, but replaces one or more of the original ''textures'' with locally provided ones. Commonly used to reskin an asset.
** <code>'''Note: Assets created with build numbers from Trainz 2009 (version 2.9) onwards cannot use aliasing by reference to an alias asset in the top-level of the config.txt file. Meshes can be aliased using the mesh-asset tag in the mesh-table folder.'''</code>
* '''[[Alpha blending]]''' - The process of using an opacity setting or texture alpha channel to allow partial transparency. {{wp|Alpha blending}} is a hardware operation, however by itself blending does not combine well with a traditional hardware {{wp|depth-buffer}} technique.
** The end result is that multiple overlapping layers of alpha blending will not be rendered in the physically correct order without some alternative non-hardware-accelerated techniques. Such techniques should be avoided due to the associated performance losses.
** In short: use alpha blending sparingly, and do not apply an alpha-blended material to polygons which could do without.
* '''[[Alpha masking]]''' - The process of using a texture alpha channel to "mask out" parts of the texture, allowing arbitrary see-through areas on the texture. Unlike ''alpha blending'', alpha masking does not allow semi-transparent areas - each resultant texel is either fully textured, or fully transparent. Alpha masking is a fully hardware-accelerated technique, and so acceptable.
* '''Asset''' - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files.
** Sometimes, even frequently,... used (incorrectly) interchangeably with ''''content''''; technically, content is an asset included in a route or session—until then an asset is an potential content item.
** Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* '''[http://www.blender.org Blender]''' - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* '''[[KIND_Bogey|Bogey]]''' - Asset type used to represent wheels and suspension components. Used for anything that needs to rotate as the train moves along the track (e.g. wheels), or move (by rotation or translation) to match the angle and position of the track (e.g. subframe and suspension components). In the US this is normally referred to as a ''truck'', and in the UK as a ''bogie''.
* '''Bump mapping''' - Another term for ''Normal mapping''.
</big>

====Ca to Md====
<big>
* '''Cab / Cabin / Interior''' - Asset made to represent the inside of an object, typically a ''Vehicle''.
* '''[[Content Manager]]''' - Program for querying and editing the ''Trainz Asset Database''.
** Common tasks performed with Content Manager include downloading, uploading, installing, editing, archiving, error trapping (testing for, generation of) and removing content.
* '''Dependency''' - An ''asset'' which is required by this asset in order to function properly.
* '''Dependent''' - An ''asset'' which requires this asset in order to function properly.{{FAB-todo|This is unclear, dependent asset and dependencies are different CM drop down menu choices. Clarify!}}
* '''Geometry''' - A three-dimensional ''mesh'', without any related textures or material properties.
* '''{{wp|GMAX}}''' -A 3D modeling tool originally produced by Discreet for use in producing game assets. While still available, the software has not been in active development for some time, and is not considered to be a state of the art tool for Trainz asset creation. See also 3DSMax.
* '''Indices''' - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* '''[[KUID]]''' - Unique identifier for a specific Trainz ''asset''. Consists of Creator ID, Content ID and Version number fields.
* '''[[Kuid-table_container|KUID Table]]''' - The [[Kuid-table_container|kuid-table container]] of an asset's [[config.txt file]]. Used to specify ''dependencies''.
* {{wp|Level of detail|Level-Of-Detail}} (LOD)''' - A technique where an object (typically a mesh) is built with a number of variations which look as close as possible to identical, but which trade off quality as distance from the viewing point increases and that aids rendering performance to differing degrees.
** The [[Auran JET]] graphics engine selects between the various levels at runtime based on metrics such as distance from the observer.
** For textures, ''mip-mapping'' serves a similar purpose without requiring manual attention.
** All medium-to-high-detail meshes should supply LOD variants. [[LM.txt_file]]s are used for LOD on moving/animated models.
* '''[[Material_Types|Material]]''' - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* '''MAX / {{wp|3D Studio Max}}''', or obsolescent {{wp|Gmax}} once bundled with early Trainz retail releases - The commercial [[Modeling]] tool used and supported by Auran.
</big>

====Me to Qz====
<big>
* '''{{wp|Polygon mesh|Mesh}}''' - A three-dimensional ''model'' used in the game environment. The word ''mesh'' is often used to refer to a specific game file containing the three-dimensional ''geometry'' without related properties such as the model's textures.
* '''Mesh Library''' - An asset which other assets use. These assets refer to the mesh library by KUID, using a 'mesh-asset' tag in their mesh table. Nothing special is needed for an asset to be a mesh library, it just has to contain mesh files.
* '''[[Mesh stitching]]''' - A runtime optimization process which combines multiple individual mesh instances into a single ''draw call'' for performance reasons. This results in higher performance with no visible changes.
* '''[["mesh-table"_Container|Mesh Table]]''' - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* '''[[Mip mapping]]''' - Process to reduce texture detail for objects in the distance, or at a sharp angle to the camera. Used to avoid problems with aliasing (flicker), which can occur where the texture is of comparable or higher detail than the display equipment.
* '''Model''' - A {{wp|three-dimensional}} definition of an {{wp|virtual reality|virtual}} 3D object, built in a special [[modeling]] package such as Blender or Max. The word ''model'' is often used to describe the concept of a three-dimensional object including properties such as its textures.
* '''[[Normal map|Normal mapping]]''' - A more advanced form of ''texture mapping'' which allows per-pixel control over the lighting conditions on the target geometry. Among other benefits, this technique allows a content creator to define small bumps and grooves in a surface in addition to simple coloration.
* '''Obsolete''' - An ''asset'' is obsolete if it has been replaced by a newer version with newer technology models and definitions, breaking the asset in part for a new [["Trainz-build" tag]] (version).
** A container type or tag in a [[KIND]] is obsolete because the programmers say so—because they have a real need to change the {{wp|data structure}} in a new Trainz advance, ''normally without warning the user community first.''
* '''[["String-table" container|String Table]]''' - The [["String-table" container]] of an asset's [[config.txt file]]. Used for localization strings (i.e. anything that will be displayed to the user).
* '''Pixel''' - One individual point on a ''texture'' image, consisting of red, green, blue and alpha components (e.g. a texture size of 512 pixels by 512 pixels). May also refer to one individual point within a display (e.g. a display size of 1024 pixels by 768 pixels).
* '''Polygons''' - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
</big>

====Ra to Tq====
<big>
* '''Render call''' / '''Draw call''' - A single hardware rendering operation. This is an important concept when performance is a concern, as there is a substantial performance overhead to each draw call. By minimizing the number of draw calls, the same scene can be rendered at a notably higher frame rate. Each draw call associates one ''material'' with some quantity of ''vertices'' and ''indices''.
* [[KIND_Map|Route / Layout / Map]] - Asset created in ''Surveyor'', consisting of a textured landscape and one or more ''Layers'' containing ''scenery objects'', ''splines'', ''trackside objects'', ''Vehicles'', etc.
* '''[[KIND_Scenery|Scenery]]''' / '''Map object''' - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* '''[[KIND_Profile|Session]]''' - Asset created in surveyor, which extends a ''map'' by placing on it additional layers of objects - commonly ''Vehicles'', but any ''scenery object'', ''spline'', ''trackside object'', etc, can also be added. The Session also contains all the saved script data from any asset in the combination of map and session.
* '''Specular lighting''' - Lighting effects that vary dependent on the angle of incident light.
* '''[[KIND_Track|Spline]]''' - A continuous linear 3D model such as a hedge, a fence, a road, or a track. Splines are placed in Surveyor as a series of ''spline control points'' and the geometry is built in a smoothed path between the control points.
* '''Texel''' - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* '''Texture''' - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* '''Texture Sharing''' - When two or more ''{{wp|Polygon mesh|meshes}}'' in the same asset (which may be a ''mesh library'', and thus used by many assets) use the same ''material'' and ''texture''. Trainz can then use ''mesh stitching'' to render them in the same ''draw call'', with corresponding performance improvements.
</big>
====Tr to Zz====
<big>
* '''[[KIND_Scenery-trackside|Trackside object]]''' - A trackside object is a specialisation of a ''[[scenery object]]'' that is placed attached to a spline. When the spline is moved, the trackside object is also moved.
* '''[[Scripting|TrainzScript]]''' / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* '''Trainz Asset Database''' - Contains all the metadata information about Trainz content. Editable through [[Content Manager]] and [[TrainzUtil]].
* '''TrainzUtil''' - Command line tool to query and edit the ''Trainz Asset Database''.
* '''Trainz Native Interface''' - TBD
* '''Triangles''' - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* '''[[KIND_Traincar|Vehicle]]''' - All ''assets'' which can be placed into a train (consist). Includes locomotives. Not to be confused with road cars, which are actually ''Trackside'' objects (as they are attached to roads).
* '''Vertices''' - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.

{{TOL-ref-bot}}
[[Category:Trainz Wiki]]<div>
{{FUN-end}}<div>{{ORP-bot}}

Terminology

2022-02-18T23:58:40Z

Stokia01: /* Aa to Bz */

{{TOL-ref-top}}
This page describes some of the more common train-related, content-creation-related, and general {{wp|computing}} terms used in the Trainz environment. Users are encouraged to add their own common terms to this page in a similar fashion. Please keep in mind that this site is dedicated to Trainz content creation, and terms which are meaningless in this context may be removed.

<div style="background:#f9f9a9; border:2px solid green; padding:3px; width:80%; margin: 3px 5% 5px 5%; align:center;">'''New Trainzers''' will find a wealth of general knowledge and terminology in the English language Wikipedia {{wp|Glossary of rail transport terms}}, the {{wp|Train}} and {{wp|Trainz}} articles, and on the {{plain link|http://en.wikibooks.org/wiki/Trainz|Trainz Wikibook}} and it's {{plain link|http://en.wikibooks.org/wiki/Trainz/Glossary|Trainz Wikibook glossary}}.
</div> {{TOCright}}

==General Train Terminology==

A note about general train terminology: even among nations where English is the official language, there are differences in terminology. For example, in England, the part of track known as a "sleeper" is called a "tie" in North America. An English railroader speaking of a "bogey", and an North American railroader speaking of a "truck" are likely talking about the same thing.

* In Advance Of - Signalling term. A signal is said to be 'in advance of' something, if a driver stopped at that signal would have to drive forwards to get there.
* In Rear Of - Signalling term. A signal is said to be 'in rear of' something, if a driver stopped at that signal would have to drive backwards to get there.

==Trainz Terms==
{{sect-stub}}
===Abbreviations===
* [[TADDaemon|TAD]] - Trainz Asset Database.
* [[Content_Manager|CM]] - Content Manager.
* [[Level_of_Detail|LOD]] - Level-Of-Detail.
* [[IM_files|IM]] - Indexed Mesh file format.
* PM - Progressive Mesh file format; this is an obsolete mesh file format that is no longer supported.
* LM - Config file representation of the [[LM.txt_file]]" file format used by [[Level of Detail]] meshes.
* TNI - Trainz Native Interface.
* PBR - [[Physically Based Rendering]]
* FBX - FilmBoX file format for meshes (Build 4.5 and higher) [[FBX file format]]

===Supported File Formats===
* {{wp|text file|.TXT files}} like [[config.txt file]], used by Trainz as a data {{Wp|INI file}} type.
* [[.texture.txt_Files|.texture.txt file]]
* .texture file
* .pm file [Note: this is an obsolete, and no longer supported format.]
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .[[trainzmesh file]] a mesh file format created for use with T:ANE and above. Created by importing meshes in the [[FBX file format]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

===Content Creation===

==== Aa to Bz====
<big>
* '''[[Terminology#Aa to Bz|Alias]]''' - An asset which takes it's ''mesh'' from another asset, but replaces one or more of the original ''textures'' with locally provided ones. Commonly used to reskin an asset.
** <code>'''Note: Assets created with build numbers from Trainz 2009 (version 2.9) onwards cannot use aliasing by reference to an alias asset in the top-level of the config.txt file. Meshes can be aliased using the mesh-asset tag in the mesh-table folder.'''</code>
* '''[[Alpha blending]]''' - The process of using an opacity setting or texture alpha channel to allow partial transparency. {{wp|Alpha blending}} is a hardware operation, however by itself blending does not combine well with a traditional hardware {{wp|depth-buffer}} technique.
** The end result is that multiple overlapping layers of alpha blending will not be rendered in the physically correct order without some alternative non-hardware-accelerated techniques. Such techniques should be avoided due to the associated performance losses.
** In short: use alpha blending sparingly, and do not apply an alpha-blended material to polygons which could do without.
* '''[[Alpha masking]]''' - The process of using a texture alpha channel to "mask out" parts of the texture, allowing arbitrary see-through areas on the texture. Unlike ''alpha blending'', alpha masking does not allow semi-transparent areas - each resultant texel is either fully textured, or fully transparent. Alpha masking is a fully hardware-accelerated technique, and so acceptable.
* '''Asset''' - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files.
** Sometimes, even frequently,... used (incorrectly) interchangeably with ''''content''''; technically, content is an asset included in a route or session—until then an asset is an potential content item.
** Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* '''[http://www.blender.org Blender]''' - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* '''[[KIND_Bogey|Bogey]]''' - Asset type used to represent wheels and suspension components. Used for anything that needs to rotate as the train moves along the track (e.g. wheels), or move (by rotation or translation) to match the angle and position of the track (e.g. subframe and suspension components). In the US this is normally referred to as a ''truck'', and in the UK as a ''bogie''.
* '''Bump mapping''' - Another term for ''Normal mapping''.
</big>

====Ca to Md====
<big>
* '''Cab / Cabin / Interior''' - Asset made to represent the inside of an object, typically a ''Vehicle''.
* '''[[Content Manager]]''' - Program for querying and editing the ''Trainz Asset Database''.
** Common tasks performed with Content Manager include downloading, uploading, installing, editing, archiving, error trapping (testing for, generation of) and removing content.
* '''Dependency''' - An ''asset'' which is required by this asset in order to function properly.
* '''Dependent''' - An ''asset'' which requires this asset in order to function properly.{{FAB-todo|This is unclear, dependent asset and dependencies are different CM drop down menu choices. Clarify!}}
* '''Geometry''' - A three-dimensional ''mesh'', without any related textures or material properties.
* '''{{wp|GMAX}}''' -A 3D modeling tool originally produced by Discreet for use in producing game assets. While still available, the software has not been in active development for some time, and is not considered to be a state of the art tool for Trainz asset creation. See also 3DSMax.
* '''Indices''' - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* '''[[KUID]]''' - Unique identifier for a specific Trainz ''asset''. Consists of Creator ID, Content ID and Version number fields.
* '''[[Kuid-table_container|KUID Table]]''' - The [[Kuid-table_container|kuid-table container]] of an asset's [[config.txt file]]. Used to specify ''dependencies''.
* {{wp|Level of detail|Level-Of-Detail}} (LOD)''' - A technique where an object (typically a mesh) is built with a number of variations which look as close as possible to identical, but which trade off quality as distance from the viewing point increases and that aids rendering performance to differing degrees.
** The [[Auran JET]] graphics engine selects between the various levels at runtime based on metrics such as distance from the observer.
** For textures, ''mip-mapping'' serves a similar purpose without requiring manual attention.
** All medium-to-high-detail meshes should supply LOD variants. [[LM.txt_file]]s are used for LOD on moving/animated models.
* '''[[Material_Types|Material]]''' - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* '''MAX / {{wp|3D Studio Max}}''', or obsolescent {{wp|Gmax}} once bundled with early Trainz retail releases - The commercial [[Modeling]] tool used and supported by Auran.
</big>

====Me to Qz====
<big>
* '''{{wp|Polygon mesh|Mesh}}''' - A three-dimensional ''model'' used in the game environment. The word ''mesh'' is often used to refer to a specific game file containing the three-dimensional ''geometry'' without related properties such as the model's textures.
* '''Mesh Library''' - An asset which other assets use. These assets refer to the mesh library by KUID, using a 'mesh-asset' tag in their mesh table. Nothing special is needed for an asset to be a mesh library, it just has to contain mesh files.
* '''[[Mesh stitching]]''' - A runtime optimization process which combines multiple individual mesh instances into a single ''draw call'' for performance reasons. This results in higher performance with no visible changes.
* '''[["mesh-table"_Container|Mesh Table]]''' - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* '''[[Mip mapping]]''' - Process to reduce texture detail for objects in the distance, or at a sharp angle to the camera. Used to avoid problems with aliasing (flicker), which can occur where the texture is of comparable or higher detail than the display equipment.
* '''Model''' - A {{wp|three-dimensional}} definition of an {{wp|virtual reality|virtual}} 3D object, built in a special [[modeling]] package such as Blender or Max. The word ''model'' is often used to describe the concept of a three-dimensional object including properties such as its textures.
* '''[[Normal map|Normal mapping]]''' - A more advanced form of ''texture mapping'' which allows per-pixel control over the lighting conditions on the target geometry. Among other benefits, this technique allows a content creator to define small bumps and grooves in a surface in addition to simple coloration.
* '''Obsolete''' - An ''asset'' is obsolete if it has been replaced by a newer version with newer technology models and definitions, breaking the asset in part for a new [["Trainz-build" tag]] (version).
** A container type or tag in a [[KIND]] is obsolete because the programmers say so—because they have a real need to change the {{wp|data structure}} in a new Trainz advance, ''normally without warning the user community first.''
* '''[["String-table" container|String Table]]''' - The [["String-table" container]] of an asset's [[config.txt file]]. Used for localization strings (i.e. anything that will be displayed to the user).
* '''Pixel''' - One individual point on a ''texture'' image, consisting of red, green, blue and alpha components (e.g. a texture size of 512 pixels by 512 pixels). May also refer to one individual point within a display (e.g. a display size of 1024 pixels by 768 pixels).
* '''Polygons''' - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
</big>

====Ra to Tq====
<big>
* '''Render call''' / '''Draw call''' - A single hardware rendering operation. This is an important concept when performance is a concern, as there is a substantial performance overhead to each draw call. By minimizing the number of draw calls, the same scene can be rendered at a notably higher frame rate. Each draw call associates one ''material'' with some quantity of ''vertices'' and ''indices''.
* [[KIND_Map|Route / Layout / Map]] - Asset created in ''Surveyor'', consisting of a textured landscape and one or more ''Layers'' containing ''scenery objects'', ''splines'', ''trackside objects'', ''Vehicles'', etc.
* '''[[KIND_Scenery|Scenery]]''' / '''Map object''' - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* '''[[KIND_Profile|Session]]''' - Asset created in surveyor, which extends a ''map'' by placing on it additional layers of objects - commonly ''Vehicles'', but any ''scenery object'', ''spline'', ''trackside object'', etc, can also be added. The Session also contains all the saved script data from any asset in the combination of map and session.
* '''Specular lighting''' - Lighting effects that vary dependent on the angle of incident light.
* '''[[KIND_Track|Spline]]''' - A continuous linear 3D model such as a hedge, a fence, a road, or a track. Splines are placed in Surveyor as a series of ''spline control points'' and the geometry is built in a smoothed path between the control points.
* '''Texel''' - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* '''Texture''' - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* '''Texture Sharing''' - When two or more ''{{wp|Polygon mesh|meshes}}'' in the same asset (which may be a ''mesh library'', and thus used by many assets) use the same ''material'' and ''texture''. Trainz can then use ''mesh stitching'' to render them in the same ''draw call'', with corresponding performance improvements.
</big>
====Tr to Zz====
<big>
* '''[[KIND_Scenery-trackside|Trackside object]]''' - A trackside object is a specialisation of a ''[[scenery object]]'' that is placed attached to a spline. When the spline is moved, the trackside object is also moved.
* '''[[Scripting|TrainzScript]]''' / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* '''Trainz Asset Database''' - Contains all the metadata information about Trainz content. Editable through [[Content Manager]] and [[TrainzUtil]].
* '''TrainzUtil''' - Command line tool to query and edit the ''Trainz Asset Database''.
* '''Trainz Native Interface''' - TBD
* '''Triangles''' - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* '''[[KIND_Traincar|Vehicle]]''' - All ''assets'' which can be placed into a train (consist). Includes locomotives. Not to be confused with road cars, which are actually ''Trackside'' objects (as they are attached to roads).
* '''Vertices''' - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.

{{TOL-ref-bot}}
[[Category:Trainz Wiki]]<div>
{{FUN-end}}<div>{{ORP-bot}}

Terminology

2022-02-18T23:43:18Z

Stokia01: /* Abbreviations */

Terminology

2022-02-18T23:42:34Z

Stokia01: /* Supported File Formats */

{{TOL-ref-top}}
This page describes some of the more common train-related, content-creation-related, and general {{wp|computing}} terms used in the Trainz environment. Users are encouraged to add their own common terms to this page in a similar fashion. Please keep in mind that this site is dedicated to Trainz content creation, and terms which are meaningless in this context may be removed.

<div style="background:#f9f9a9; border:2px solid green; padding:3px; width:80%; margin: 3px 5% 5px 5%; align:center;">'''New Trainzers''' will find a wealth of general knowledge and terminology in the English language Wikipedia {{wp|Glossary of rail transport terms}}, the {{wp|Train}} and {{wp|Trainz}} articles, and on the {{plain link|http://en.wikibooks.org/wiki/Trainz|Trainz Wikibook}} and it's {{plain link|http://en.wikibooks.org/wiki/Trainz/Glossary|Trainz Wikibook glossary}}.
</div> {{TOCright}}

==General Train Terminology==

A note about general train terminology: even among nations where English is the official language, there are differences in terminology. For example, in England, the part of track known as a "sleeper" is called a "tie" in North America. An English railroader speaking of a "bogey", and an North American railroader speaking of a "truck" are likely talking about the same thing.

* In Advance Of - Signalling term. A signal is said to be 'in advance of' something, if a driver stopped at that signal would have to drive forwards to get there.
* In Rear Of - Signalling term. A signal is said to be 'in rear of' something, if a driver stopped at that signal would have to drive backwards to get there.

==Trainz Terms==
{{sect-stub}}
===Abbreviations===
* [[TADDaemon|TAD]] - Trainz Asset Database.
* [[Content_Manager|CM]] - Content Manager.
* [[Level_of_Detail|LOD]] - Level-Of-Detail.
* [[IM_files|IM]] - Indexed Mesh file format.
* PM - Progressive Mesh file format; this is an obsolete mesh file format that is no longer supported.
* LM - Config file representation of the [[LM.txt_file]]" file format used by [[Level of Detail]] meshes.
* TNI - Trainz Native Interface.
* PBR - [[Physically Based Rendering]]
* FBX - FilmBoX file format for meshes (Build 4.5 and higher)

===Supported File Formats===
* {{wp|text file|.TXT files}} like [[config.txt file]], used by Trainz as a data {{Wp|INI file}} type.
* [[.texture.txt_Files|.texture.txt file]]
* .texture file
* .pm file [Note: this is an obsolete, and no longer supported format.]
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .[[trainzmesh file]] a mesh file format created for use with T:ANE and above. Created by importing meshes in the [[FBX file format]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

===Content Creation===

==== Aa to Bz====
<big>
* '''Alias''' - An asset which takes it's ''mesh'' from another asset, but replaces one or more of the original ''textures'' with locally provided ones. Commonly used to reskin an asset.
** <code>'''Note: Assets created with build numbers from Trainz 2009 (version 2.9) onwards cannot use aliasing by reference to an alias asset in the top-level of the config.txt file. Meshes can be aliased using the mesh-asset tag in the mesh-table folder.'''</code>
* '''[[Alpha blending]]''' - The process of using an opacity setting or texture alpha channel to allow partial transparency. {{wp|Alpha blending}} is a hardware operation, however by itself blending does not combine well with a traditional hardware {{wp|depth-buffer}} technique.
** The end result is that multiple overlapping layers of alpha blending will not be rendered in the physically correct order without some alternative non-hardware-accelerated techniques. Such techniques should be avoided due to the associated performance losses.
** In short: use alpha blending sparingly, and do not apply an alpha-blended material to polygons which could do without.
* '''[[Alpha masking]]''' - The process of using a texture alpha channel to "mask out" parts of the texture, allowing arbitrary see-through areas on the texture. Unlike ''alpha blending'', alpha masking does not allow semi-transparent areas - each resultant texel is either fully textured, or fully transparent. Alpha masking is a fully hardware-accelerated technique, and so acceptable.
* '''Asset''' - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files.
** Sometimes, even frequently,... used (incorrectly) interchangeably with ''''content''''; technically, content is an asset included in a route or session—until then an asset is an potential content item.
** Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* '''[http://www.blender.org Blender]''' - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* '''[[KIND_Bogey|Bogey]]''' - Asset type used to represent wheels and suspension components. Used for anything that needs to rotate as the train moves along the track (e.g. wheels), or move (by rotation or translation) to match the angle and position of the track (e.g. subframe and suspension components). In the US this is normally referred to as a ''truck'', and in the UK as a ''bogie''.
* '''Bump mapping''' - Another term for ''Normal mapping''.
</big>

====Ca to Md====
<big>
* '''Cab / Cabin / Interior''' - Asset made to represent the inside of an object, typically a ''Vehicle''.
* '''[[Content Manager]]''' - Program for querying and editing the ''Trainz Asset Database''.
** Common tasks performed with Content Manager include downloading, uploading, installing, editing, archiving, error trapping (testing for, generation of) and removing content.
* '''Dependency''' - An ''asset'' which is required by this asset in order to function properly.
* '''Dependent''' - An ''asset'' which requires this asset in order to function properly.{{FAB-todo|This is unclear, dependent asset and dependencies are different CM drop down menu choices. Clarify!}}
* '''Geometry''' - A three-dimensional ''mesh'', without any related textures or material properties.
* '''{{wp|GMAX}}''' -A 3D modeling tool originally produced by Discreet for use in producing game assets. While still available, the software has not been in active development for some time, and is not considered to be a state of the art tool for Trainz asset creation. See also 3DSMax.
* '''Indices''' - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* '''[[KUID]]''' - Unique identifier for a specific Trainz ''asset''. Consists of Creator ID, Content ID and Version number fields.
* '''[[Kuid-table_container|KUID Table]]''' - The [[Kuid-table_container|kuid-table container]] of an asset's [[config.txt file]]. Used to specify ''dependencies''.
* {{wp|Level of detail|Level-Of-Detail}} (LOD)''' - A technique where an object (typically a mesh) is built with a number of variations which look as close as possible to identical, but which trade off quality as distance from the viewing point increases and that aids rendering performance to differing degrees.
** The [[Auran JET]] graphics engine selects between the various levels at runtime based on metrics such as distance from the observer.
** For textures, ''mip-mapping'' serves a similar purpose without requiring manual attention.
** All medium-to-high-detail meshes should supply LOD variants. [[LM.txt_file]]s are used for LOD on moving/animated models.
* '''[[Material_Types|Material]]''' - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* '''MAX / {{wp|3D Studio Max}}''', or obsolescent {{wp|Gmax}} once bundled with early Trainz retail releases - The commercial [[Modeling]] tool used and supported by Auran.
</big>

====Me to Qz====
<big>
* '''{{wp|Polygon mesh|Mesh}}''' - A three-dimensional ''model'' used in the game environment. The word ''mesh'' is often used to refer to a specific game file containing the three-dimensional ''geometry'' without related properties such as the model's textures.
* '''Mesh Library''' - An asset which other assets use. These assets refer to the mesh library by KUID, using a 'mesh-asset' tag in their mesh table. Nothing special is needed for an asset to be a mesh library, it just has to contain mesh files.
* '''[[Mesh stitching]]''' - A runtime optimization process which combines multiple individual mesh instances into a single ''draw call'' for performance reasons. This results in higher performance with no visible changes.
* '''[["mesh-table"_Container|Mesh Table]]''' - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* '''[[Mip mapping]]''' - Process to reduce texture detail for objects in the distance, or at a sharp angle to the camera. Used to avoid problems with aliasing (flicker), which can occur where the texture is of comparable or higher detail than the display equipment.
* '''Model''' - A {{wp|three-dimensional}} definition of an {{wp|virtual reality|virtual}} 3D object, built in a special [[modeling]] package such as Blender or Max. The word ''model'' is often used to describe the concept of a three-dimensional object including properties such as its textures.
* '''[[Normal map|Normal mapping]]''' - A more advanced form of ''texture mapping'' which allows per-pixel control over the lighting conditions on the target geometry. Among other benefits, this technique allows a content creator to define small bumps and grooves in a surface in addition to simple coloration.
* '''Obsolete''' - An ''asset'' is obsolete if it has been replaced by a newer version with newer technology models and definitions, breaking the asset in part for a new [["Trainz-build" tag]] (version).
** A container type or tag in a [[KIND]] is obsolete because the programmers say so—because they have a real need to change the {{wp|data structure}} in a new Trainz advance, ''normally without warning the user community first.''
* '''[["String-table" container|String Table]]''' - The [["String-table" container]] of an asset's [[config.txt file]]. Used for localization strings (i.e. anything that will be displayed to the user).
* '''Pixel''' - One individual point on a ''texture'' image, consisting of red, green, blue and alpha components (e.g. a texture size of 512 pixels by 512 pixels). May also refer to one individual point within a display (e.g. a display size of 1024 pixels by 768 pixels).
* '''Polygons''' - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
</big>

====Ra to Tq====
<big>
* '''Render call''' / '''Draw call''' - A single hardware rendering operation. This is an important concept when performance is a concern, as there is a substantial performance overhead to each draw call. By minimizing the number of draw calls, the same scene can be rendered at a notably higher frame rate. Each draw call associates one ''material'' with some quantity of ''vertices'' and ''indices''.
* [[KIND_Map|Route / Layout / Map]] - Asset created in ''Surveyor'', consisting of a textured landscape and one or more ''Layers'' containing ''scenery objects'', ''splines'', ''trackside objects'', ''Vehicles'', etc.
* '''[[KIND_Scenery|Scenery]]''' / '''Map object''' - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* '''[[KIND_Profile|Session]]''' - Asset created in surveyor, which extends a ''map'' by placing on it additional layers of objects - commonly ''Vehicles'', but any ''scenery object'', ''spline'', ''trackside object'', etc, can also be added. The Session also contains all the saved script data from any asset in the combination of map and session.
* '''Specular lighting''' - Lighting effects that vary dependent on the angle of incident light.
* '''[[KIND_Track|Spline]]''' - A continuous linear 3D model such as a hedge, a fence, a road, or a track. Splines are placed in Surveyor as a series of ''spline control points'' and the geometry is built in a smoothed path between the control points.
* '''Texel''' - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* '''Texture''' - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* '''Texture Sharing''' - When two or more ''{{wp|Polygon mesh|meshes}}'' in the same asset (which may be a ''mesh library'', and thus used by many assets) use the same ''material'' and ''texture''. Trainz can then use ''mesh stitching'' to render them in the same ''draw call'', with corresponding performance improvements.
</big>
====Tr to Zz====
<big>
* '''[[KIND_Scenery-trackside|Trackside object]]''' - A trackside object is a specialisation of a ''[[scenery object]]'' that is placed attached to a spline. When the spline is moved, the trackside object is also moved.
* '''[[Scripting|TrainzScript]]''' / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* '''Trainz Asset Database''' - Contains all the metadata information about Trainz content. Editable through [[Content Manager]] and [[TrainzUtil]].
* '''TrainzUtil''' - Command line tool to query and edit the ''Trainz Asset Database''.
* '''Trainz Native Interface''' - TBD
* '''Triangles''' - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* '''[[KIND_Traincar|Vehicle]]''' - All ''assets'' which can be placed into a train (consist). Includes locomotives. Not to be confused with road cars, which are actually ''Trackside'' objects (as they are attached to roads).
* '''Vertices''' - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.

{{TOL-ref-bot}}
[[Category:Trainz Wiki]]<div>
{{FUN-end}}<div>{{ORP-bot}}

Terminology

2022-02-18T23:36:12Z

Stokia01: /* Abbreviations */

{{TOL-ref-top}}
This page describes some of the more common train-related, content-creation-related, and general {{wp|computing}} terms used in the Trainz environment. Users are encouraged to add their own common terms to this page in a similar fashion. Please keep in mind that this site is dedicated to Trainz content creation, and terms which are meaningless in this context may be removed.

<div style="background:#f9f9a9; border:2px solid green; padding:3px; width:80%; margin: 3px 5% 5px 5%; align:center;">'''New Trainzers''' will find a wealth of general knowledge and terminology in the English language Wikipedia {{wp|Glossary of rail transport terms}}, the {{wp|Train}} and {{wp|Trainz}} articles, and on the {{plain link|http://en.wikibooks.org/wiki/Trainz|Trainz Wikibook}} and it's {{plain link|http://en.wikibooks.org/wiki/Trainz/Glossary|Trainz Wikibook glossary}}.
</div> {{TOCright}}

==General Train Terminology==

A note about general train terminology: even among nations where English is the official language, there are differences in terminology. For example, in England, the part of track known as a "sleeper" is called a "tie" in North America. An English railroader speaking of a "bogey", and an North American railroader speaking of a "truck" are likely talking about the same thing.

* In Advance Of - Signalling term. A signal is said to be 'in advance of' something, if a driver stopped at that signal would have to drive forwards to get there.
* In Rear Of - Signalling term. A signal is said to be 'in rear of' something, if a driver stopped at that signal would have to drive backwards to get there.

==Trainz Terms==
{{sect-stub}}
===Abbreviations===
* [[TADDaemon|TAD]] - Trainz Asset Database.
* [[Content_Manager|CM]] - Content Manager.
* [[Level_of_Detail|LOD]] - Level-Of-Detail.
* [[IM_files|IM]] - Indexed Mesh file format.
* PM - Progressive Mesh file format; this is an obsolete mesh file format that is no longer supported.
* LM - Config file representation of the [[LM.txt_file]]" file format used by [[Level of Detail]] meshes.
* TNI - Trainz Native Interface.
* PBR - [[Physically Based Rendering]]
* FBX - FilmBoX file format for meshes (Build 4.5 and higher)

===Supported File Formats===
* {{wp|text file|.TXT files}} like [[config.txt file]], used by Trainz as a data {{Wp|INI file}} type.
* [[.texture.txt_Files|.texture.txt file]]
* .texture file
* .pm file [Note: this is an obsolete, and no longer supported format.]
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

===Content Creation===

==== Aa to Bz====
<big>
* '''Alias''' - An asset which takes it's ''mesh'' from another asset, but replaces one or more of the original ''textures'' with locally provided ones. Commonly used to reskin an asset.
** <code>'''Note: Assets created with build numbers from Trainz 2009 (version 2.9) onwards cannot use aliasing by reference to an alias asset in the top-level of the config.txt file. Meshes can be aliased using the mesh-asset tag in the mesh-table folder.'''</code>
* '''[[Alpha blending]]''' - The process of using an opacity setting or texture alpha channel to allow partial transparency. {{wp|Alpha blending}} is a hardware operation, however by itself blending does not combine well with a traditional hardware {{wp|depth-buffer}} technique.
** The end result is that multiple overlapping layers of alpha blending will not be rendered in the physically correct order without some alternative non-hardware-accelerated techniques. Such techniques should be avoided due to the associated performance losses.
** In short: use alpha blending sparingly, and do not apply an alpha-blended material to polygons which could do without.
* '''[[Alpha masking]]''' - The process of using a texture alpha channel to "mask out" parts of the texture, allowing arbitrary see-through areas on the texture. Unlike ''alpha blending'', alpha masking does not allow semi-transparent areas - each resultant texel is either fully textured, or fully transparent. Alpha masking is a fully hardware-accelerated technique, and so acceptable.
* '''Asset''' - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files.
** Sometimes, even frequently,... used (incorrectly) interchangeably with ''''content''''; technically, content is an asset included in a route or session—until then an asset is an potential content item.
** Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* '''[http://www.blender.org Blender]''' - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* '''[[KIND_Bogey|Bogey]]''' - Asset type used to represent wheels and suspension components. Used for anything that needs to rotate as the train moves along the track (e.g. wheels), or move (by rotation or translation) to match the angle and position of the track (e.g. subframe and suspension components). In the US this is normally referred to as a ''truck'', and in the UK as a ''bogie''.
* '''Bump mapping''' - Another term for ''Normal mapping''.
</big>

====Ca to Md====
<big>
* '''Cab / Cabin / Interior''' - Asset made to represent the inside of an object, typically a ''Vehicle''.
* '''[[Content Manager]]''' - Program for querying and editing the ''Trainz Asset Database''.
** Common tasks performed with Content Manager include downloading, uploading, installing, editing, archiving, error trapping (testing for, generation of) and removing content.
* '''Dependency''' - An ''asset'' which is required by this asset in order to function properly.
* '''Dependent''' - An ''asset'' which requires this asset in order to function properly.{{FAB-todo|This is unclear, dependent asset and dependencies are different CM drop down menu choices. Clarify!}}
* '''Geometry''' - A three-dimensional ''mesh'', without any related textures or material properties.
* '''{{wp|GMAX}}''' -A 3D modeling tool originally produced by Discreet for use in producing game assets. While still available, the software has not been in active development for some time, and is not considered to be a state of the art tool for Trainz asset creation. See also 3DSMax.
* '''Indices''' - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* '''[[KUID]]''' - Unique identifier for a specific Trainz ''asset''. Consists of Creator ID, Content ID and Version number fields.
* '''[[Kuid-table_container|KUID Table]]''' - The [[Kuid-table_container|kuid-table container]] of an asset's [[config.txt file]]. Used to specify ''dependencies''.
* {{wp|Level of detail|Level-Of-Detail}} (LOD)''' - A technique where an object (typically a mesh) is built with a number of variations which look as close as possible to identical, but which trade off quality as distance from the viewing point increases and that aids rendering performance to differing degrees.
** The [[Auran JET]] graphics engine selects between the various levels at runtime based on metrics such as distance from the observer.
** For textures, ''mip-mapping'' serves a similar purpose without requiring manual attention.
** All medium-to-high-detail meshes should supply LOD variants. [[LM.txt_file]]s are used for LOD on moving/animated models.
* '''[[Material_Types|Material]]''' - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* '''MAX / {{wp|3D Studio Max}}''', or obsolescent {{wp|Gmax}} once bundled with early Trainz retail releases - The commercial [[Modeling]] tool used and supported by Auran.
</big>

====Me to Qz====
<big>
* '''{{wp|Polygon mesh|Mesh}}''' - A three-dimensional ''model'' used in the game environment. The word ''mesh'' is often used to refer to a specific game file containing the three-dimensional ''geometry'' without related properties such as the model's textures.
* '''Mesh Library''' - An asset which other assets use. These assets refer to the mesh library by KUID, using a 'mesh-asset' tag in their mesh table. Nothing special is needed for an asset to be a mesh library, it just has to contain mesh files.
* '''[[Mesh stitching]]''' - A runtime optimization process which combines multiple individual mesh instances into a single ''draw call'' for performance reasons. This results in higher performance with no visible changes.
* '''[["mesh-table"_Container|Mesh Table]]''' - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* '''[[Mip mapping]]''' - Process to reduce texture detail for objects in the distance, or at a sharp angle to the camera. Used to avoid problems with aliasing (flicker), which can occur where the texture is of comparable or higher detail than the display equipment.
* '''Model''' - A {{wp|three-dimensional}} definition of an {{wp|virtual reality|virtual}} 3D object, built in a special [[modeling]] package such as Blender or Max. The word ''model'' is often used to describe the concept of a three-dimensional object including properties such as its textures.
* '''[[Normal map|Normal mapping]]''' - A more advanced form of ''texture mapping'' which allows per-pixel control over the lighting conditions on the target geometry. Among other benefits, this technique allows a content creator to define small bumps and grooves in a surface in addition to simple coloration.
* '''Obsolete''' - An ''asset'' is obsolete if it has been replaced by a newer version with newer technology models and definitions, breaking the asset in part for a new [["Trainz-build" tag]] (version).
** A container type or tag in a [[KIND]] is obsolete because the programmers say so—because they have a real need to change the {{wp|data structure}} in a new Trainz advance, ''normally without warning the user community first.''
* '''[["String-table" container|String Table]]''' - The [["String-table" container]] of an asset's [[config.txt file]]. Used for localization strings (i.e. anything that will be displayed to the user).
* '''Pixel''' - One individual point on a ''texture'' image, consisting of red, green, blue and alpha components (e.g. a texture size of 512 pixels by 512 pixels). May also refer to one individual point within a display (e.g. a display size of 1024 pixels by 768 pixels).
* '''Polygons''' - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
</big>

====Ra to Tq====
<big>
* '''Render call''' / '''Draw call''' - A single hardware rendering operation. This is an important concept when performance is a concern, as there is a substantial performance overhead to each draw call. By minimizing the number of draw calls, the same scene can be rendered at a notably higher frame rate. Each draw call associates one ''material'' with some quantity of ''vertices'' and ''indices''.
* [[KIND_Map|Route / Layout / Map]] - Asset created in ''Surveyor'', consisting of a textured landscape and one or more ''Layers'' containing ''scenery objects'', ''splines'', ''trackside objects'', ''Vehicles'', etc.
* '''[[KIND_Scenery|Scenery]]''' / '''Map object''' - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* '''[[KIND_Profile|Session]]''' - Asset created in surveyor, which extends a ''map'' by placing on it additional layers of objects - commonly ''Vehicles'', but any ''scenery object'', ''spline'', ''trackside object'', etc, can also be added. The Session also contains all the saved script data from any asset in the combination of map and session.
* '''Specular lighting''' - Lighting effects that vary dependent on the angle of incident light.
* '''[[KIND_Track|Spline]]''' - A continuous linear 3D model such as a hedge, a fence, a road, or a track. Splines are placed in Surveyor as a series of ''spline control points'' and the geometry is built in a smoothed path between the control points.
* '''Texel''' - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* '''Texture''' - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* '''Texture Sharing''' - When two or more ''{{wp|Polygon mesh|meshes}}'' in the same asset (which may be a ''mesh library'', and thus used by many assets) use the same ''material'' and ''texture''. Trainz can then use ''mesh stitching'' to render them in the same ''draw call'', with corresponding performance improvements.
</big>
====Tr to Zz====
<big>
* '''[[KIND_Scenery-trackside|Trackside object]]''' - A trackside object is a specialisation of a ''[[scenery object]]'' that is placed attached to a spline. When the spline is moved, the trackside object is also moved.
* '''[[Scripting|TrainzScript]]''' / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* '''Trainz Asset Database''' - Contains all the metadata information about Trainz content. Editable through [[Content Manager]] and [[TrainzUtil]].
* '''TrainzUtil''' - Command line tool to query and edit the ''Trainz Asset Database''.
* '''Trainz Native Interface''' - TBD
* '''Triangles''' - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* '''[[KIND_Traincar|Vehicle]]''' - All ''assets'' which can be placed into a train (consist). Includes locomotives. Not to be confused with road cars, which are actually ''Trackside'' objects (as they are attached to roads).
* '''Vertices''' - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.

{{TOL-ref-bot}}
[[Category:Trainz Wiki]]<div>
{{FUN-end}}<div>{{ORP-bot}}

Content Configuration

2022-02-18T11:10:37Z

Stokia01:

{{ORP-top}}
:''For a new-user walk-through explaining how to create various types of content, see the [[HowTo]] Guides page instead.''
==Overview of Trainz Content==
This page acts as reference manual for all Trainz content, and its legal {{wp|data type}}s ([[KIND]]s) and {{wp|data structure}}s (generally, [[:category:Config Container|Containers]]). It is intended to provide accurate and concise description of the capabilities and configuration of Trainz current-version content. To the new user, particularly those with no familiarity with programming language practices, the information in this page can become a starting point to understanding. Every Trainz asset from the mighty collection of assets contained in a route to the lowliest scenery item such as imitation grass, the color of a rock or field—all have two things in common: The list of common legal tag names which begin the definition of the asset found in the [[TrainzBaseSpec]].

==Structure of a Trainz Asset==
Each item of Trainz content ("an asset") is created as the contents of a single operating system folder, containing a [[config.txt file]] and some number of supporting files and/or folders and their files. Files located in the content folder must obey the [[Filename character restrictions]] and each item should be directly relevant to the asset in question. When committed or as in newer Trainz releases, tested for validation before commitment, the asset's folder contents and the [[config.txt file]] will be validated against one another, the ideal minimum definitions will be bounced against those and each must be in balance and correct with respect to one another.

==Content Types==
Each asset built for the Trainz environment follows a preset template, which defines what tags can be included in the [[config.txt file]], what capabilities the asset will have, and how the user can manipulate the asset in-game. The following types of custom content are supported by Trainz:

{|
|-valign="top"
|
* [[KIND Achievement-category]] - Achievement category descriptor.
* [[KIND Achievement-group]] - Achievement group descriptor.
* [[KIND Asset-group]] - Asset group descriptor.
* [[KIND Behavior]] - Session rules.
* [[KIND Bogey]]
* [[KIND Buildable]] - Basic scenery object with attached track.
* [[KIND Controlset]] - Defines a set of input controls
* [[KIND Drivercharacter]]
* [[KIND Drivercommand]]
* [[KIND Engine]]
* [[KIND Enginesound]]
* [[KIND Environment]] - Defines a set of skies.
* [[KIND Fixedtrack]]
* [[KIND Gameplaymenu]] - Main menu page.
* [[KIND Groundtexture]] - Textures for painting the ground.
* [[KIND Hornsound]]
* [[KIND HTML-asset]]
* [[KIND Industry]] - Scenery object with attached track and product processing functionality.
* [[KIND Interior]]
* [[KIND Interlocking-Tower|KIND Interlocking-Tower]]
* [[KIND Library]] - Script Libraries.
* [[KIND Map]] - Routes.
* [[KIND Mesh]]
|
* [[KIND MOCrossing]] - Grade crossings.
* [[KIND MOJunction]] - Junction levers.
* [[KIND MOSignal]] - Railroad signals.
* [[KIND MOSpeedboard]]
* [[KIND Pantograph]]
* [[KIND Product]]
* [[KIND Product-category]]
* [[KIND Profile]] - Sessions.by an older title
* [[KIND Region]] - Defines the area of the world, as well as traffic style.
* [[KIND Scenery]] - A basic object.
* [[KIND Scenery-trackside]] - Object that attaches to track.
* [[KIND Servlet]] - An iTrainz servlet daemon.
* [[KIND Steam-engine]]
* [[KIND Texture]] - A texture defined for use in other objects.
* [[KIND Texture-group]] - A group of textures defined for use with other objects.
* [[KIND Track]] - (including Bridges and Tunnels) and scenery splines are built using TS2009 Stitched track.
* [[KIND Tracksound]]
* [[KIND Traincar]] - Locomotives and Rolling Stock.
* [[KIND Turntable]]
* [[KIND Water2]] - Water for rivers / seas.
|}

==Category Tags==
Category tags are an aid to sorting and selecting appropriate content that would be found in a time or place, or of narrowing down a particular sort of asset (Category Class codes), mainly in filters and when running [[Content Manager]].
*[[Category Class]] - For Category search.
*[[Category Region]] - For Region search
*[[Category Era]] - For Era Search
==Feedback==
[[Content Configuration Feature Requests]] - ''ask here for new config.txt files features''

==Categories==
Categories are the sometimes overlooked superhighways of getting around in a Wiki project, and the user will find these listed are index pages to finding things faintly remembered efficiently and effectively:
*[[:Category:Asset KIND]]
*[[:Category:Config Container]]
*[[:Category:Config Tag]]
*[[:Category:Content configuration]]

==See also==
The following category pages will list and index Trainz specific articles throughout this Wiki
*[[:Category:Trainz fundamentals pages]]
*[[:Category:Trainz reference pages]]
*[[:Category:Trainz Wiki]]
{{ORP-bot}}

[[Modeling]]
[[Content creation]]

CCG/Common Tags

2022-02-18T11:00:50Z

Stokia01: /* trainz-build */

==Common Tags==
The following tags are present in all kinds.

====kuid====
:The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated.
:See Page 4 for more information on kuids.
:Example value: "56113:1107:0"

====trainz-build====
:The [["trainz-build"_number]] for which the asset was created. TS12 assets will have a trainz-build number of 3.5, automatically generated from CCP.
TS12 SP1 3.6
TS12 3.5
TS2010 SP2 3.4
TS2010 SP1 3.3
TS2010 3.2
TS2009 SP2 3.1
TS2009 SP1 3.0
TS2009 2.9
TC3 2.8
TC & TC2 2.7
TRS2006 SP1 2.6
TRS2006 2.5
TRS2004 SP4 2.4
TRS2004 SP3 2.3
TRS2004 SP2 2.2
TRS2004 SP1 2.1
TRS2004 2.0
UTC 1.5
Trainz SP3 1.3
Trainz 1.2 1.2
Trainz 1.1.1 1.11
Trainz 1.1 1.1
Trainz CE 1.0

:'''Note:''' When editing an asset in Content Creator Plus, the trainz-build will automatically be upgraded to whatver version of Trainz you are running in order to support newly added tags and functions.

:Example Value: "2.5"

====category-class====
:The class code for this asset. A full list of class codes is provided in the Chapter 11 [[Category Class]] appendix.

:The category-class has been in use since Trainz SP3.

:Example Value: "LM" - Monorail Vehicles

====category-region====
:The region code for this asset. A full list of region codes is provided in the Chapter 11 [[Category_Region|Region Codes]] appendix.
:This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "AD;AE;AU"

====category-era====
:The era code for this asset. A full list of era codes is provided in the Chapter 11 [[Category_Era|Era Codes]] appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line.

:A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "1990s;2000s"

====Username cn, cz, de, es,fr, it, pl, ru====
:The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
:username-cn - Chinese
:username-cz - Czech
:username-de - German
:username-es - Spanish
:username-fr - French
:username-it - Italian
:username-nl - Dutch
:username-pl - Polish
:username-ru - Russian

:Example Value: "testActivity”

====kind====
:The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind.
:See Chapter 2 for a complete list of kinds.

:Example Value: "MOSignal"

====description cn, cz, de, es, fr, it, pl, ru====
:The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
:description-cn - Chinese
:description-cz - Czech
:description-de - German
:description-es - Spanish
:description-fr - French
:description-it - Italian
:description-pl - Polish
:description-ru - Russian

:Example Value: "This is a test activity written for the 2006 CCG."

====author====
:The human-readable author name text. This is an optional tag.

:Example Value: "Scott Cameron"

====organisation====
:The organisation name as specified by the asset author. This is an optional tag.

:Example Value: "Auran"

====contact-email====
:Email address specified by the asset author. This is an optional tag.

:Example Value: "helpdesk@auran.com"

====contact-website====
:Website URL specified by the asset author. This is an optional tag.

:Example Value: "www.auran.com"

====category-keywords====
:To improve the search-ability of assets, generic search keywords may be included in the config.txt file.
:Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible.
:Keywords are separated by a semicolon. White space is not permitted within the category-keywords tag.

:Example Value: "scott;auran;example;ccg;test"

====license====
:The asset's license agreement as written by the author. This is an optional tag.

:Example Value "This is an example license."

[[CCG/Common Containers and Tags|Common Containers and Tags]]

[[CCG/Common Containers|Common Containers]]

==Return to CCG Index==
[[Content Creator's Guide]]

CCG/Common Tags

2022-02-18T10:58:22Z

Stokia01: /* trainz-build */

==Common Tags==
The following tags are present in all kinds.

====kuid====
:The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated.
:See Page 4 for more information on kuids.
:Example value: "56113:1107:0"

====trainz-build====
:The [["Trainz-build"_number]] for which the asset was created. TS12 assets will have a trainz-build number of 3.5, automatically generated from CCP.
TS12 SP1 3.6
TS12 3.5
TS2010 SP2 3.4
TS2010 SP1 3.3
TS2010 3.2
TS2009 SP2 3.1
TS2009 SP1 3.0
TS2009 2.9
TC3 2.8
TC & TC2 2.7
TRS2006 SP1 2.6
TRS2006 2.5
TRS2004 SP4 2.4
TRS2004 SP3 2.3
TRS2004 SP2 2.2
TRS2004 SP1 2.1
TRS2004 2.0
UTC 1.5
Trainz SP3 1.3
Trainz 1.2 1.2
Trainz 1.1.1 1.11
Trainz 1.1 1.1
Trainz CE 1.0

:'''Note:''' When editing an asset in Content Creator Plus, the trainz-build will automatically be upgraded to whatver version of Trainz you are running in order to support newly added tags and functions.

:Example Value: "2.5"

====category-class====
:The class code for this asset. A full list of class codes is provided in the Chapter 11 [[Category Class]] appendix.

:The category-class has been in use since Trainz SP3.

:Example Value: "LM" - Monorail Vehicles

====category-region====
:The region code for this asset. A full list of region codes is provided in the Chapter 11 [[Category_Region|Region Codes]] appendix.
:This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "AD;AE;AU"

====category-era====
:The era code for this asset. A full list of era codes is provided in the Chapter 11 [[Category_Era|Era Codes]] appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line.

:A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "1990s;2000s"

====Username cn, cz, de, es,fr, it, pl, ru====
:The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
:username-cn - Chinese
:username-cz - Czech
:username-de - German
:username-es - Spanish
:username-fr - French
:username-it - Italian
:username-nl - Dutch
:username-pl - Polish
:username-ru - Russian

:Example Value: "testActivity”

====kind====
:The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind.
:See Chapter 2 for a complete list of kinds.

:Example Value: "MOSignal"

====description cn, cz, de, es, fr, it, pl, ru====
:The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
:description-cn - Chinese
:description-cz - Czech
:description-de - German
:description-es - Spanish
:description-fr - French
:description-it - Italian
:description-pl - Polish
:description-ru - Russian

:Example Value: "This is a test activity written for the 2006 CCG."

====author====
:The human-readable author name text. This is an optional tag.

:Example Value: "Scott Cameron"

====organisation====
:The organisation name as specified by the asset author. This is an optional tag.

:Example Value: "Auran"

====contact-email====
:Email address specified by the asset author. This is an optional tag.

:Example Value: "helpdesk@auran.com"

====contact-website====
:Website URL specified by the asset author. This is an optional tag.

:Example Value: "www.auran.com"

====category-keywords====
:To improve the search-ability of assets, generic search keywords may be included in the config.txt file.
:Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible.
:Keywords are separated by a semicolon. White space is not permitted within the category-keywords tag.

:Example Value: "scott;auran;example;ccg;test"

====license====
:The asset's license agreement as written by the author. This is an optional tag.

:Example Value "This is an example license."

[[CCG/Common Containers and Tags|Common Containers and Tags]]

[[CCG/Common Containers|Common Containers]]

==Return to CCG Index==
[[Content Creator's Guide]]

CCG/Common Tags

2022-02-18T10:57:55Z

Stokia01: /* trainz-build */

==Common Tags==
The following tags are present in all kinds.

====kuid====
:The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated.
:See Page 4 for more information on kuids.
:Example value: "56113:1107:0"

====trainz-build====
:The [["Trainz_build"_number]] for which the asset was created. TS12 assets will have a trainz-build number of 3.5, automatically generated from CCP.
TS12 SP1 3.6
TS12 3.5
TS2010 SP2 3.4
TS2010 SP1 3.3
TS2010 3.2
TS2009 SP2 3.1
TS2009 SP1 3.0
TS2009 2.9
TC3 2.8
TC & TC2 2.7
TRS2006 SP1 2.6
TRS2006 2.5
TRS2004 SP4 2.4
TRS2004 SP3 2.3
TRS2004 SP2 2.2
TRS2004 SP1 2.1
TRS2004 2.0
UTC 1.5
Trainz SP3 1.3
Trainz 1.2 1.2
Trainz 1.1.1 1.11
Trainz 1.1 1.1
Trainz CE 1.0

:'''Note:''' When editing an asset in Content Creator Plus, the trainz-build will automatically be upgraded to whatver version of Trainz you are running in order to support newly added tags and functions.

:Example Value: "2.5"

====category-class====
:The class code for this asset. A full list of class codes is provided in the Chapter 11 [[Category Class]] appendix.

:The category-class has been in use since Trainz SP3.

:Example Value: "LM" - Monorail Vehicles

====category-region====
:The region code for this asset. A full list of region codes is provided in the Chapter 11 [[Category_Region|Region Codes]] appendix.
:This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "AD;AE;AU"

====category-era====
:The era code for this asset. A full list of era codes is provided in the Chapter 11 [[Category_Era|Era Codes]] appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line.

:A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "1990s;2000s"

====Username cn, cz, de, es,fr, it, pl, ru====
:The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
:username-cn - Chinese
:username-cz - Czech
:username-de - German
:username-es - Spanish
:username-fr - French
:username-it - Italian
:username-nl - Dutch
:username-pl - Polish
:username-ru - Russian

:Example Value: "testActivity”

====kind====
:The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind.
:See Chapter 2 for a complete list of kinds.

:Example Value: "MOSignal"

====description cn, cz, de, es, fr, it, pl, ru====
:The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
:description-cn - Chinese
:description-cz - Czech
:description-de - German
:description-es - Spanish
:description-fr - French
:description-it - Italian
:description-pl - Polish
:description-ru - Russian

:Example Value: "This is a test activity written for the 2006 CCG."

====author====
:The human-readable author name text. This is an optional tag.

:Example Value: "Scott Cameron"

====organisation====
:The organisation name as specified by the asset author. This is an optional tag.

:Example Value: "Auran"

====contact-email====
:Email address specified by the asset author. This is an optional tag.

:Example Value: "helpdesk@auran.com"

====contact-website====
:Website URL specified by the asset author. This is an optional tag.

:Example Value: "www.auran.com"

====category-keywords====
:To improve the search-ability of assets, generic search keywords may be included in the config.txt file.
:Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible.
:Keywords are separated by a semicolon. White space is not permitted within the category-keywords tag.

:Example Value: "scott;auran;example;ccg;test"

====license====
:The asset's license agreement as written by the author. This is an optional tag.

:Example Value "This is an example license."

[[CCG/Common Containers and Tags|Common Containers and Tags]]

[[CCG/Common Containers|Common Containers]]

==Return to CCG Index==
[[Content Creator's Guide]]

CCG/Common Tags

2022-02-18T10:57:20Z

Stokia01: /* trainz-build */

==Common Tags==
The following tags are present in all kinds.

====kuid====
:The "unique identifier" number for the asset. When creating new assets with Content Creator Plus, the asset kuid will be automatically generated.
:See Page 4 for more information on kuids.
:Example value: "56113:1107:0"

====trainz-build====
:The [["Trainz build" number]] for which the asset was created. TS12 assets will have a trainz-build number of 3.5, automatically generated from CCP.
TS12 SP1 3.6
TS12 3.5
TS2010 SP2 3.4
TS2010 SP1 3.3
TS2010 3.2
TS2009 SP2 3.1
TS2009 SP1 3.0
TS2009 2.9
TC3 2.8
TC & TC2 2.7
TRS2006 SP1 2.6
TRS2006 2.5
TRS2004 SP4 2.4
TRS2004 SP3 2.3
TRS2004 SP2 2.2
TRS2004 SP1 2.1
TRS2004 2.0
UTC 1.5
Trainz SP3 1.3
Trainz 1.2 1.2
Trainz 1.1.1 1.11
Trainz 1.1 1.1
Trainz CE 1.0

:'''Note:''' When editing an asset in Content Creator Plus, the trainz-build will automatically be upgraded to whatver version of Trainz you are running in order to support newly added tags and functions.

:Example Value: "2.5"

====category-class====
:The class code for this asset. A full list of class codes is provided in the Chapter 11 [[Category Class]] appendix.

:The category-class has been in use since Trainz SP3.

:Example Value: "LM" - Monorail Vehicles

====category-region====
:The region code for this asset. A full list of region codes is provided in the Chapter 11 [[Category_Region|Region Codes]] appendix.
:This is similar in function to the category-region-XX tags which have been in use since Trainz SP3, however category-region has been reformatted to allow multiple regions on a single line. A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "AD;AE;AU"

====category-era====
:The era code for this asset. A full list of era codes is provided in the Chapter 11 [[Category_Era|Era Codes]] appendix. This is similar in function to the category-era-XX tags which have been in use since Trainz SP3, however category-era has been reformatted to allow multiple eras on a single line.

:A semicolon is used to separate individual values. White space is not permitted.

:Example Value: "1990s;2000s"

====Username cn, cz, de, es,fr, it, pl, ru====
:The human-readable name of the asset. The username tag is mandatory. To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
:username-cn - Chinese
:username-cz - Czech
:username-de - German
:username-es - Spanish
:username-fr - French
:username-it - Italian
:username-nl - Dutch
:username-pl - Polish
:username-ru - Russian

:Example Value: "testActivity”

====kind====
:The asset kind, chosen in CCP and must be one of the Auran-supplied asset kinds. i.e. kind industry. Once you have selected a Kind, it cannot be changed from within the CCP editor. For example, you are making a Kind Scenery asset and have entered some data, and then realise you would like to have trains pick up products at the model, and this option is not available for Kind Scenery. You need to scrap the asset and select Kind Buildable and re-enter the data in this Kind.
:See Chapter 2 for a complete list of kinds.

:Example Value: "MOSignal"

====description cn, cz, de, es, fr, it, pl, ru====
:The human readable description of the asset. This is an optional tag. To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
:description-cn - Chinese
:description-cz - Czech
:description-de - German
:description-es - Spanish
:description-fr - French
:description-it - Italian
:description-pl - Polish
:description-ru - Russian

:Example Value: "This is a test activity written for the 2006 CCG."

====author====
:The human-readable author name text. This is an optional tag.

:Example Value: "Scott Cameron"

====organisation====
:The organisation name as specified by the asset author. This is an optional tag.

:Example Value: "Auran"

====contact-email====
:Email address specified by the asset author. This is an optional tag.

:Example Value: "helpdesk@auran.com"

====contact-website====
:Website URL specified by the asset author. This is an optional tag.

:Example Value: "www.auran.com"

====category-keywords====
:To improve the search-ability of assets, generic search keywords may be included in the config.txt file.
:Each keyword should be a lowercase word with no punctuation. Keywords should be English and as neutral as possible.
:Keywords are separated by a semicolon. White space is not permitted within the category-keywords tag.

:Example Value: "scott;auran;example;ccg;test"

====license====
:The asset's license agreement as written by the author. This is an optional tag.

:Example Value "This is an example license."

[[CCG/Common Containers and Tags|Common Containers and Tags]]

[[CCG/Common Containers|Common Containers]]

==Return to CCG Index==
[[Content Creator's Guide]]

KIND TrainzBaseSpec

2022-02-18T10:38:15Z

Stokia01: /* kind */

{{FUN-beg}}
{{ORP-top}}
==KIND Hierarchy==
[[KIND TrainzBaseSpec]] provides the basis for all Trainz asset types. It provides for a number of "Standard Tags" which are common to (or at least, can legally be defined) for any and all Trainz assets. Some of these are mandatory, most are optional and a defining line using the tag may be omitted in most sub-assets.

===Parent Classes===
* None. TrainzBaseSpec is a root class from which other Trainz Asset classes are derived.

===Child Classes===
{|
|-valign="top"
|
*  [[KIND Achievement-category]]
*  [[KIND Achievement-group]]
*  [[KIND Activity]]
*  [[KIND Asset-group]]
*  [[KIND Behavior]]
*  [[KIND Bogey]]
*  [[KIND Buildable]]
*  [[KIND Controlset]]
*  [[KIND Consist]]
*  [[KIND Drivercharacter]]
*  [[KIND Drivercommand]]
*  [[KIND Engine]]
*  [[KIND Enginesound]]
*  [[KIND Environment]]
*  [[KIND Fixedtrack]]
*  [[KIND Gameplaymenu]]
|
*  [[KIND Groundbrush]]
*  [[KIND Groundtexture]]
*  [[KIND Hornsound]]
*  [[KIND HTML-asset]]
*  [[KIND Industry]]
*  [[KIND Interior]]
*  [[KIND Library]]
*  [[Class Library]]
*  [[KIND Map]]
*  [[KIND Mesh]]
*  [[KIND Module]]
*  [[KIND MOCrossing]]
*  [[KIND MOJunction]]
*  [[KIND MOSignal]]
*  [[KIND MOSpeedboard]]
*  [[KIND Pantograph]]
|
*  [[KIND Product]]
*  [[KIND Product-category]]
*  [[KIND Profile]]
*  [[KIND Region]]
*  [[KIND Scenariobehavior]]
*  [[KIND Scenery]]
*  [[KIND Scenery-trackside]]
*  [[KIND SceneryWithTrack]]
*  [[KIND Servlet]]
*  [[KIND Steam-engine]]
*  [[KIND Texture]]
*  [[KIND Texture-group]]
*  [[KIND Track]]
*  [[KIND Tracksound]]
*  [[KIND Traincar]]
*  [[KIND Turntable]]
*  [[KIND Water2]]
|}

==Supported Tags==
The [[KIND TrainzBaseSpec]] [[config.txt file]] supports the following tags. Each tag is show here with its ''default value'':

kind ""
kuid <NULL>
trainz-build ?
script ""
class ""
script-include-table
{
}
username ""
username-XX ""
description ""
description-XX ""
kuid-table
{
}
obsolete-table
{
}
string-table
{
}
string-table-XX
{
}
category-region ""
category-class ""
category-era ""
category-keyword ""
custom-category-list ""
must-have-product-rights ""
must-not-have-product-rights ""
privileges
{
}
thumbnails
{
}
extensions
{
}
license ""
author ""
organisation ""
contact-email ""
contact-website ""
member-of-groups
{
}

 
===kind===
:''type:'' string.
:''desc:'' The asset type which this [[config.txt file]] represents. See the list: [[KIND_TrainzBaseSpec#Child_Classes|here (above)]]

===kuid===
:''type:'' [[KUID]]
:''desc:'' The unique asset ID referencing this asset.

===[[trainz-build]]===
:''type:'' floating point number (must exactly match a released Trainz version number.)
:''desc:'' The file format version to which this asset is built. This number should generally be set to the trainz version number of the Trainz installation on which the asset is being created and tested. Some asset kinds are parsed significantly differently depending on their ''trainz-build'' version tag. NOTE: The ''trainz-build'' tag is compulsory. If not specified or if left blank, Trainz will make a primitive attempt to guess at a legacy Trainz version based on the contents of the [[config.txt file]].

===script===
:''type:'' string.
:''desc:'' Indicates the filepath of the primary script file for this asset, if any. This filepath should always end in a ".gs" extension - the runtime will attempt to add or substitute a ".gs" extension if the filepath has an alternative extension.

===class===
:''type:'' string.
:''desc:'' Indicates the script class name to load as the primary class for this asset, if any. This class is loaded from the primary script file for this asset.

===script-include-table===
:''type:'' The [["script-include-table" container]].
:''desc:'' A key-value table of scripted assets which are searched for script includes when compiling this asset's script file(s). The key is currently unused but must be unique; the value indicates the KUID of the asset to include.

===username===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' The '''English''' human-visible name for this asset. This field should never contain non-English text, except where the asset name is a Proper Noun (eg. a place name) with no English localized variant.

===username-XX===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible name for this asset. This field is similar to the ''username'' field except representing a non-English locale. Multiple ''username-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'username-XX' tag is not present to represent this asset on a given end-user system, the English ''username'' tag is used instead.

===description===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' The '''English''' human-visible descriptive summary for this asset. This field should be kept to a short (1-2 paragraph) blurb describing the asset. Extended details should be provided via an ''info-url'' page. This field must be comprised of English descriptive text, although the text may reference non-English Proper Nouns as explained above.

===description-XX===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible descriptive summary for this asset. This field is similar to the ''description'' field except representing a non-English locale. Multiple ''description-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'description-XX' tag is not present to represent this asset on a given end-user system, the English ''description'' tag is used instead.

===string-table===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' A key-value list of '''English''' strings. Each key is a meaningful script identifier. Each value is an '''English''' string. As described above, an English string may comprise of or reference a non-English Proper Noun.

===string-table-XX===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) This field is similar to the ''string-table'' field except representing a non-English locale. Multiple ''string-table-XX'' tags may be present in an asset, once for each supported locale. Each should contain a list of strings with the same Keys as in the ''string-table'' list, but with different Values. If the appropriate 'string-table-XX' tag is not present to represent this asset on a given end-user system, or the appropriate string is missing from the that list, the English ''string-table'' container is referenced instead.

===kuid-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets upon which this asset is dependent. The keys may be any unique value (typically, sequential integers if the keys are meaningless, or script identifiers if the asset is to be referenced from script.) Entries in this table serve two purposes - firstly, to ensure that the game systems are aware of the dependency such that installing and loading this asset will successfully install and load any dependencies, and secondly to allow scripts to locate relevant child assets. Only first-level dependencies are included. Circular dependencies are legal. An asset cannot be listed as a dependency if it is also marked as an obsolete version of this asset. An asset cannot be listed as its own dependency.

===obsolete-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets which are made obsolete by this asset. Any attempt to load an asset referenced in this list will result in this asset being loaded instead. The assets referenced in this list must have the same creator as this asset. It is illegal for two assets to both mark a third asset obsolete, unless one of the two also marks the other as obsolete. Circular obsolete references are illegal. All lower-numbered KUID2 versions of this asset are implied as obsolete and need not be included in this list. It is illegal to mark a higher-numbered KUID2 version of this asset as obsolete as that creates an implicit circular reference.

===category-region===
:''type:'' string.
:''desc:'' A list of two-character [[Category Region]] codes, separated by semi-colons (';'). No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to each of the specified regions - this is most relevant for [[KIND Traincar]] and [[KIND MOSignal]] assets, but may be supplied for any asset.

===category-class===
:''type:'' string.
:''desc:'' A single 2-3 character [[Category Class]] code which describes this content item. The ''category-class'' tag is used to provide additional human sub-categorization beyond what is implicit from the Asset Kind. Note that many category-class codes are only relevant to specific Asset Kinds - category-class codes must not be applied to assets of an inappropriate Kind.

===category-era===
:''type:'' string.
:''desc:'' A list of five-character [[era code]]s, separated by semi-colons (';'). Each era code token must be an exact match for one of the specified legal [[era code]]s. No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to the specified era range.

===category-keyword===
:''type:'' UTF-8 string.
:''desc:'' A list of natural-language keywords, separated by semi-colons (';'). No other characters (including whitespace or irrelevant punctuation) should be present in the string. These keywords form the basis for asset keyword searching. The asset's name need not be repeated in the ''category-keyword'' list. Various [[default search keywords]] are supplied automatically based on the asset type.

:''comments:'' The asset creator should consider how a Trainz user might search for an assets. For example, a user looking for a narrow gauge steam locomotive used on a South African railway. This is an example from one of EDH6's locos:

:category-keywords "steam;SAS;2ft;NG24;24in;Narrow;Gauge;Beira;Railways;South;African;suid;afrikaanse;spoorwee"

:Alternatively a Viennese tram:

:category-keywords: "electric;tram;tramcar;trolley;trolleycar;streetcar;vienna;viennese"

:Adding non-english equivalents can be useful.

===custom-category-list===
:''see also related details in: [[Category List]], and [[custom category identifier]]''
:''type:'' ascii string.
:''desc:'' A list of custom category identifiers, separated by semi-colons (';'). Each [[custom category identifier]] should be a short (eg. 3-6 character) alphanumeric token. No other characters (including whitespace) should be present in the string. These custom categories are used to enable scripts to rapidly locate certain classes of asset. It is strongly recommended that new custom category identifiers are introduced sparingly. The ''custom-category-list'' tag value may have no more than 64 characters total. This tag should be left blank unless there is an existing specific script requirement that can only be fulfilled via the custom-category-list approach.

===must-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of required product rights, separated by semi-colons (';'). If the local installation does not have the required product rights then the asset may not be loaded by certain game systems.

===must-not-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of conflicting product rights, separated by semi-colons (';'). If the local installation has one of the listed product rights then the asset may not be loaded by certain game systems.

===privileges===
:''type:'' The [["privileges" container]].
:''desc:'' A set of privileges set by the asset creator to control how this asset can be used.

===thumbnails===
:''type:'' The [["Thumbnails" container]].
:''desc:'' The thumbnail(s) which are used to represent this asset in 2D preview boxes, lists, and icon form throughout the game environment (including in-game, in [[Content Manager]], and on the [[Download Station]].)

===extensions===
:''type:'' The [["Extensions" container]].
:''desc:'' A set of extended attributes which provide additional information to scripts beyond the [[Config.txt file]] specifications defined for this asset type. Care should be taken to abide by the extensions naming guidelines when creating a new extension, and to abide by the extension-creator's guidelines when providing data for an existing extension. Auran reserves the right to add validation for specific entries in the [["Extensions" container]] at a later date, based on the extension-creator's guidelines.

===license===
:''type:'' UTF-8 multi-line string.
:''desc:'' A license describing how the asset creator would like this asset to be used. The meaning of the ''license'' tag is ambiguous and its usage is not recommended. Content uploaded to the [[Download Station]] or provided for inclusion into the game may be under a specific redistribution contract or license agreement which supersedes any text in this field. The license field does not provide for localization support. The text of the license field is not validated or enforced by Auran and may or may not be legally binding to end users.

===author===
:''type:'' UTF-8 string.
:''desc:'' The author's name or mark. The use of this field is not recommended as attribution can be determined programmatically.

===organisation===
:''type:'' UTF-8 string.
:''desc:'' The name or mark of the organization responsible for the creation of this asset. The use of this field is not recommended as attribution can be determined programmatically.

===contact-email===
:''type:'' email address string.
:''desc:'' The contact email address for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===contact-website===
:''type:'' URL string.
:''desc:'' The contact website for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===info-url===
:''type:'' URL string.
:''desc:'' A link to an online description of this asset. The URL must resolve to a site within the [[Trainz Online Security Zone]]. The use of custom [[Trainz Short URL]] formats is recommended to future-proof the URL against possible future site layout changes. Where this tag is present, in-game buttons are provided to allow the user to view the asset description without leaving the game environment. It is recommended that generic group pages are used for entire classes of asset in any case where the assets provide similar functionality but minor differences in appearance. This reduces the time-expense of creating, maintaining and localizing such documentation.

===member-of-groups===
:''type:'' [["Member-of-groups" container]].
:''desc:'' A list of [[KIND Asset-group]] assets to which this asset belongs. See the [[KIND Asset-group]] documentation for details on how and when this is used.

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

==Categories==
[[Category:Asset KIND|$BaseSpec]]
{{ORP-bot|$BaseSpec}}
<div>{{FUN-bot|$BaseSpec}}

KIND TrainzBaseSpec

2022-02-18T10:33:26Z

Stokia01: /* kind */

{{FUN-beg}}
{{ORP-top}}
==KIND Hierarchy==
[[KIND TrainzBaseSpec]] provides the basis for all Trainz asset types. It provides for a number of "Standard Tags" which are common to (or at least, can legally be defined) for any and all Trainz assets. Some of these are mandatory, most are optional and a defining line using the tag may be omitted in most sub-assets.

===Parent Classes===
* None. TrainzBaseSpec is a root class from which other Trainz Asset classes are derived.

===Child Classes===
{|
|-valign="top"
|
*  [[KIND Achievement-category]]
*  [[KIND Achievement-group]]
*  [[KIND Activity]]
*  [[KIND Asset-group]]
*  [[KIND Behavior]]
*  [[KIND Bogey]]
*  [[KIND Buildable]]
*  [[KIND Controlset]]
*  [[KIND Consist]]
*  [[KIND Drivercharacter]]
*  [[KIND Drivercommand]]
*  [[KIND Engine]]
*  [[KIND Enginesound]]
*  [[KIND Environment]]
*  [[KIND Fixedtrack]]
*  [[KIND Gameplaymenu]]
|
*  [[KIND Groundbrush]]
*  [[KIND Groundtexture]]
*  [[KIND Hornsound]]
*  [[KIND HTML-asset]]
*  [[KIND Industry]]
*  [[KIND Interior]]
*  [[KIND Library]]
*  [[Class Library]]
*  [[KIND Map]]
*  [[KIND Mesh]]
*  [[KIND Module]]
*  [[KIND MOCrossing]]
*  [[KIND MOJunction]]
*  [[KIND MOSignal]]
*  [[KIND MOSpeedboard]]
*  [[KIND Pantograph]]
|
*  [[KIND Product]]
*  [[KIND Product-category]]
*  [[KIND Profile]]
*  [[KIND Region]]
*  [[KIND Scenariobehavior]]
*  [[KIND Scenery]]
*  [[KIND Scenery-trackside]]
*  [[KIND SceneryWithTrack]]
*  [[KIND Servlet]]
*  [[KIND Steam-engine]]
*  [[KIND Texture]]
*  [[KIND Texture-group]]
*  [[KIND Track]]
*  [[KIND Tracksound]]
*  [[KIND Traincar]]
*  [[KIND Turntable]]
*  [[KIND Water2]]
|}

==Supported Tags==
The [[KIND TrainzBaseSpec]] [[config.txt file]] supports the following tags. Each tag is show here with its ''default value'':

kind ""
kuid <NULL>
trainz-build ?
script ""
class ""
script-include-table
{
}
username ""
username-XX ""
description ""
description-XX ""
kuid-table
{
}
obsolete-table
{
}
string-table
{
}
string-table-XX
{
}
category-region ""
category-class ""
category-era ""
category-keyword ""
custom-category-list ""
must-have-product-rights ""
must-not-have-product-rights ""
privileges
{
}
thumbnails
{
}
extensions
{
}
license ""
author ""
organisation ""
contact-email ""
contact-website ""
member-of-groups
{
}

 
===kind===
:''type:'' string.
:''desc:'' The asset type which this [[config.txt file]] represents. See the list: [[KIND_TrainzBaseSpec#KIND_TrainzBaseSpec#Child_Classes|here (above)]]

===kuid===
:''type:'' [[KUID]]
:''desc:'' The unique asset ID referencing this asset.

===[[trainz-build]]===
:''type:'' floating point number (must exactly match a released Trainz version number.)
:''desc:'' The file format version to which this asset is built. This number should generally be set to the trainz version number of the Trainz installation on which the asset is being created and tested. Some asset kinds are parsed significantly differently depending on their ''trainz-build'' version tag. NOTE: The ''trainz-build'' tag is compulsory. If not specified or if left blank, Trainz will make a primitive attempt to guess at a legacy Trainz version based on the contents of the [[config.txt file]].

===script===
:''type:'' string.
:''desc:'' Indicates the filepath of the primary script file for this asset, if any. This filepath should always end in a ".gs" extension - the runtime will attempt to add or substitute a ".gs" extension if the filepath has an alternative extension.

===class===
:''type:'' string.
:''desc:'' Indicates the script class name to load as the primary class for this asset, if any. This class is loaded from the primary script file for this asset.

===script-include-table===
:''type:'' The [["script-include-table" container]].
:''desc:'' A key-value table of scripted assets which are searched for script includes when compiling this asset's script file(s). The key is currently unused but must be unique; the value indicates the KUID of the asset to include.

===username===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' The '''English''' human-visible name for this asset. This field should never contain non-English text, except where the asset name is a Proper Noun (eg. a place name) with no English localized variant.

===username-XX===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible name for this asset. This field is similar to the ''username'' field except representing a non-English locale. Multiple ''username-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'username-XX' tag is not present to represent this asset on a given end-user system, the English ''username'' tag is used instead.

===description===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' The '''English''' human-visible descriptive summary for this asset. This field should be kept to a short (1-2 paragraph) blurb describing the asset. Extended details should be provided via an ''info-url'' page. This field must be comprised of English descriptive text, although the text may reference non-English Proper Nouns as explained above.

===description-XX===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible descriptive summary for this asset. This field is similar to the ''description'' field except representing a non-English locale. Multiple ''description-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'description-XX' tag is not present to represent this asset on a given end-user system, the English ''description'' tag is used instead.

===string-table===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' A key-value list of '''English''' strings. Each key is a meaningful script identifier. Each value is an '''English''' string. As described above, an English string may comprise of or reference a non-English Proper Noun.

===string-table-XX===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) This field is similar to the ''string-table'' field except representing a non-English locale. Multiple ''string-table-XX'' tags may be present in an asset, once for each supported locale. Each should contain a list of strings with the same Keys as in the ''string-table'' list, but with different Values. If the appropriate 'string-table-XX' tag is not present to represent this asset on a given end-user system, or the appropriate string is missing from the that list, the English ''string-table'' container is referenced instead.

===kuid-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets upon which this asset is dependent. The keys may be any unique value (typically, sequential integers if the keys are meaningless, or script identifiers if the asset is to be referenced from script.) Entries in this table serve two purposes - firstly, to ensure that the game systems are aware of the dependency such that installing and loading this asset will successfully install and load any dependencies, and secondly to allow scripts to locate relevant child assets. Only first-level dependencies are included. Circular dependencies are legal. An asset cannot be listed as a dependency if it is also marked as an obsolete version of this asset. An asset cannot be listed as its own dependency.

===obsolete-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets which are made obsolete by this asset. Any attempt to load an asset referenced in this list will result in this asset being loaded instead. The assets referenced in this list must have the same creator as this asset. It is illegal for two assets to both mark a third asset obsolete, unless one of the two also marks the other as obsolete. Circular obsolete references are illegal. All lower-numbered KUID2 versions of this asset are implied as obsolete and need not be included in this list. It is illegal to mark a higher-numbered KUID2 version of this asset as obsolete as that creates an implicit circular reference.

===category-region===
:''type:'' string.
:''desc:'' A list of two-character [[Category Region]] codes, separated by semi-colons (';'). No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to each of the specified regions - this is most relevant for [[KIND Traincar]] and [[KIND MOSignal]] assets, but may be supplied for any asset.

===category-class===
:''type:'' string.
:''desc:'' A single 2-3 character [[Category Class]] code which describes this content item. The ''category-class'' tag is used to provide additional human sub-categorization beyond what is implicit from the Asset Kind. Note that many category-class codes are only relevant to specific Asset Kinds - category-class codes must not be applied to assets of an inappropriate Kind.

===category-era===
:''type:'' string.
:''desc:'' A list of five-character [[era code]]s, separated by semi-colons (';'). Each era code token must be an exact match for one of the specified legal [[era code]]s. No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to the specified era range.

===category-keyword===
:''type:'' UTF-8 string.
:''desc:'' A list of natural-language keywords, separated by semi-colons (';'). No other characters (including whitespace or irrelevant punctuation) should be present in the string. These keywords form the basis for asset keyword searching. The asset's name need not be repeated in the ''category-keyword'' list. Various [[default search keywords]] are supplied automatically based on the asset type.

:''comments:'' The asset creator should consider how a Trainz user might search for an assets. For example, a user looking for a narrow gauge steam locomotive used on a South African railway. This is an example from one of EDH6's locos:

:category-keywords "steam;SAS;2ft;NG24;24in;Narrow;Gauge;Beira;Railways;South;African;suid;afrikaanse;spoorwee"

:Alternatively a Viennese tram:

:category-keywords: "electric;tram;tramcar;trolley;trolleycar;streetcar;vienna;viennese"

:Adding non-english equivalents can be useful.

===custom-category-list===
:''see also related details in: [[Category List]], and [[custom category identifier]]''
:''type:'' ascii string.
:''desc:'' A list of custom category identifiers, separated by semi-colons (';'). Each [[custom category identifier]] should be a short (eg. 3-6 character) alphanumeric token. No other characters (including whitespace) should be present in the string. These custom categories are used to enable scripts to rapidly locate certain classes of asset. It is strongly recommended that new custom category identifiers are introduced sparingly. The ''custom-category-list'' tag value may have no more than 64 characters total. This tag should be left blank unless there is an existing specific script requirement that can only be fulfilled via the custom-category-list approach.

===must-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of required product rights, separated by semi-colons (';'). If the local installation does not have the required product rights then the asset may not be loaded by certain game systems.

===must-not-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of conflicting product rights, separated by semi-colons (';'). If the local installation has one of the listed product rights then the asset may not be loaded by certain game systems.

===privileges===
:''type:'' The [["privileges" container]].
:''desc:'' A set of privileges set by the asset creator to control how this asset can be used.

===thumbnails===
:''type:'' The [["Thumbnails" container]].
:''desc:'' The thumbnail(s) which are used to represent this asset in 2D preview boxes, lists, and icon form throughout the game environment (including in-game, in [[Content Manager]], and on the [[Download Station]].)

===extensions===
:''type:'' The [["Extensions" container]].
:''desc:'' A set of extended attributes which provide additional information to scripts beyond the [[Config.txt file]] specifications defined for this asset type. Care should be taken to abide by the extensions naming guidelines when creating a new extension, and to abide by the extension-creator's guidelines when providing data for an existing extension. Auran reserves the right to add validation for specific entries in the [["Extensions" container]] at a later date, based on the extension-creator's guidelines.

===license===
:''type:'' UTF-8 multi-line string.
:''desc:'' A license describing how the asset creator would like this asset to be used. The meaning of the ''license'' tag is ambiguous and its usage is not recommended. Content uploaded to the [[Download Station]] or provided for inclusion into the game may be under a specific redistribution contract or license agreement which supersedes any text in this field. The license field does not provide for localization support. The text of the license field is not validated or enforced by Auran and may or may not be legally binding to end users.

===author===
:''type:'' UTF-8 string.
:''desc:'' The author's name or mark. The use of this field is not recommended as attribution can be determined programmatically.

===organisation===
:''type:'' UTF-8 string.
:''desc:'' The name or mark of the organization responsible for the creation of this asset. The use of this field is not recommended as attribution can be determined programmatically.

===contact-email===
:''type:'' email address string.
:''desc:'' The contact email address for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===contact-website===
:''type:'' URL string.
:''desc:'' The contact website for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===info-url===
:''type:'' URL string.
:''desc:'' A link to an online description of this asset. The URL must resolve to a site within the [[Trainz Online Security Zone]]. The use of custom [[Trainz Short URL]] formats is recommended to future-proof the URL against possible future site layout changes. Where this tag is present, in-game buttons are provided to allow the user to view the asset description without leaving the game environment. It is recommended that generic group pages are used for entire classes of asset in any case where the assets provide similar functionality but minor differences in appearance. This reduces the time-expense of creating, maintaining and localizing such documentation.

===member-of-groups===
:''type:'' [["Member-of-groups" container]].
:''desc:'' A list of [[KIND Asset-group]] assets to which this asset belongs. See the [[KIND Asset-group]] documentation for details on how and when this is used.

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

==Categories==
[[Category:Asset KIND|$BaseSpec]]
{{ORP-bot|$BaseSpec}}
<div>{{FUN-bot|$BaseSpec}}

Talk:KIND Track

2020-06-14T01:30:26Z

Stokia01: /* Lane Widths */ new section

The tag numlanes is defined as:

... Each lane is considered to be 1.7 meters wide. ...

I placed a few sample cars on a road with those lane widths and they just barely fit when parked, just don't try to open the door. Driving would be next to impossible, no margin for error.

In the US, standard highway lanes are 3.7m (12ft). Some roads go down to 2.7m (9ft). In the UK they vary between 2.5 to 3.35 (8.2 to 19.7ft)

Is 1.7m a typo or are roads in Oz really that narrow?

== Lane Widths ==

I think this section should read...

The centre of Carz traffic travels at 1.7m from the centre of the road (i.e. a road lane should be 3.4m wide to have Carz travel in the centre of a lane)

Tutorials

2020-02-23T05:18:28Z

Stokia01:

This page lists a number of Trainz related Tutorials gathered from various links. While some may be referring to older version of Trainz, many of the concepts are the same. Just be careful when looking at a tutorial to remember some things may have changed.

If you know of additional sites or tutorials, then please add to the appropriate category here in the wiki, or if unsure how to, ask for help in the Trainz Forums.

Also, if any of the links are out of date, please update the links or remove the entries.

==General ==
*[[https://forums.auran.com/trainz/showthread.php?87067-Full-Listing-of-my-tutorials-as-of-20-03-2012/: Shane's Tutorial forum thread]] (with links)
*[[http://www.worldoftrainz.com/Pages/Tutorials.htm: WorldofTrainz (2006 but some good introductory stuff)]]

==Modelling / ==

*Blender [[https://forums.auran.com/trainz/showthread.php?115013-Blender-Tutorials-to-Model-Mechanical-Objects&highlight=tutorials: Forum post with links]]
*Blender [[https://en.wikibooks.org/wiki/Trainz/Tutorial_for_Blender#Newcomers_start_here: For newcomers]]
*Blender [[https://drive.google.com/file/d/0B1a-SR7l2w7iZ29oMjRqODNXRUE/view Building a loco (67 page .pdf)]]
*Blender [[http://www.44090digitalmodels.co.uk/tutorials/blender1.html 44090 Digital Models webpage]]
*Blender [[http://doug56.net/02BlenderForTrainz/page107.html Caydens webpage]]

*3DSMax [[http://www.zecrail.com/tutorials.html S301 Website]]

==Reskinning==

*[[https://en.wikibooks.org/wiki/Trainz/Tutorial_for_Reskinnng_a_Locomotive_using_Paint.Net: Wikibooks Tutorial]]

==Animation==
*[[HowTo/Export_Blender_FBX_Animation]]

==Scripting==
*Trainz wiki - [[Getting_Started_in_TrainzScript]]

==Trainz Wiki==
*Use the search function, check the How To Guides, or click on the Category link below.

TIP: Google is really good at finding stuff (no really!). Try typing in stuff like "Trainz route building tutorials" and you never know what you might find.

Go Back:
[[Content_Creation]]

SEE ALSO:
[[Category:Content_creation]]

Tutorials

2020-02-23T05:14:53Z

Stokia01: updated link to Caydens website

This page lists a number of Trainz related Tutorials gathered from various links. While some may be referring to older version of Trainz, many of the concepts are the same. Just be careful when looking at a tutorial to remember some things may have changed.

If you know of additional sites or tutorials, then please add to the appropriate category here in the wiki, or if unsure how to, ask for help in the Trainz Forums.

Also, if any of the links are out of date, please update the links or remove the entries.

==General ==
*[[https://forums.auran.com/trainz/showthread.php?87067-Full-Listing-of-my-tutorials-as-of-20-03-2012/: Shane's Tutorial forum thread]] (with links)
*[[http://www.worldoftrainz.com/Pages/Tutorials.htm: WorldofTrainz (2006 but some good introductory stuff)]]

==Modelling / ==

*Blender [[https://forums.auran.com/trainz/showthread.php?115013-Blender-Tutorials-to-Model-Mechanical-Objects&highlight=tutorials: Forum post with links]]
*Blender [[https://en.wikibooks.org/wiki/Trainz/Tutorial_for_Blender#Newcomers_start_here: For newcomers]]
*Blender [[https://drive.google.com/file/d/0B1a-SR7l2w7iZ29oMjRqODNXRUE/view: Building a loco (67 page .pdf)]]
*Blender [[http://www.44090digitalmodels.co.uk/tutorials/blender1.html: 44090 Digital Models webpage]]
*Blender [[http://doug56.net/02BlenderForTrainz/page107.html: Caydens webpage]]

*3DSMax [[http://www.zecrail.com/tutorials.html: S301 Website]]

==Reskinning==

*[[https://en.wikibooks.org/wiki/Trainz/Tutorial_for_Reskinnng_a_Locomotive_using_Paint.Net: Wikibooks Tutorial]]

==Animation==
*[[HowTo/Export_Blender_FBX_Animation]]

==Scripting==
*Trainz wiki - [[Getting_Started_in_TrainzScript]]

==Trainz Wiki==
*Use the search function, check the How To Guides, or click on the Category link below.

TIP: Google is really good at finding stuff (no really!). Try typing in stuff like "Trainz route building tutorials" and you never know what you might find.

Go Back:
[[Content_Creation]]

SEE ALSO:
[[Category:Content_creation]]