TrainzOnline - User contributions [en]

KIND Achievement-category

2010-03-08T12:23:28Z

James moody 2:

[[KIND Achievement-category]] provides categorization support for individual achievements within [[KIND_Achievement-group|achievement groups]]. The [[KIND Achievement-category]] asset is referenced from the achievement entry in the [[achievements_container|achievements container]] of an [[KIND_Achievement-group|achievement group]] asset using the "category" tag. Multiple achievements in the same achievement group can have different achievement categories.

=KIND Hierarchy=
==Parent Classes==
* [[KIND TrainzBaseSpec]]
==Child Classes==
* ''none.''

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

award-image ""

====award-image====
:Type: Filename
:Desc: An image file (preferably .TGA, 512x512) to use as the background for the default achievement granted html for this category. Compulsory.

=Builtins=
The built-in [[KIND Achievement-category]] assets include:

* <kuid:447264:1001> Driving Experience
* <kuid:447264:1002> Sessions
* <kuid:447264:1004> Switching Experience
* <kuid:447264:1008> Tutorials
* <kuid:447264:1023> Industries
* <kuid:447264:1024> Passengers

=Categories=
[[Category:Asset KIND]]

KIND Achievement-group

2010-03-08T12:23:25Z

James moody 2:

[[KIND Achievement-group]] defines a set of achievements for use with the Trainz achievement system.

=KIND Hierarchy=
==Parent Classes==
* [[KIND TrainzBaseSpec]]
==Child Classes==
* ''none.''

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

achievements
{
}

====achievements====
The [[Achievements_container|"achievements" container]] specifies a list of achievements contained within this achievement group.

=Downloads=
''Attach sample files here''

=Categories=
[[Category:Asset KIND]]

KIND Map

2010-03-08T12:23:23Z

James moody 2:

[[KIND Map]] is the trainz kind used for a Map / Route / Layout. Maps are created in surveyor, so for the most part, hand-editing of a map [[Config.txt_file|config file]] should not be required.

=KIND Hierarchy=
==Parent Classes==
* [[KIND TrainzBaseSpec]]
==Child Classes==
* ''none.''

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

carrate 55
holdcarz 1
info-page ""
region <NULLKUID>
workingscale 0
workingunits 0
water <KUID:-1:8009>
soundscript
{
}
world-origin
{
}
car0 <NULLKUID>
autosave 0

====carrate====
:Type: Number
:Desc: Controls the frequency road traffic appears at on the roads.

====holdcarz====
:Type: Boolean
:Desc: True if road traffic should be disabled.

====info-page====
:Type: Filename
:Desc: No longer used.

====region====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Region|Region]] asset that this map is set in.

====workingscale====
:Type: Number
:Desc: Index of the option picked for the world 'scale' in surveyor.

0 - 1:1 (Real Scale)
1 - 1:22.5 (G Scale)
2 - 1:24 (Half Inch scale)
3 - 1:32 (1 scale)
4 - 1:48 (0 scale)
5 - 1:64.5 (S scale)
6 - 1:76.2 (00 scale)
7 - 1:87.1 (HO scale)
8 - 1:120 (TT scale)
9 - 1:160 (N scale)
10 - 1:220 (Z scale)

====workingunits====
:Type: Number
:Desc: 0 for metric (speed in km/h, distances in metres), 1 for imperial (speed in mph, distances in feet).

====water====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Water2|water]] asset that this map uses.

====soundscript====
:Type: Container
:Desc: [[%22soundscript%22_Container|SoundScript Container]] to specify ambient sound in this map.

====world-origin====
:Type: Container
:Desc: World origin container

====car0====
:Type: [[KUID]]
:Desc: KUID of car to add to the pool of available road traffic provided by the region.

This is a sequence - increment the number to add more cars.

====autosave====
:Type: boolean
:Desc: True if this map was generated by the surveyor auto-save process.

=Categories=
[[Category:Asset KIND]]

KIND Profile

2010-03-08T12:23:19Z

James moody 2:

[[KIND Profile]] is the trainz kind used for a session. Sessions are created in surveyor, so hand-editing of a session [[Config.txt_file|config file]] should not be required.

=KIND Hierarchy=
==Parent Classes==
* [[KIND TrainzBaseSpec]]
==Child Classes==
* ''none.''

=Supported Tags=
Each profile (session) asset supports the following tags. Each tag is shown here with its default value.

info-page ""
map-kuid <NULLKUID>
autosave 0

====info-page====
:Type: Filename
:Desc: No longer used.

====map-kuid====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Map|map]] that this profile (session) uses.

====autosave====
:Type: boolean
:Desc: True if this session was generated by the surveyor auto-save process.

=Categories=
[[Category:Asset KIND]]

KIND Map

2010-03-04T17:35:36Z

James moody 2: New page: KIND Map is the trainz kind used for a Map / Route / Layout. Maps are created in surveyor, so for the most part, hand-editing of a map config file should not be req...

[[KIND Map]] is the trainz kind used for a Map / Route / Layout. Maps are created in surveyor, so for the most part, hand-editing of a map [[Config.txt_file|config file]] should not be required.

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

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

carrate 55
holdcarz 1
info-page ""
region <NULLKUID>
workingscale 0
workingunits 0
water <KUID:-1:8009>
soundscript
{
}
world-origin
{
}
car0 <NULLKUID>
autosave 0

====carrate====
:Type: Number
:Desc: Controls the frequency road traffic appears at on the roads.

====holdcarz====
:Type: Boolean
:Desc: True if road traffic should be disabled.

====info-page====
:Type: Filename
:Desc: No longer used.

====region====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Region|Region]] asset that this map is set in.

====workingscale====
:Type: Number
:Desc: Index of the option picked for the world 'scale' in surveyor.

0 - 1:1 (Real Scale)
1 - 1:22.5 (G Scale)
2 - 1:24 (Half Inch scale)
3 - 1:32 (1 scale)
4 - 1:48 (0 scale)
5 - 1:64.5 (S scale)
6 - 1:76.2 (00 scale)
7 - 1:87.1 (HO scale)
8 - 1:120 (TT scale)
9 - 1:160 (N scale)
10 - 1:220 (Z scale)

====workingunits====
:Type: Number
:Desc: 0 for metric (speed in km/h, distances in metres), 1 for imperial (speed in mph, distances in feet).

====water====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Water2|water]] asset that this map uses.

====soundscript====
:Type: Container
:Desc: [[%22soundscript%22_Container|SoundScript Container]] to specify ambient sound in this map.

====world-origin====
:Type: Container
:Desc: World origin container

====car0====
:Type: [[KUID]]
:Desc: KUID of car to add to the pool of available road traffic provided by the region.

This is a sequence - increment the number to add more cars.

====autosave====
:Type: boolean
:Desc: True if this map was generated by the surveyor auto-save process.

=Categories=
[[Category:Asset KIND]]

KIND Profile

2010-03-04T16:49:52Z

James moody 2:

[[KIND Profile]] is the trainz kind used for a session. Sessions are created in surveyor, so hand-editing of a session [[Config.txt_file|config file]] should not be required.

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

=Supported Tags=
Each profile (session) asset supports the following tags. Each tag is shown here with its default value.

info-page ""
map-kuid <NULLKUID>
autosave 0

====info-page====
:Type: Filename
:Desc: No longer used.

====map-kuid====
:Type: [[KUID]]
:Desc: KUID of [[KIND_Map|map]] that this profile (session) uses.

====autosave====
:Type: boolean
:Desc: True if this session was generated by the surveyor auto-save process.

=Categories=
[[Category:Asset KIND]]

KIND Profile

2010-03-04T16:48:21Z

James moody 2: New page: KIND Profile is the trainz kind used for a session. Sessions are created in surveyor, so hand-editing of a session config file should not be required. =KIND Hierar...

[[KIND Profile]] is the trainz kind used for a session. Sessions are created in surveyor, so hand-editing of a session [[Config.txt_file|config file]] should not be required.

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

=Supported Tags=
Each profile (session) asset supports the following tags. Each tag is shown here with its default value.

info-page ""
map-kuid <NULLKUID>
autosave 0

====info-page====
:Type: Filename
:Desc: No longer used.

====map-kuid====
:Type: [[KUID]]
:Desc: KUID of map that this profile (session) uses.

====autosave====
:Type: boolean
:Desc: True if this session was generated by the surveyor auto-save process.

=Categories=
[[Category:Asset KIND]]

Terminology

2010-03-04T16:36:18Z

James moody 2:

This page describes some of the more common train-related, content-creation-related, and general 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 TS2009 content creation, and terms which are meaningless in this context may be removed.

=General Train Terminology=

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

TBD.

=Trainz Content Creation=
* [[Scripting|TrainzScript]] / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* Model - A three-dimensional 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.
* 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.
* Texture - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* Material - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* Asset - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files. Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* 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''.
* [[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.
* [[Alpha blending]] - The process of using an opacity setting or texture alpha channel to allow partial transparency. Alpha blending is a hardware operation, however by itself blending does not combine well with a traditional hardware 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.
* 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).
* Texel - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* Polygons - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
* Indices - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* Vertices - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.
* Triangles - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* 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.
* Texture Sharing - When two or more ''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.
* 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.
* [[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_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.
* [[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).
* [[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.
* Map object / [[KIND_Scenery|Scenery]] object - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* [[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.
* [[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''.
* 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.
* [[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.
* Bump mapping - Another term for ''Normal mapping''.
* Specular lighting - Lighting effects that vary dependent on the angle of incident light.
* 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 and performance to differing degrees. The 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.
* 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
* [["mesh-table"_Container|Mesh Table]] - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* [[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''.
* 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.
* Obsolete - An ''asset'' is obsolete if it has been replaced by a newer version.
* [[String-table_container|String Table]] - The [[String-table_container|string-table container]] of an asset's [[config.txt file]]. Used for translatable strings (i.e. anything that will be displayed to the user).
* Cab / Cabin / Interior - Asset made to represent the inside of an object, typically a ''Vehicle''.
* MAX / 3D Studio Max - The commercial [[Modeling]] tool used and supported by Auran.
* [http://www.blender.org Blender] - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* [[Content Manager]] - Program for querying and editing the ''Trainz Asset Database''. Common tasks performed with Content Manager include downloading, installing, editing, archiving and removing content.
* Geometry - A three-dimensional ''mesh'', without any related textures or material properties.

=File Formats=
* [[config.txt file]]
* .texture.txt file
* .texture file
* .pm file
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

=Abbreviations=
* TAD - Trainz Asset Database.
* CM - Content Manager.
* LOD - Level-Of-Detail.
* IM - Indexed Mesh file format.
* PM - Progressive Mesh file format.
* LM - Level-of-detail Mesh file format.
* TNI - Trainz Native Interface.

"Achievements" container

2010-03-04T16:23:51Z

James moody 2:

The [[achievements_container|achievements container]] is a top-level [[config.txt file]] entry used by [[KIND_Achievement-group|achievement group]] assets.

The achievements container is a list of achievement subcontainers with no standalone tags. Each achievement subcontainer uses the following format.

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

name ""
description ""
category <NULLKUID>
awarded-html ""
icon ""
conditions
{
}

====name====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible name of the achievement in it. This string table entry will be used in the Trainz user interface to refer to the achievement. It should be fairly short.

====description====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible description of the achievement in it. This string table entry will be used in the Trainz user interface to give detail to the user about the achievement. It can be quite verbose.

====category====
:Type: [[KUID]]
:Desc: The [[KIND_Achievement-category|achievement-category]] asset for this achievement. Achievement categories are used to group achievements together in the user interface.

====awarded-html====
:Type: Filename
:Desc: An .html file from the current asset, to be shown to the user when the achievement is granted. This may include a sub-path. This is optional - there is a default grant HTML style should it not be present.

====icon====
:Type: Filename
:Desc: An image file (preferably .TGA, 64x64) to use as an icon for the achievement. Optional.

=Conditions Container=
:Type: Container
:Desc: The conditions container lists the conditions required to achieve this achievement.

The format for a condition is the name of the variable, followed by the value.

Variable names are the KUID of the owning asset, a dash, and the text name of the variable.

=Achievements example=
The following is an example of a simple achievements container which has two achievements, one of which has two conditions.

achievements
{
tutorials-1-and-2
{
name "tutorials-1-and-2-name"
description "tutorials-1-and-2-desc"
category <kuid:447264:1008>
icon "tutorials_1_and_2_complete.tga"

conditions
{
<kuid:447264:1010>-tutorial-<kuid:447264:1021>-progress 1
<kuid:447264:1010>-tutorial-<kuid:447264:1037>-progress 1
}
}
drive-1-hour-dcc
{
name "drive-1-hour-dcc-name"
description "drive-1-hour-dcc-desc"
category <kuid:447264:1001>
icon "beginning_driver.tga"

conditions
{
<kuid:-16:10240>-driving-experience-dcc 3600
}
}
}

[[Category:Config Container]]

KIND Achievement-category

2010-03-04T16:21:55Z

James moody 2: New page: KIND Achievement-category provides categorization support for individual achievements within achievement groups. The KIND Achievement-category asset is r...

[[KIND Achievement-category]] provides categorization support for individual achievements within [[KIND_Achievement-group|achievement groups]]. The [[KIND Achievement-category]] asset is referenced from the achievement entry in the [[achievements_container|achievements container]] of an [[KIND_Achievement-group|achievement group]] asset using the "category" tag. Multiple achievements in the same achievement group can have different achievement categories.

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

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

award-image ""

====award-image====
:Type: Filename
:Desc: An image file (preferably .TGA, 512x512) to use as the background for the default achievement granted html for this category. Compulsory.

=Builtins=
The built-in [[KIND Achievement-category]] assets include:

* <kuid:447264:1001> Driving Experience
* <kuid:447264:1002> Sessions
* <kuid:447264:1004> Switching Experience
* <kuid:447264:1008> Tutorials
* <kuid:447264:1023> Industries
* <kuid:447264:1024> Passengers

=Categories=
[[Category:Asset KIND]]

KIND Achievement-group

2010-03-04T16:02:22Z

James moody 2: /* achievements */

[[KIND Achievement-group]] defines a set of achievements for use with the Trainz achievement system.

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

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

achievements
{
}

====achievements====
The [[Achievements_container|"achievements" container]] specifies a list of achievements contained within this achievement group.

=Downloads=
''Attach sample files here''

=Categories=
[[Category:Asset KIND]]

"Achievements" container

2010-03-04T16:01:38Z

James moody 2:

The [[achievements_container|achievements container]] is a top-level [[config.txt file]] entry used by [[KIND_Achievement-group|achievement group]] assets.

The achievements container is a list of achievement subcontainers with no standalone tags. Each achievement subcontainer uses the following format.

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

name ""
description ""
category <NULLKUID>
awarded-html ""
icon ""
conditions
{
}

====name====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible name of the achievement in it. This string table entry will be used in the Trainz user interface to refer to the achievement. It should be fairly short.

====description====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible description of the achievement in it. This string table entry will be used in the Trainz user interface to give detail to the user about the achievement. It can be quite verbose.

====category====
:Type: [[KUID]]
:Desc: The [[KIND_Aachievement-category|achievement-category]] asset for this achievement. Achievement categories are used to group achievements together in the user interface.

====awarded-html====
:Type: Filename
:Desc: An .html file from the current asset, to be shown to the user when the achievement is granted. This may include a sub-path. This is optional - there is a default grant HTML style should it not be present.

====icon====
:Type: Filename
:Desc: An image file (preferably .TGA, 64x64) to use as an icon for the achievement. Optional.

=Conditions Container=
:Type: Container
:Desc: The conditions container lists the conditions required to achieve this achievement.

The format for a condition is the name of the variable, followed by the value.

Variable names are the KUID of the owning asset, a dash, and the text name of the variable.

=Achievements example=
The following is an example of a simple achievements container which has two achievements, one of which has two conditions.

achievements
{
tutorials-1-and-2
{
name "tutorials-1-and-2-name"
description "tutorials-1-and-2-desc"
category <kuid:447264:1008>
icon "tutorials_1_and_2_complete.tga"

conditions
{
<kuid:447264:1010>-tutorial-<kuid:447264:1021>-progress 1
<kuid:447264:1010>-tutorial-<kuid:447264:1037>-progress 1
}
}
drive-1-hour-dcc
{
name "drive-1-hour-dcc-name"
description "drive-1-hour-dcc-desc"
category <kuid:447264:1001>
icon "beginning_driver.tga"

conditions
{
<kuid:-16:10240>-driving-experience-dcc 3600
}
}
}

[[Category:Config Container]]

"Achievements" container

2010-03-04T16:00:36Z

James moody 2:

The [[achievements_container|achievements container]] is a top-level [[config.txt file]] entry used by [[KIND_achievement-group|achievement group]] assets.

The achievements container is a list of achievement subcontainers with no standalone tags. Each achievement subcontainer uses the following format.

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

name ""
description ""
category <NULLKUID>
awarded-html ""
icon ""
conditions
{
}

====name====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible name of the achievement in it. This string table entry will be used in the Trainz user interface to refer to the achievement. It should be fairly short.

====description====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible description of the achievement in it. This string table entry will be used in the Trainz user interface to give detail to the user about the achievement. It can be quite verbose.

====category====
:Type: [[KUID]]
:Desc: The [[achievement-category]] asset for this achievement. Achievement categories are used to group achievements together in the user interface.

====awarded-html====
:Type: Filename
:Desc: An .html file from the current asset, to be shown to the user when the achievement is granted. This may include a sub-path. This is optional - there is a default grant HTML style should it not be present.

====icon====
:Type: Filename
:Desc: An image file (preferably .TGA, 64x64) to use as an icon for the achievement. Optional.

=Conditions Container=
:Type: Container
:Desc: The conditions container lists the conditions required to achieve this achievement.

The format for a condition is the name of the variable, followed by the value.

Variable names are the KUID of the owning asset, a dash, and the text name of the variable.

=Achievements example=
The following is an example of a simple achievements container which has two achievements, one of which has two conditions.

achievements
{
tutorials-1-and-2
{
name "tutorials-1-and-2-name"
description "tutorials-1-and-2-desc"
category <kuid:447264:1008>
icon "tutorials_1_and_2_complete.tga"

conditions
{
<kuid:447264:1010>-tutorial-<kuid:447264:1021>-progress 1
<kuid:447264:1010>-tutorial-<kuid:447264:1037>-progress 1
}
}
drive-1-hour-dcc
{
name "drive-1-hour-dcc-name"
description "drive-1-hour-dcc-desc"
category <kuid:447264:1001>
icon "beginning_driver.tga"

conditions
{
<kuid:-16:10240>-driving-experience-dcc 3600
}
}
}

[[Category:Config Container]]

"Achievements" container

2010-03-04T15:59:15Z

James moody 2: New page: The achievements container is a top-level config.txt file entry used by achievement group assets. The achievements container is a lis...

The [[achievements_container|achievements container]] is a top-level [[config.txt file]] entry used by [[achievement-group|achievement group]] assets.

The achievements container is a list of achievement subcontainers with no standalone tags. Each achievement subcontainer uses the following format.

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

name ""
description ""
category <NULLKUID>
awarded-html ""
icon ""
conditions
{
}

====name====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible name of the achievement in it. This string table entry will be used in the Trainz user interface to refer to the achievement. It should be fairly short.

====description====
:Type: Text
:Desc: The name of a [[string-table_container|string table]] entry with the user visible description of the achievement in it. This string table entry will be used in the Trainz user interface to give detail to the user about the achievement. It can be quite verbose.

====category====
:Type: [[KUID]]
:Desc: The [[achievement-category]] asset for this achievement. Achievement categories are used to group achievements together in the user interface.

====awarded-html====
:Type: Filename
:Desc: An .html file from the current asset, to be shown to the user when the achievement is granted. This may include a sub-path. This is optional - there is a default grant HTML style should it not be present.

====icon====
:Type: Filename
:Desc: An image file (preferably .TGA, 64x64) to use as an icon for the achievement. Optional.

=Conditions Container=
:Type: Container
:Desc: The conditions container lists the conditions required to achieve this achievement.

The format for a condition is the name of the variable, followed by the value.

Variable names are the KUID of the owning asset, a dash, and the text name of the variable.

=Achievements example=
The following is an example of a simple achievements container which has two achievements, one of which has two conditions.

achievements
{
tutorials-1-and-2
{
name "tutorials-1-and-2-name"
description "tutorials-1-and-2-desc"
category <kuid:447264:1008>
icon "tutorials_1_and_2_complete.tga"

conditions
{
<kuid:447264:1010>-tutorial-<kuid:447264:1021>-progress 1
<kuid:447264:1010>-tutorial-<kuid:447264:1037>-progress 1
}
}
drive-1-hour-dcc
{
name "drive-1-hour-dcc-name"
description "drive-1-hour-dcc-desc"
category <kuid:447264:1001>
icon "beginning_driver.tga"

conditions
{
<kuid:-16:10240>-driving-experience-dcc 3600
}
}
}

[[Category:Config Container]]

KIND Achievement-group

2010-03-04T14:25:28Z

James moody 2: New page: KIND Achievement-group defines a set of achievements for use with the Trainz achievement system. =KIND Hierarchy= ==Parent Classes== * ''none.'' ==Child Classes== * ''none.'' =Suppo...

[[KIND Achievement-group]] defines a set of achievements for use with the Trainz achievement system.

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

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

achievements
{
}

====achievements====
The [[achievements_container|achievements container]] specifies a list of achievements contained within this achievement group.

=Downloads=
''Attach sample files here''

=Categories=
[[Category:Asset KIND]]

Terminology

2010-03-04T12:56:32Z

James moody 2:

This page describes some of the more common train-related, content-creation-related, and general 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 TS2009 content creation, and terms which are meaningless in this context may be removed.

=General Train Terminology=

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

TBD.

=Trainz Content Creation=
* [[Scripting|TrainzScript]] / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* Model - A three-dimensional 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.
* 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.
* Texture - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* Material - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* Asset - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files. Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* 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''.
* [[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.
* [[Alpha blending]] - The process of using an opacity setting or texture alpha channel to allow partial transparency. Alpha blending is a hardware operation, however by itself blending does not combine well with a traditional hardware 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.
* 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).
* Texel - One texture pixel, once mapped onto a 3D Model and rendered in a scene. Does not correspond to one screen pixel.
* Polygons - In modeling terms, a polygon is always a triangle. (Please note, this is different from the 3DSMax definition).
* Indices - Each triangle has three indices. Each index is a reference to a vertex. (Vertices can be shared between multiple polygons).
* Vertices - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.
* Triangles - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* 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.
* Texture Sharing - When two or more ''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.
* 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.
* [[routes|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.
* 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.
* 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).
* 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.
* Map object / Scenery object - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* 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.
* 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''.
* 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.
* [[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.
* Bump mapping - Another term for ''Normal mapping''.
* Specular lighting - Lighting effects that vary dependent on the angle of incident light.
* 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 and performance to differing degrees. The 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.
* 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
* Mesh Table - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* [[KUID]] - Unique identifier for a specific Trainz ''asset''. Consists of Creator ID, Content ID and Version number fields.
* KUID Table - The [[Kuid-table_container|kuid-table container]] of an asset's [[config.txt file]]. Used to specify ''dependencies''.
* 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.
* Obsolete - An ''asset'' is obsolete if it has been replaced by a newer version.
* String Table - The [[String-table_container|string-table container]] of an asset's [[config.txt file]]. Used for translatable strings (i.e. anything that will be displayed to the user).
* Cab / Cabin / Interior - Asset made to represent the inside of an object, typically a ''Vehicle''.
* MAX / 3D Studio Max - The commercial [[Modeling]] tool used and supported by Auran.
* [http://www.blender.org Blender] - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* [[Content Manager]] - Program for querying and editing the ''Trainz Asset Database''. Common tasks performed with Content Manager include downloading, installing, editing, archiving and removing content.
* Geometry - A three-dimensional ''mesh'', without any related textures or material properties.

=File Formats=
* [[config.txt file]]
* .texture.txt file
* .texture file
* .pm file
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

=Abbreviations=
* TAD - Trainz Asset Database.
* CM - Content Manager.
* LOD - Level-Of-Detail.
* IM - Indexed Mesh file format.
* PM - Progressive Mesh file format.
* LM - Level-of-detail Mesh file format.
* TNI - Trainz Native Interface.

Terminology

2010-03-03T13:11:25Z

James moody 2:

This page describes some of the more common train-related, content-creation-related, and general 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 TS2009 content creation, and terms which are meaningless in this context may be removed.

=General Train Terminology=
* 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.

TBD.

=Trainz Content Creation=
* [[Scripting|TrainzScript]] / [[Scripting|GameScript]] - Used interchangeably, these terms refer to the Trainz scripting language.
* Model - A three-dimensional 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.
* 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.
* Texture - A two-dimensional image used for [http://en.wikipedia.org/wiki/Texture_mapping texture mapping].
* Material - A named object with a specific material type in combination with its necessary parameters and ''textures''.
* Asset - A single item of content in the Trainz environment, consisting of a ''config.txt file'' and any associated resource files. Each asset is uniquely identified by its ''KUID''. An asset may reference any number of ''dependencies'' which are required for correct operation.
* 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''.
* [[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.
* [[Alpha blending]] - The process of using an opacity setting or texture alpha channel to allow partial transparency. Alpha blending is a hardware operation, however by itself blending does not combine well with a traditional hardware 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.
* Pixel -
* Texel -
* Polygons - In modeling terms, a polygon is always a triangle.
* Indices -
* Vertices - The individual three-dimensional (x, y, z) coordinates that form the corner points of ''triangles'' in a ''mesh'' ''geometry''.
* Triangles - Three vertices (or specifically, three indices) form a triangle. The triangle is the basic unit of a ''mesh'' ''geometry''.
* 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.
* Texture Sharing - When two or more ''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.
* 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.
* Route / Layout / Map -
* Session -
* 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).
* 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.
* Map object / Scenery object - A scenery object is an instance of an ''asset'' that is placed in Surveyor at a given location and orientation.
* 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.
* 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 US terminology, this is normally referred to as a ''truck'', and in UK terminology as a ''bogie''.
* 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.
* [[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.
* Bump mapping - Another term for ''Normal mapping''.
* Specular lighting -
* 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 and performance to differing degrees. The 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.
* Trainz Asset Database -
* TrainzUtil -
* Trainz Native Interface -
* Mesh Table - The [["mesh-table" Container]] of an asset's [[config.txt file]].
* [[KUID]] -
* KUID Table -
* Dependency -
* Dependent -
* Obsolete -
* String Table -
* Cab / Cabin / Interior -
* MAX / 3D Studio Max - The commercial [[Modeling]] tool used and supported by Auran.
* [http://www.blender.org Blender] - A free [[Modeling]] tool with similar functionality to the commercial ''MAX'' software.
* [[Content Manager]] -
* Geometry - A three-dimensional ''mesh'', without any related textures or material properties.

=File Formats=
* [[config.txt file]]
* .texture.txt file
* .texture file
* .pm file
* [[IM files|.im file]]
* [[LM.txt file|.lm file]]
* .gs file
* .gse file
* .cdp file
* .cmpa file

=Abbreviations=
* TAD - Trainz Asset Database.
* CM - Content Manager.
* LOD - Level-Of-Detail.
* IM - Indexed Mesh file format.
* PM - Progressive Mesh file format.
* LM - Level-of-detail Mesh file format.
* TNI - Trainz Native Interface.