KIND Asset-group
From TrainzOnline
(Difference between revisions)
m (→Known Asset-Groups) |
(→Narrow Gauge Track) |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{ORP-top}} | |
| − | + | ||
==KIND Hierarchy== | ==KIND Hierarchy== | ||
| + | A logical grouping of assets. '''KIND Asset-group''' assets are not typically visible within the Trainz user interface, but instead affect other placeable assets in various ways. | ||
| + | |||
===Parent Classes=== | ===Parent Classes=== | ||
* [[KIND TrainzBaseSpec]] | * [[KIND TrainzBaseSpec]] | ||
===Child Classes=== | ===Child Classes=== | ||
| − | + | [[KIND TrainzBaseSpec#member-of-groups|'member-of-groups' container]] self-assignment in [[TrainzBaseSpec]]. | |
==Supported Tags== | ==Supported Tags== | ||
| Line 11: | Line 12: | ||
==Usage== | ==Usage== | ||
| − | Once an asset of [[KIND Asset-group]] has been created, other assets can be assigned to the group by adding the asset groups' [[KUID]] to each asset's 'member-of-groups' container | + | Once an asset of [[KIND Asset-group]] has been created, other assets can be assigned to the group by adding the asset groups' [[KUID]] to each asset's 'member-of-groups' container. It is strongly recommended that each new asset group is added to this documentation so that other users can understand how to use groups that you have created. |
It is not recommended to create large numbers of asset groups simply for classification purposes, as the asset groups are meaningless or even counter-productive unless adopted as standard and used by a large number of content creators. For example, a new 'steam locomotive' asset group would be meaningless unless the majority of steam locomotives were updated to be members of the asset group. | It is not recommended to create large numbers of asset groups simply for classification purposes, as the asset groups are meaningless or even counter-productive unless adopted as standard and used by a large number of content creators. For example, a new 'steam locomotive' asset group would be meaningless unless the majority of steam locomotives were updated to be members of the asset group. | ||
| + | |||
| + | ==Interpretation== | ||
| + | Membership of a particular asset group has a meaning specific to that asset group- simply creating a new asset group and adding assets to it has no effect whatsoever on the simulation. Both script and native code can make use of known asset groups to imply particular meanings. | ||
| + | |||
| + | Surveyor currently uses the asset-group information when placing [[KIND_Scenery-trackside|trackside objects]], to determine whether the object can be placed on the target spline. | ||
==Known Asset-Groups== | ==Known Asset-Groups== | ||
| + | |||
| + | === Standard Track === | ||
{| border=1 cellpadding=2 cellspacing=0 | {| border=1 cellpadding=2 cellspacing=0 | ||
|Username||KUID||Description | |Username||KUID||Description | ||
| − | |||
|- | |- | ||
| − | | | + | |Standard Gauge Group||<kuid:30501:100050>||4'8.5" (1435mm) standard gauge track. |
|- | |- | ||
|Track Spline Group||<kuid:30501:100043>||By default, all spline assets which act as railway tracks are placed in this asset group. | |Track Spline Group||<kuid:30501:100043>||By default, all spline assets which act as railway tracks are placed in this asset group. | ||
| + | |} | ||
| + | |||
| + | |||
| + | === Narrow Gauge Track === | ||
| + | |||
| + | {| border=1 cellpadding=2 cellspacing=0 | ||
| + | |- | ||
| + | |Username||KUID||Description | ||
| + | |- | ||
| + | |Narrow Gauge One Foot Group||<KUID:44700:100057>||1' (304.8 mm) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge One Foot Three Group||<KUID:44700:100056>||1'3" (381 mm) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge Two Foot Group||<KUID:44700:100055>||2' (609.6 mm) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge (2ft 5½in) Group||<kuid:371826:20170811>||750mm (2 feet, 5.5 inches) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge Two Foot Six Group||<KUID:44700:100054>||2'6" (762 mm) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge One Meter Group||<kuid:30501:100053>||One-meter (3 feet, 3.37 inches) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge Three Foot Group||<kuid:30501:100051>||3' (914.4mm) narrow gauge track. | ||
| + | |- | ||
| + | |Narrow Gauge Three Foot Six Group||<kuid:30501:100052>||3'6" (1066.8 mm) narrow gauge track. | ||
| + | |} | ||
| + | |||
| + | === Roads, Bridges and Tunnels === | ||
| + | {| border=1 cellpadding=2 cellspacing=0 | ||
| + | |Username||KUID||Description | ||
| + | |- | ||
| + | |Bridge Spline Group||<kuid:30501:100046>||By default, all spline assets which act as bridges are placed in this asset group. | ||
| + | |- | ||
| + | |Road Spline Group||<kuid:30501:100045>||By default, all spline assets which act as road splines are placed in this asset group. | ||
|- | |- | ||
|Tunnel Spline Group||<kuid:30501:100044>||By default, all spline assets which act as tunnels are placed in this asset group. | |Tunnel Spline Group||<kuid:30501:100044>||By default, all spline assets which act as tunnels are placed in this asset group. | ||
|} | |} | ||
| + | |||
| + | |||
| + | === Other === | ||
| + | {| border=1 cellpadding=2 cellspacing=0 | ||
| + | |Username||KUID||Description | ||
| + | |- | ||
| + | |Air Vehicle Group||<kuid:30501:100048>||Aircraft. | ||
| + | |- | ||
| + | |Groundcar Group||<kuid:30501:100049>||Ground vehicles such as cars, buses, tractors, tanks. | ||
| + | |- | ||
| + | |Train Vehicle Group||<kuid:30501:100047>||Normal train vehicles (rolling stock) as simulated by Trainz. Does not include any special-case objects which the creator may have constructed as a [[KIND Traincar]] asset. | ||
| + | |} | ||
| + | |||
==Example Config.txt== | ==Example Config.txt== | ||
| Line 36: | Line 89: | ||
==Categories== | ==Categories== | ||
| − | [[Category:Asset KIND]] | + | [[Category:Asset KIND|asset-group]] |
| + | {{ORP-bot|asset-group}} | ||
Latest revision as of 02:57, 7 March 2018
Contents |
[edit] KIND Hierarchy
A logical grouping of assets. KIND Asset-group assets are not typically visible within the Trainz user interface, but instead affect other placeable assets in various ways.
[edit] Parent Classes
[edit] Child Classes
'member-of-groups' container self-assignment in TrainzBaseSpec.
[edit] Supported Tags
No additional tags are supported at the current time. An asset-group starts as empty of assets, but individual assets can assign themselves to an asset-group using their 'member-of-groups' container. An asset-group should not typically have any data in its own 'member-of-groups' container, although it is not an error to do so.
[edit] Usage
Once an asset of KIND Asset-group has been created, other assets can be assigned to the group by adding the asset groups' KUID to each asset's 'member-of-groups' container. It is strongly recommended that each new asset group is added to this documentation so that other users can understand how to use groups that you have created.
It is not recommended to create large numbers of asset groups simply for classification purposes, as the asset groups are meaningless or even counter-productive unless adopted as standard and used by a large number of content creators. For example, a new 'steam locomotive' asset group would be meaningless unless the majority of steam locomotives were updated to be members of the asset group.
[edit] Interpretation
Membership of a particular asset group has a meaning specific to that asset group- simply creating a new asset group and adding assets to it has no effect whatsoever on the simulation. Both script and native code can make use of known asset groups to imply particular meanings.
Surveyor currently uses the asset-group information when placing trackside objects, to determine whether the object can be placed on the target spline.
[edit] Known Asset-Groups
[edit] Standard Track
| Username | KUID | Description |
| Standard Gauge Group | <kuid:30501:100050> | 4'8.5" (1435mm) standard gauge track. |
| Track Spline Group | <kuid:30501:100043> | By default, all spline assets which act as railway tracks are placed in this asset group. |
[edit] Narrow Gauge Track
| Username | KUID | Description |
| Narrow Gauge One Foot Group | <KUID:44700:100057> | 1' (304.8 mm) narrow gauge track. |
| Narrow Gauge One Foot Three Group | <KUID:44700:100056> | 1'3" (381 mm) narrow gauge track. |
| Narrow Gauge Two Foot Group | <KUID:44700:100055> | 2' (609.6 mm) narrow gauge track. |
| Narrow Gauge (2ft 5½in) Group | <kuid:371826:20170811> | 750mm (2 feet, 5.5 inches) narrow gauge track. |
| Narrow Gauge Two Foot Six Group | <KUID:44700:100054> | 2'6" (762 mm) narrow gauge track. |
| Narrow Gauge One Meter Group | <kuid:30501:100053> | One-meter (3 feet, 3.37 inches) narrow gauge track. |
| Narrow Gauge Three Foot Group | <kuid:30501:100051> | 3' (914.4mm) narrow gauge track. |
| Narrow Gauge Three Foot Six Group | <kuid:30501:100052> | 3'6" (1066.8 mm) narrow gauge track. |
[edit] Roads, Bridges and Tunnels
| Username | KUID | Description |
| Bridge Spline Group | <kuid:30501:100046> | By default, all spline assets which act as bridges are placed in this asset group. |
| Road Spline Group | <kuid:30501:100045> | By default, all spline assets which act as road splines are placed in this asset group. |
| Tunnel Spline Group | <kuid:30501:100044> | By default, all spline assets which act as tunnels are placed in this asset group. |
[edit] Other
| Username | KUID | Description |
| Air Vehicle Group | <kuid:30501:100048> | Aircraft. |
| Groundcar Group | <kuid:30501:100049> | Ground vehicles such as cars, buses, tractors, tanks. |
| Train Vehicle Group | <kuid:30501:100047> | Normal train vehicles (rolling stock) as simulated by Trainz. Does not include any special-case objects which the creator may have constructed as a KIND Traincar asset. |
[edit] Example Config.txt
kuid <kuid:30501:100046> kind "asset-group" username "Bridge Spline Group"
