KIND Buildable

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Added sort criterion)
m
 
Line 35: Line 35:
 
When initially placed, instances of this asset type will show using their 'potential' mesh. While building, the mesh will step through the appropriate 'building-N' meshes over the build duration. Upon completion, the 'default' mesh is displayed.
 
When initially placed, instances of this asset type will show using their 'potential' mesh. While building, the mesh will step through the appropriate 'building-N' meshes over the build duration. Upon completion, the 'default' mesh is displayed.
  
By default, the user can access 'Build' and 'Cancel' commands through the Driver RMB contextual menu. Access to these commands can be limited via script. Canceling a build reverts the instance to the fully unbuilt state.
+
By default, the user can access 'Build' and 'Cancel' commands through the Driver "right click" contextual menu. Access to these commands can be limited via script. Canceling a build reverts the instance to the fully unbuilt state.
  
  

Latest revision as of 16:45, 10 November 2017

KIND Buildable is a variant of KIND SceneryWithTrack, and may be used in place of a normal scenery item where buildable or attached-track mechanisms are required. It does not support industry processes; KIND Industry should be used for that purpose.

Contents

[edit] KIND Hierarchy

[edit] Parent Classes

[edit] Child Classes


[edit] Supported Tags

KIND Buildable supports all of the KIND SceneryWithTrack tags, and adds the following tags. Each tag is shown here with its default value.

 building-cost
 {
   duration 0
 }


duration - The duration (real-time seconds) over which an instance of this asset is built once instructed to begin building.


[edit] Asset Configuration

A KIND Buildable asset provides additional functionality extending KIND SceneryWithTrack if, and only if, a mesh-table entry named 'potential' exists. If this mesh-table entry does not exist, the asset is treated as a regular KIND SceneryWithTrack. The documentation on this asset type describe the scenario where the 'potential' mesh exists.

A KIND Buildable asset should contain the following named entries in its mesh-table:

  • 'potential'
  • 'building-0'
  • 'building-N' (where N represents each consecutive integer.)
  • 'default'

The meshes should not be configured to auto-create.

When initially placed, instances of this asset type will show using their 'potential' mesh. While building, the mesh will step through the appropriate 'building-N' meshes over the build duration. Upon completion, the 'default' mesh is displayed.

By default, the user can access 'Build' and 'Cancel' commands through the Driver "right click" contextual menu. Access to these commands can be limited via script. Canceling a build reverts the instance to the fully unbuilt state.


[edit] Categories

Personal tools