TrainzOnline - User contributions [en]

User talk:Pware

2021-04-07T21:28:25Z

Jbartus: kudos, Take a Bow

==Take a Bow==
You've been doing a great job herein!
Frank

KIND TrainzBaseSpec

2020-05-19T18:05:16Z

Jbartus: /* custom-category-list */ cross-link to details pages: WHERE DO THE TAGS IN Category List go?

{{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#Table_of_KIND_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 Track

2020-05-18T18:26:40Z

Jbartus: /* attached-splines */ +Earliest available validity is TS12, trainz-build 3.4

{{ORP-top}}
=KIND Track=

'''KIND Track''' provides the sole asset kind for spline-based assets from [[Trainz-build]] version 2.9 and up. Contrary to the name, just as a Road type used to be defined as a Track asset, assets of this kind now include simple track, multitrack, bridges, tunnels, hedges, roads, walls, embankments, local power lines, high-voltage power lines, and so on. Assets of this kind use a rendering technique previously known as "stitched track". Now that all other spline rendering is obsolete, it is simply known as "track".

This page describes [[trainz-build]] 4.5.

=KIND Hierarchy=
==Parent Classes==
* [[KIND TrainzBaseSpec]]

==Child Classes==
*[[KIND Procedural track]] is a rail-track-specific spline type introduced at trainz-build 4.2 which is procedurally built from components.

=Supported Tags=
The [[KIND Track]] in a [[config.txt file]] supports the following tags when defined by the [[TrainzBaseSpec]] . Each tag is show here with its default value.

mesh-table
{
}
track
{
}
endcap-prev
{
}
endcap-next
{
}
[[attached-splines]]
{
}
season-selector
{
}
track-sound
{
}
is_silent 0
istrack 0
isroad 0
carrate 0
traffic-speed 10
isfreeway 0
numlanes 0
istunnel 0
tunnel-roof-height 0
enable-pfx-collisions 1
surveyor-only 0
visible-on-minimap 1

==mesh-table==
The [["mesh-table" Container]] provides details about the track and end-cap meshes which comprise this asset. Most advanced mesh-table options are not available for use at the current time. The important thing is to specify the meshes. Specifically, the 'mesh' tag should be used to specify an IM file, and the 'mesh-asset' tag can be used to specify an alternative source asset for the mesh.

==track==
The "track" tag is compulsory and determines how the spline geometry is formed from meshes. It is specified as a [[Track Part Container]].

==endcap-prev & endcap-next==
The "endcap-prev" and "endcap-next" tags are specified in the same way as "track", but are not compulsory. If present, these end caps are inserted past the ends of the spline in each direction unless the spline flows onto another spline segment of the same asset. This allows the content creator to "seal" the spline geometry without having to introduce inefficient sealing polygons at each subdivision. The endcaps obey the normal fit-to-spline behavior except that they continue straight in the instantaneous direction of the end of the spline. If present, the endcaps inherit their default settings from the asset's "track" tag but any individual values may be overridden as desired.

==attached-splines==
: Earliest available validity is TS12, trainz-build 3.4
The [["attached-splines" container]] provides a mechanism for having child splines attached which follow the shape of this parent spline at a slightly offset. Attached splines are used where a spline with one set of rendering or functional behaviour needs to be coupled with a spline with a different set of rendering or functional behaviours. For example, a bridge (scenery) with attached track (functional), or a set of pylons (no stretching or shearing) with some wires strung between them (shearing and stretching to fit.) The attached splines may be render-only splines which effectively don't exist beyond their rendering behaviour, or they may be fully functional splines whose only specialty is that they move and delete with their parent.

==season-selector==
The [["Season-selector" container]] allows for the selection of a season index, which may be used by the [["track-lod-tree" container]].

==track-sound==
(Only applicable to splines which have 'istrack' set.)

An optional [["track-sound" container]] which assists in calculating which sound to play while a train vehicle is on this track.

==is_silent==
(Only applicable to splines which have 'istrack' set.)

If set (1), this boolean tag disables the playing of per-axle sounds for vehicles on the spline.

==istrack==
If set (1), this boolean tag causes the spline to be treated as a "track", meaning that trains can be expected to run on the spline.

This affects the visibility of the spline on the minimap, where the spline assets shows up in the surveyor pickers, which surveyor tools can operator on the asset, and whether automatic junction placement is enabled.

Track splines can generally be joined, even if they are different assets.

==isroad==
If set (1), splines of this type are considered roads. Roads support the generation of Carz. Roads are flagged as blocked by [[KIND MOCrossing]] while the crossing gate is closed. Road splines can generally be joined, even if they are different assets.

If not otherwise specified, assets with the 'isroad' tag set are members of the "Road Spline Group" [[KIND_Asset-group#Known Asset-groups|<kuid:30501:100045>]].

==carrate==
(Only applicable to splines which have 'isroad' set.)

The game waits between 1 and 3 times this value (in seconds) between generating traffic on this road.

==traffic-speed==
(Only applicable to splines which have 'isroad' set.)

Defines the carz speed limit of the road in meters per second. Carz currently travel at up to 80%-110% (depending on the car) of the speed limit, except when overtaking. This tag does not relate to trains in any way.

==isfreeway==
(Only applicable to splines which have 'isroad' set.)

If set (1), this boolean tag causes a multilane road to act as a freeway. This allows carz to change lanes at will, and causes all traffic to flow in the spline's forward direction only. Overtaking is still allowed on non-freeway roads.

==numlanes==
(Only applicable to splines which have 'isroad' set.)

Defines the number of carz lanes on a road. Each lane is considered to be 1.7 meters wide. If the road is a freeway, all traffic flows in the same direction.
TBD: What, if anything, does this mean for a non-freeway road?

If not otherwise specified, assets with the 'istrack' tag set are members of the "Track Spline Group" [[KIND_Asset-group#Known Asset-groups|<kuid:30501:100043>]].

==istunnel==
If set (1), this boolean tag causes the spline to be treated "like a tunnel". Despite the name, this does not directly relate to the true tunnel spline functionality (see the 'tunnel-roof-height' tag for details.)

Some types of derailment are disabled while in a tunnel because the resultant user experience would be poor due to inter-penentration of the tunnel and terrain by the train vehicles and the player's camera.

The script function Vehicle.IsInTunnel() returns 'true' while a vehicle's origin is on a tunnel spline.

If the user is in 'external' or 'auto tracking' camera mode while the camera target is in a tunnel, the camera changes to "tunnel external" mode instead.

While the camera target is in a tunnel, environmental sounds are reduced to 50% volume.

Some types of vehicle particle emitter are disabled while the vehicle is in a tunnel.

==tunnel-roof-height==
Used by tunnels to determine the roof height in meters allowed by the terrain hole. If less than or equal to zero, no terrain holes are generated. If greater than zero, this spline is considered a true tunnel- it will generate holes in the terrain mesh, its approach angle to the terrain mesh will be locked to 45° increments, and the endpoints will snap to the 10m grid size.

Tunnels are intended for running a spline underneath the terrain mesh.

Tunnel splines attempt to curve such that the spline terminates at a 45° angle increment. This helps ensure that entrance holes can be successfully created through the terrain mesh.

Tunnel splines have slightly modified editing semantics in Surveyor. Vertex markers are visible in different conditions. Smoothing the ground around a tunnel is not permitted. The tunnel spline always follows the spline gradient rather than reacting to the ground height.

If not otherwise specified, assets with the 'istunnel' tag set are members of the "Tunnel Spline Group" [[KIND_Asset-group#Known Asset-groups|<kuid:30501:100044>]].

==enable-pfx-collisions==
Bool value, defaults to 1 and is not compulsory. Defines whether or not this track object should be used for collision detection against particles (e.g. smoke, steam). Disabling it for objects that are unlikely to interact with particles is a good idea.

==surveyor-only==
If set (1), this boolean value causes the asset to only be visible Surveyor. Where applicable, traincars placed on such splines will operate as normal in Driver etc.

==visible-on-minimap==
If clear (0), hides this spline from the minimap. Splines with non-render-only children are never shown on the minimap. Note that this tag does not have a fixed default value, but rather defaults to the opposite of the 'surveyor-only' tag.

=Meshes=

A track asset is usually comprised of several meshes. Each mesh represents a piece of the spline, which is repeated end-of-end with various transformations in order to create the whole spline. Multiple meshes allow for LOD, detail randomisation, and so on - the selection of which mesh to use at various places on the spline is defined by the [["track-lod-tree" container]]s.

Meshes should make use of a normal map and a single high resolution diffuse texture. For performance reasons, a single material (ie. single texture; see the notes on material sharing between meshes) should be used for all meshes, as opposed to using a separate material for each. The material may use either alpha masking (1-bit alpha) or alpha blending, however any alpha blends will not be sorted (not against other polygons in the track itself, nor against other alpha-blended polygons in the scene.) For this reason, alpha blending should only be used low to the ground such that a line from the camera to the mesh will pass through no other alpha-blended object before reaching the ground. Normal z-buffer behavior will apply to both alpha-blended and alpha-masked meshes.

The various mesh pieces that comprise a track are modelled in such that any type may fit to any other without an obvious seam. Pieces are not strictly required to be symmetrical, as they will never be rotated with respect to the previous piece, however it should be noted that splines which support multi-way joins can result in a construct where a spline loops back and connects to itself coming in the opposite direction.

Some approximate polygon guidelines follow. Creators should avoid using more polygons that they require to accurately depict the object in question.

* Extreme detail mesh - used for close-ups. 1000 polys per 2m segment.

* High detail mesh - used at close range. 200 polys per 2m segment.

* Mid detail mesh - used at mid range. 100 polys per 10m segment.

* Low detail mesh - used at far range. 6 polys per 10m segment. Tracks are textured onto the ballast, rather than polygon-modelled.

* Initial end-cap - used at the start of the spline. 100 polys.

* Final end-cap - used at the end of the spline. 100 polys.

The end-caps provide any polygons necessary to "close" the spline so that it does not appear hollow when seen from end-on. The other meshes do not include any such polygons. The end-caps are automatically applied by the game wherever a transition is made from one track type to another, or where the track begins or ends abruptly.

The length of each mesh is specified independantly. It is recommended that each is made as long as reasonably possible within the alloted polygon budget.

When modelling a track spline, care should be taken to ensure that the top of the rail is exactly 0.3m above the origin. This ensures that it meets the train vehicle's wheels with no overlap and no gap.

=Spline Placement=

Meshes may be specified to follow their placement spline as closely as possible (previously: bendy) or to stay straight but shear to prevent seams. This is discussed in detail in the [[Track_Part_Container|track part container]].

Vertices on the mesh may fall into one of two height categories:
* Grounded - The vertex positioning is based on the ground height.
* Spline - The vertex positioning is based on the placement spline.
The height category of a vertex is determined from it's relative height within the mesh - if it is less than or equal to the per-mesh-specified grounding height, it is considered grounded.

=Performance=
Actual performance will vary based on the following factors:
* Distance at which the High-detail LODs drop out. Generally this should be extremely close.
* Number of polygons in the lower LODs. Generally this should be very low.
* Number of materials used. Ideally, a single material is used for all meshes, rather than one or more per mesh.
* Length of each mesh (longer is better).
* Efficiency of the [["track-lod-tree" container]].
* User-customisable detail settings.
* etc.

=Category Class=
The category-class for [[KIND Track]] may be any of the following:
<pre>
SF Fences
SR Roads
SP Platforms
SS Structure
SV Vegetation
TB Bridge
TR Rails
TT Tunnel
</pre>

=Downloads=
* [[Media:TS2009-track.zip]] - The MAX source for the [[Auran]] [[TS2009]] example track. Distributed from the TrainzDev site for education purposes only. No license for the reproduction or redistribution of the included model or textures is granted.
* [[Media:TS2012-tunnel.rar]] - The MAX source for asset: Tunnel Double Track <KUID:523:19721248>. Distributed from the TrainzDev site for education purposes only. No license for the reproduction or redistribution of the included model or textures is granted.
* [[Media:TS2012-bridge.rar]] - The MAX source for asset: Bridge Plate Girder <KUID:523:19721136>. Distributed from the TrainzDev site for education purposes only. No license for the reproduction or redistribution of the included model or textures is granted.

=Related Links=
* [["track-lod-tree" container]]
* [[Modeling Splines]]
* [[Track Part Container]]
* For background and insights, read the Track entries of the TC3 [[Content Creator's Guide]].

=Categories=
[[Category:Asset KIND|Track]]
{{ORP-bot}}

CCG/Effects

2020-04-08T22:47:21Z

Jbartus: /* Breakdown of KIND NAME */ clarify

==EFFECTS (optional mesh-table variables)==

==EFFECT: KIND NAME==
Some assets may have editable signs. When you set an asset's name in surveyor through the Edit Properties icon ('?' icon) the signage can be set-up to automatically update. The variables can be set for each sign.

Typical Kind Name mesh table set-up You do not have to use the 0,1,2... block naming convention.

For the name effects described in the example, 0 could easily be mainsign or something more relevant to your model.

mesh-table
{
default
{
mesh industry.lm
auto-create 1
effects
{
0
{
kind name
fontsize 0.15
fontcolor 30,30,30
att a.name0
name name
}
1
{
kind name
fontsize 0.3
fontcolor 30,30,30
att a.name1
name name
}
}
}
}

Setting unique names may be useful for script purposes, so you can easily recognise a script reference for instance.

===Breakdown of KIND NAME===

'''kind name'''
The effect kind

'''fontsize'''
The size of the sign text

'''fontcolor'''
The colour of the sign text in r.g.b.

'''att'''
The sign text insertion point (part of the mesh). The attachment point must be orientated correctly in Blender, 3dsmax and gmax and the attachment points aligned with the correct axis used by the generating software. The diagram shows the correct orientation of the axis.
[[Image:CCG_text_orientation.jpg|left|330px|Correct viewing axis alignment to match Trainz rendering.]]
<table bgColor="lightyellow" style="width:80%; margin-top:10px; margin-left:40px margin-right:40px margin-bottom:10px; border:2px solid navy; padding:15px; ">
<tr bgColor="lightyellow"><td><span border="1" padding="15px">Note that there is a axes/orientation ''usages discontinuity'' between Blender, and 3dsMax or GMAX.
* In Blender, the Z axis represents up, while in GMAX, the Y axis represents up.
* This needs to be taken to account in determining the proper orientation of your object,and the names given to ''parts be attached later'' correctly.
* Take time to think things through... to make a sketch on paper before playing 'Creator' on any software package's screens... where it is easy to forget alignment associations in the midst of other thoughts and important considerations.
</span></td>
</tr>
</table>

* Points are placed in top view in 3dsmax/gmax.
** When aligning the point in 3DSMax or GMax, click on the ''Hierarchy - Affect Pivot Only'' option to examine the axis direction,
** turn off the Affect Pivot Only selection, and rotate the point itself to the correct orientation.
** Click on the Affect Pivot Only option again to check the new alignment. Make sure you rotate the point, not the axis.

'''name'''
The default text when placed

When the label name is specified, the software system uses the asset's changeable name option, (reserved word allocating memory for the label to be added when brought into Surveyors world under construction) and so can changed through the Edit Properties icon (the `?' icon) in Surveyor.

If name ''Graceland'' (for example) were used, the sign would never be able to be changed, even though the user may have changed the asset's name in Surveyor. When you use the name tag, this name will appear in the minimap. In some instances the names will be hard to distinguish in a crowded map. For this reason, it may be advisable to limit the use of the name tag to objects that have a use for the attribute.

==EFFECT: KIND CORONA==

A corona is a `glow' light effect. It is a simple texture that is inserted at an attachment point within the mesh. Coronas can be added to any asset that uses a mesh-table.

Examples of coronas used in-game can be seen on the Cessna and the Airport tower all use flashing coronas.

===Breakdown of KIND CORONA:===

'''kind corona''' (required)
The effect kind

'''att''' (required)
The corona insertion point in the main mesh.(an attachment point)

'''texture-kuid''' (optional)
Add this tag only when you want to specify your own texture for the corona. It specifies the KUID of a kind texture asset. See KIND TEXTURE.

Typical Kind Corona mesh-table set-up

mesh-table
{
default
{
mesh asset.lm
auto-create 1
effects
{
0
{
kind corona
att a.corona0
texture-kuid <KUID:-3:10110>
frequency 2
directional 0
object-size 0.20
}
1
{
kind corona
att a.corona1
}
}
}
}

If the texture-kuid tag is not present the corona will use the default yellow/orange texture in TRS.

'''frequency''' 2 (optional)
This variable specifies the frequency in Hz (or `flashes' per second). e.g. 1 for once per second, 0.5 for once every 2 seconds, 2 for twice per second.

'''directional''' 0 (optional)
The default for coronas is to be aligned to the attachment point to face the NEGATIVE Z direction. This is especially useful for Traincars.

Adding this tag over-rides this behavior, to make the corona always face the screen useful for scenery objects.

'''object-size''' 0.15 (optional)
Size of the corona on the object when viewed up close,

Trainz released corona textures:
· Yellow/orange corona Default (if no texture-kuid)
· Green corona <KUID:-3:10110>
· Red corona <KUID:-3:10112>
· White corona <KUID:-3:10111>

==EFFECT: KIND TEXTURE-REPLACEMENT==
This effect was created for rolling stock items to swap the visible texture of bulk loads (such as coal or woodchips). If a coal car is set up to take any bulk load (which includes woodchips) the `coal' texture on the load mesh will update to a `woodchips' texture when it loads woodchips.

For detailed information on the setup of rolling stock load, see Page 375 .

==EFFECT: KIND ATTACHMENT==

In Trainz we have the ability to attach a mesh into another mesh by referencing it's KUID through a mesh-table.
An example is the red display arrows for the fixed-track assets.

Rather than having an arrow in each fixed-track asset directory, we saved a lot of memory space by making the config.txt file reference a KUID of that mesh. Therefore,it only needed to be cached once. The mesh to be used should only be of kind scenery or kind mesh.

Kind Attachment example (fixed-track)

username FT 10 Deg 700m Rad
kind fixedtrack
kuid <KUID2:####:#######:1>
region Fixed track
preview-mesh-kuid <KUID:-3:10099>
mesh-table
{
default
{
mesh 10-700.im
auto-create 1
effects
{
arrow0
{
kind attachment
att a.track0a
default-mesh <KUID:-3:10092>
surveyor-only 1
}
arrow1
{
kind attachment
att a.track0e
default-mesh <KUID:-3:10092>
surveyor-only 1
}
}
}
}
attached-track
{
track0
{
track <KUID:-1:15>
vertices
{
0 a.track0a
1 a.track0c
2 a.track0e
}
}
}

WARNING: Never cross-reference a kind attachment KUID with the assets own KUID, unless of course you want to see an instant fatal error!

Fixed Track configuration used in this example

[[Image:CCG_Arrow_on_Fixed_track.jpg]]

Arrow mesh config.txt (for reference)

kuid <KUID:-3:10092>
kind mesh
mesh-table
{
default
{
mesh arrow.im
auto-create 1
}
}

===Breakdown of KIND ATTACHMENT:===

Note that the example covers the information relating to the attachment. Additional entries for category region, era, trainz-build, etc. are necessary to make a complete config.txt file.

'''kind attachment''' (required)
The effect kind

'''att''' (required)
The insertion point of the attached mesh. In the example left, it is the origin of the `default' mesh.

'''default-mesh''' <KUID2:####:#######:1> (required)
The KUID of the attached mesh.

'''surveyor-only''' 1 (optional)
Adding this means the attached mesh will only be visible in Surveyor and not Driver. For tracks, this is especially handy so you know when it starts and ends, but it won't be there when driving around.

'''attached-track'''
Information on the track to be attached to the model by Trainz. This includes a name for the track (track0), the track KUID to be used, and attachment points placed in the 3dsmax/gmax model to define the curve for the attached track to follow.

The points use the a.name naming convention, any names may be used, but using the "track" name (a.track0a) for rails, and the "road" name (a.road0a) is convenient. A specified road spline connection will generate road traffic.

See Page 91 for more details on using the attachment points and the special orientation of the axis at the ends of the track.

==EFFECT: KIND ANIMATION==

This effect is used when a mesh has a variety of animations. Usually the animations will be controlled by a script related to the asset.
An example of the kind animation effect is the PB15 interior coalman. The script for this ties in the animations with the coal requirements of the steam locomotive.

coalman
{
mesh coalman/coalman.im
auto-create 1
att-parent default
att a.coalman
effects
{
shovel
{
kind animation
anim coalman/coalman_shovel.kin
}
wave
{
kind animation
anim coalman/Coalman_wave.kin
}
Etc...

===Breakdown of KIND ANIMATION:===

'''kind animation''' (required)
The effect kind

'''anim''' (required)
Reference to the animation file (.kin)

'''looped''' 1 (optional)
Use only if the animation is looping (repeating). ''Default 0 (i.e. not looped).''

'''speed''' 1 (optional)
Speed factor of the animation. ''Default 1, 2 = Double speed and 0.5 = Half speed''

The PB15 config.txt can be viewed on:

The PB15 interior script can be viewed on:

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