KIND Asset-group

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Known Asset-Groups)
Line 11: Line 11:
  
 
==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. 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. 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.
+
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==

Revision as of 14:37, 19 October 2011

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.

Contents

KIND Hierarchy

Parent Classes

Child Classes

  • none.

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.

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.

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.

Known Asset-Groups

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.
Track Spline Group <kuid:30501:100043> By default, all spline assets which act as railway tracks 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.

Example Config.txt

kuid                                    <kuid:30501:100046>
kind                                    "asset-group"
username                            "Bridge Spline Group"


Categories

Personal tools