CCG/Other Regularly Used Tags

From TrainzOnline
< CCG
Jump to: navigation, search

Contents

Other Regularly Used Tags

Some tags are not present in every single kind, but appear across a number of different common kinds. The most common of these are detailed in this section.

alias

Kuid of the asset to be referenced as a basis for the new asset. For example TRS Traincars can reference archived locomotive mesh assets for use with custom textures. This process is done by aliasing the KUID of the archived traincars.

Kinds that use this tag:

bogey, bridge, buildable, chunky-track, double-track, drivercharacter, fixedtrack, industry, interior, mesh-reducing-track, mesh, mocrossing, mojunction, mosignal, mospeedboard, pantograph, product, scenery-trackside, scenery, track, traincar, tunnel, turntable.


autoname

When enabled, automatically assigns a unique name to this object as it is placed.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


class

This refers to the name of the script file and the class of asset it is (the class must match that stated within the script file).

Kinds that use this tag:

activity, behavior, bogey, bridge, buildable, chunky, track, double-track, drivercharacter, drivercommand, engine, enginesound, environment, fixedtrack, groundtexture, hornsound, html-asset, industry, interior, library, mesh-reducing-track, mesh, mocrossing, mojunction, mospeedboard, paintshed-skin, paintshed-template, pantograph, product-category, product, profile, region, scenery-trackside, scenery, steam-engine, texture-group, texture, track, tracksound, traincar, tunnel, turntable, water2.


dighole

Specifies the number of grid segments (length, width) to be removed from the surveyor grid to accommodate the turntable pit. The grid divisions are 10 metres square.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


floating

Obsolete tag.

Kinds that used this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


height

Height from the track level to the base. Should be negative for bridges and positive for tunnels.

Kinds that use this tag:

bridge, buildable, double-track, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, tunnel, turntable.


height-range

min, max. eg: height-range ­10, 100, where min and max are values in meters. This allows you to specify the minimum and maximum height ranges for adjusting the height of this object with the "Adjust Height" tool in Surveyor's `Object Tools' panel.
All scenery objects have a default min/max height range of 0 and 0. i.e. they do not (by default) allow you to adjust the height. Adding a height range is particularly useful for ships/buoys (placed on water) and for Station accessories.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


icon0, icon1, icon2, icon3

Small icon displayed over the vehicle preview in Surveyor.

Kinds that use this tag:

bogey, buildable, drivercharacter, fixedtrack, industry, interior, mesh, mocrossing, mojunction, mosignal, mospeedboard, pantograph, product, scenery-trackside, scenery, traincar, turntable.


icon-texture

May be used as a specific tag, or the icon-texture file may be included in the tumbnails container instead.
The file for products can use an alpha channel (to cut out the circular image) but it is recomended the file for the industry drive to option does not need an alpha channel, to reduce impact on Trainz frame rate.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, product, scenery-trackside, scenery, traincar, turntable.


light

Sets lighting to be used for the object to be ambient or directional. 0 sets ambient lighting and object is lit by general light value, (uniformly lit). 1 sets directional light which is affected by the position of the sun, and the asset shows shaded faces, but not ground shadows.

Kinds that use this tag:

bridge, buildable, chunky-track, double-track, fixedtrack, industry, mesh-reducing-track, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, track, traincar, tunnel, turntable.


preview-mesh-kuid

Only add this to reference a different mesh for the Surveyor preview window. This is useful when an asset has a large bounding box. i.e. the large "Airport" with it's jet animation, the detail would be too small in the window. Some assets such as in-built fixed track assets do not have a mesh, and require a preview mesh reference to show a display in the Surveyor asset menu window.

Kinds that use this tag:

bogey, buildable, drivercharacter, fixedtrack, industry, interior, mesh, mocrossing, mojunction, mosignal, mospeedboard, pantograph, product, scenery-trackside, scenery, traincar, turntable.


preview-scale

Scale of the preview mesh.

Kinds that use this tag:

bogey, buildable, drivercharacter, fixedtrack, industry, interior, mesh, mocrossing, mojunction, mosignal, mospeedboard, pantograph, product, scenery-trackside, scenery, traincar, turntable.


nightmode

Only add this tag if you reference a default-night mesh in the mesh-table. It is mandatory if you want a night mesh to show.
Values: home, lamp or constant.
Home - switches on night effects at dusk and off sometime during the night.
Lamp - switches the night effects on from dusk to dawn.
Constant - lights are on day and night.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


rgb

This value should be left as default.

Kinds that use this tag:

bridge, buildable, chunky-track, double-track, fixedtrack, industry, mesh-reducing-track, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, track, traincar, tunnel,turntable.


rollstep

Used in conjunction with rotate-yz-range, rollstep lets you specify the step size of roll angles (in degrees) for this object. Other example values are 1, 5, 20 etc. The default rollstep is 1.0.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


rotate

This lets you disable rotation on a scenery object, 0 to disable 1 to enable (default).

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard,scenery-trackside, scenery, traincar, turntable.


rotate-yz-range

This tag lets you set the roll / yz rotation range (normal object rotation is an xy rotation), where min and max are values in degrees.
If you want your scenery object to support rolling then use this tag to set the minimum and maximum roll range. By default, objects have a min/max roll range of 0 to 0.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


rotstep

This lets you specify the step size of rotation angles (in degrees) for this object. Other example values are 1, 10, 20, 90, 180 etc. The default rotstep is 1.0

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


script

The script file (gs or gse file).

Kinds that use this tag:

activity, behavior, bogey, bridge, buildable, chunky,track, double-track, drivercharacter, drivercommand, engine, enginesound, environment, fixedtrack, groundtexture, hornsound, html-asset, mocrossing, mojunction, mospeedboard, paintshed-skin, paintshed-template, pantograph, product-category, product, profile, region, scenery-trackside, scenery, steam-engine, texture-group, texture, track, tracksound, traincar, tunnel, turntable, water2.


snapgrid

This lets you specify the size of the grid (in meters) the object snaps to.
We recommend factors/fractions of 720 as this is the size of a base board and the positioning may do odd things across section borders.
eg 1, 2, 5, 10, 20, 30, 40, 45, 60, 80, 90, 120, 180, 240, 360, 720.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


snapmode

Specifies the alignment of the turntable to the surveyor grid.
1 = origin snaps to grid intersections (use when removing even dighole values),
2 = origin snaps to the center of a grid square (use when removing odd dighole values).

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


surveyor-name-label

Specifies if this item has a floating name label text.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


surveyor-only

Adding this means the attached mesh will only be visible in Surveyor and not Driver.

Kinds that use this tag:

buildable, fixedtrack, industry, mocrossing, mojunction, mosignal, mospeedboard, scenery-trackside, scenery, traincar, turntable.


texture

An image texture file.

Kinds that use this tag:

buildable, drivercharacter, fixedtrack, groundtexture, industry, mocrossing, mojunction, mosignal, mospeedboard, product, scenery-trackside, scenery, texture-group, texture, traincar, turntable.


Return to CCG Index

Content Creator's Guide

Personal tools