KIND Scenery-trackside
From TrainzOnline
(Difference between revisions)
Builderbob (Talk | contribs) (Remove ambiguity.) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 21: | Line 21: | ||
trackmark 0 | trackmark 0 | ||
search-limit 0 | search-limit 0 | ||
| + | placeable-on-splines-of-group | ||
| + | { | ||
| + | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
====buffer-speed==== | ====buffer-speed==== | ||
:Type: Decimal | :Type: Decimal | ||
| Line 33: | Line 30: | ||
====follow-gradient==== | ====follow-gradient==== | ||
:Type: Boolean | :Type: Boolean | ||
| − | :Desc: | + | :Desc: If true (1) the object will be oriented perpendicular to the track gradient. If false (0 - default) the asset will be oriented vertically, ignoring the track gradient. |
| − | ==== | + | |
| − | :Type: | + | ====placeable-on-splines-of-group==== |
| − | :Desc: | + | :Introduced: [[trainz-build]] 3.5 |
| + | :Type: KUID list container, TBD. | ||
| + | :Desc: A list of [[KIND Asset-group|asset groups]] describing the spline types on which this trackside object may be placed. This object cannot be placed on a spline unless the spline is a member of one of the groups specified here. If not specified, the list defaults to a single entry, [[KIND_Asset-group#Known Asset-groups|<kuid:30501:100043>]]. | ||
====search-limit==== | ====search-limit==== | ||
:Type: Boolean | :Type: Boolean | ||
:Desc: Search limit objects are used by the Driver AI and indicate the direction of travel for a section of track. | :Desc: Search limit objects are used by the Driver AI and indicate the direction of travel for a section of track. | ||
| + | ====speedlimit==== | ||
| + | :Type: Decimal | ||
| + | :Desc: Sets the speed limit, in meters per second, for the track it is placed on, after the object. If this tag is provided with no value, the speed limit will be set to 100m/s. | ||
| + | ====trackmark==== | ||
| + | :Type: Boolean | ||
| + | :Desc: Specifies if the object is a trackmark. Trackmarks can be used to place consists in [[Scripting|TrainzScript]]. | ||
| + | ====trackside==== | ||
| + | :Type: Float | ||
| + | :Compulsory: 3.4 | ||
| + | :Desc: The distance, in meters, the object will be placed from the center of the track. Negative values will put the object on the left side of the track, and positive values will place it on the right. | ||
| + | |||
| + | |||
==Example Config.txt== | ==Example Config.txt== | ||
Sample [[config.txt file]] for a trackside asset, with the Standard Tags excluded for brevity: | Sample [[config.txt file]] for a trackside asset, with the Standard Tags excluded for brevity: | ||
| − | + | kind "scenery" | |
| − | + | trackside -2.8 | |
| − | + | light 1 | |
| − | + | follow-gradient 0 | |
| − | + | mesh-table | |
{ | { | ||
default | default | ||
| Line 62: | Line 73: | ||
==Categories== | ==Categories== | ||
| − | [[Category:Asset KIND]] | + | [[Category:Asset KIND|S]] |
Latest revision as of 09:44, 28 April 2018
KIND Scenery-trackside provides the basis for all track-attached scenery assets, such as trackside signs and devices.
This asset type inherits all map object characteristics except positioning, and adds trackside positioning and TrackSearch semantics.
The config.txt file for a KIND Scenery-trackside asset has the same kind scenery entry as KIND Scenery for historical reasons, however the two kinds are quite distinct and should not be confused. A KIND Scenery-trackside will contain a trackside tag, whereas KIND Scenery does not.
Contents |
[edit] KIND Hierarchy
[edit] Parent Classes
[edit] Child Classes
[edit] Supported Tags
Each trackside asset supports the following tags. Each tag is shown here with its default value.
trackside 0
speedlimit 0
buffer-speed 0
follow-gradient 0
trackmark 0
search-limit 0
placeable-on-splines-of-group
{
}
[edit] buffer-speed
- Type: Decimal
- Desc: Used for buffers, this sets the maximum speed, in meters per second, at which the buffer can stop a train. If the Train passes the track-side object travelling faster than the buffer speed it will derail. If it's traveling below, or equal, to the buffer speed the train will stop harmlessly.
[edit] follow-gradient
- Type: Boolean
- Desc: If true (1) the object will be oriented perpendicular to the track gradient. If false (0 - default) the asset will be oriented vertically, ignoring the track gradient.
[edit] placeable-on-splines-of-group
- Introduced: trainz-build 3.5
- Type: KUID list container, TBD.
- Desc: A list of asset groups describing the spline types on which this trackside object may be placed. This object cannot be placed on a spline unless the spline is a member of one of the groups specified here. If not specified, the list defaults to a single entry, <kuid:30501:100043>.
[edit] search-limit
- Type: Boolean
- Desc: Search limit objects are used by the Driver AI and indicate the direction of travel for a section of track.
[edit] speedlimit
- Type: Decimal
- Desc: Sets the speed limit, in meters per second, for the track it is placed on, after the object. If this tag is provided with no value, the speed limit will be set to 100m/s.
[edit] trackmark
- Type: Boolean
- Desc: Specifies if the object is a trackmark. Trackmarks can be used to place consists in TrainzScript.
[edit] trackside
- Type: Float
- Compulsory: 3.4
- Desc: The distance, in meters, the object will be placed from the center of the track. Negative values will put the object on the left side of the track, and positive values will place it on the right.
[edit] Example Config.txt
Sample config.txt file for a trackside asset, with the Standard Tags excluded for brevity:
kind "scenery"
trackside -2.8
light 1
follow-gradient 0
mesh-table
{
default
{
mesh "CatchPoint.im"
auto-create 1
}
}
[edit] Downloads
Attach sample files here?
