HowTo/WagonX - Technical Reference - Revision history

Pcas1986: /* trigger */

2024-03-05T00:13:04Z

trigger

← Older revision		Revision as of 00:13, 5 March 2024
Line 808:		Line 808:
	:::*user		:::*user
	:::*event		:::*event
			:::*parent
	:::*condition <b><i>(added in v1.2)</i></b>		:::*condition <b><i>(added in v1.2)</i></b>
	:::*variable <b><i>(added in v1.2)</i></b>		:::*variable <b><i>(added in v1.2)</i></b>
	::::multiple <b><i>(added in v1.2)</i></b>		::::multiple <b><i>(added in v1.2)</i></b>
	:::*both <b><i>(obsolete as of v1.2)</i></b>		:::*both <b><i>(obsolete as of v1.2)</i></b>
	:::*none		:::*none
			<br>
			:User: Used when the property is updated by the user in the Properties Browser.
			:Event: Used when the property is to be triggering by an event initiated by Trainz such as day to night. These are generally the result of messages posted either by the system or other asset scripts.
			:Parent: Used in a child property where the property is to be activated by a parent property.
			:Condition: TBA
			:Variable: TBA
			:Multiple: TBA
			:Both: TBA
			:None: No trigger.
	</td></tr></table>		</td></tr></table>
	<!--end trigger-->		<!--end trigger-->
Line 818:		Line 828:
	<!--start update-events-->		<!--start update-events-->
	<table width=1200><tr><td>		<table width=1200><tr><td>

	====update-events====		====update-events====
	<b><i>(added in v1.2)</i></b>		<b><i>(added in v1.2)</i></b>

Pcas1986: Added changes for WagonX 1.2 (still in development) and some tidy up

2024-02-29T06:24:52Z

Added changes for WagonX 1.2 (still in development) and some tidy up

Show changes

Pcas1986: /* default-index */ added a warning about setting a default value.

2024-02-23T05:02:46Z

default-index: added a warning about setting a default value.

← Older revision		Revision as of 05:02, 23 February 2024
Line 553:		Line 553:
	:Compulsory: No		:Compulsory: No
	:Default: 0		:Default: 0
	:Desc: The default index for the property to start at. This will be 0 if the tag is left out. If it is -1, it will choose a random index to start at.		:Desc: The default index for the property to start at. This will be 0 if the tag is left out. If it is -1, it will choose a random index to start at.<br>
			Warning: If you have a list of values such as "1,2,3,4" and you want to set a default, then you should subtract 1 from the preferred value. For example if you want the first in the list then set the default to 0. This is because the browser counts the list entries from 0 and not 1.
	<!--end default-index-->		<!--end default-index-->
	</td></tr></table>		</td></tr></table>
Line 559:		Line 560:
	<table width=1200><tr><td>		<table width=1200><tr><td>
	<!--start sound-triggers-->		<!--start sound-triggers-->

	====sound-triggers====		====sound-triggers====
	:Type: String - (a list of strings)		:Type: String - (a list of strings)

Pcas1986: Corrected some broken links

2024-02-21T05:01:57Z

Corrected some broken links

← Older revision		Revision as of 05:01, 21 February 2024
Line 1:		Line 1:
	~~<!--the next line is the page title-->~~
	~~<!--HowTo/WagonX - Technical Reference-->~~
	~~<span style="color: red; font-weight: 700; font-size: 30px;">Draft Only</span>~~
	= Document Structure =		= Document Structure =
	<table width=1200>		<table width=1200>
Line 71:		Line 68:
	<!--start of ACS table-->		<!--start of ACS table-->
	<table width=1200>		<table width=1200>
	For help on creating the acs extensions and setting up the acs mesh-table objects, see [[HowTo/~~WagonX~~ - ~~Wagon Tutorial~~#Naming ACS mesh-table attachments~~]] and [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup~~]].		For help on creating the acs extensions and setting up the acs mesh-table objects, see [[HowTo/WagonX_-_Browser_Properties_Examples_and_Basic_Tutorials#Naming_ACS_mesh-table_attachments\|Naming ACS mesh-table attachments]].
	<br>		<br>
	Each tag is shown here with sample values. There are no default values.		Each tag is shown here with sample values. There are no default values.
Line 96:		Line 93:
	<table width=1200>		<table width=1200>
	<!--Note for page author - is this for proper industries such as cargo or is it used for passengers at stations as well?-->		<!--Note for page author - is this for proper industries such as cargo or is it used for passengers at stations as well?-->
	The misc container currently contains times, in seconds, for industry loading and unloading. Usually, these times are used to enable animations to run before or after loading/unloading~~. See also [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup]]~~.		The misc container currently contains times, in seconds, for industry loading and unloading. Usually, these times are used to enable animations to run before or after loading/unloading.

	Each available tag is shown here with sample values. There are no defaults.		Each available tag is shown here with sample values. There are no defaults.
Line 125:		Line 122:
	The Marker-Lights container is used to show or hide light meshes that are identied by entries in the config mesh-table.		The Marker-Lights container is used to show or hide light meshes that are identied by entries in the config mesh-table.

	Each tag is shown here with sample values. There are no defaults. ~~See also [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup]]~~		Each tag is shown here with sample values. There are no defaults.
	<tr><td>		<tr><td>
	marker-lights		marker-lights
Line 167:		Line 164:
	:If set to 1, the lamps will only be visible at night, otherwise they will be displayed 24/7.		:If set to 1, the lamps will only be visible at night, otherwise they will be displayed 24/7.
	*<b>Front/back head/tail containers</b>		*<b>Front/back head/tail containers</b>
	:These containers identify the mesh to use for the front, back, head, and tail lamps. These meshes must be in the config mesh-table~~. See setting up the (LINK NEEDED) wagonx soup for examples~~.		:These containers identify the mesh to use for the front, back, head, and tail lamps. These meshes must be in the config mesh-table.
	</td></tr></table>		</td></tr></table>
	<!--end of Marker-Lights table-->		<!--end of Marker-Lights table-->
Line 545:		Line 542:
	::::*For fx-replacement-type corona, the values are the names of the corona effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].		::::*For fx-replacement-type corona, the values are the names of the corona effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].
	::::*For fx-replacement-type animation, the values are the names of the animation effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].		::::*For fx-replacement-type animation, the values are the names of the animation effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].
	::::*For fx-replacement-type name, the values are the names that will replace the current name of the specified name effect..		::::*For fx-replacement-type name, the values are the names that will replace the current name of the specified name effect.
	<!--end values tag-->		<!--end values tag-->
	</td></tr></table>		</td></tr></table>

Pcas1986: Draft version - checking for links,etc.

2023-09-27T04:57:41Z

Draft version - checking for links,etc.

New page

<span style="color: red; font-weight: 700; font-size: 30px;">Draft Only</span>
= Document Structure =
<table width=1200>
<tr><td>The WagonX Tutorial set is written over several pages. This page is a base reference for using WagonX config containers, their properties and the values for those properties. Other pages in the series are listed below:
</td></tr>
</table>
# [[HowTo/Use the WagonX Library]]<br>
# [[HowTo/WagonX - Browser Properties Examples and Basic Tutorials]]<br>
# [[HowTo/WagonX - Traincar Tutorial]]<br>
# [[HowTo/WagonX - Locomotive Tutorial]]<br>
<br>

__TOC__

= The WagonX Reference =
<table width=1200>
<tr><td>This page contains details of the WagonX extension container and sub-containers. Practical examples of usage can be found in the tutorials listed above.
</td></tr>
</table>
<br>
= Restricted Characters =
<table width=1200>
<tr valign="top">
<td>The characters in the list below cannot be used for some property tag values as they are used by the script to parse or identify values such as list items and other information. They can be used in name and description tags. Use of these characters in tag values is identified in the properties descriptions that follow. Tutorial sections give examples of use. See also [[HowTo/WagonX - Technical Reference#display-values|display-values]].
</td>
</tr>

<tr>
<td>
*Comma ( , )
*Semicolon ( ; )
*Backtick ( ` )
*Colon ( : )
</td>
</tr>
</table>
<br>
= General Layout =
<table width=1200>
<tr valign="top">
<td>WagonX config tags are defined in the extensions container along with other extensions such as ACS Lib. The general layout of the extensions container that also includes ACS Lib might look like this:
</td>
</tr>
<tr><td>
extensions
{
max_permitted_speed-60850 "50mph"
active-coupling-standard-60850
{
...
}
wagon-x
{
...
}
}
</td></tr>
</table>
<br>

= WagonX Properties =
<table width=1200>
<tr valign="top">
<td>There are currently three standard or "top level" WagonX containers that define properties for Marker Lights, a variation of ACSLib and Misc (miscellaneous). In addition to the standard containers, you can define zero or more additonal property containers that are identified by integer value names starting from 0. Each of these containers are defined below.
</td>
</tr>
</table>
== ACS ==

<table width=1200>
For help on creating the acs extensions and setting up the acs mesh-table objects, see [[HowTo/WagonX - Wagon Tutorial#Naming ACS mesh-table attachments]] and [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup]].
<br>
Each tag is shown here with sample values. There are no default values.
<tr><td>
acs
{
animated 1
use-jbv-animation 1
duration 1.0
}

*<b>animated (1 = true, 0=false)</b>
:This determines whether to use animations to move between the coupled and uncoupled state, or use individual static assets for each state.
*<b>use-jbv-animation (1 = true, 0=false)</b>
:An animation system the author (DunDun92) made for compressing buffers and dynamic couplings and hoses, which is now being phased out due to performance problems. leave it at 0, unless you are using the JBV BR Mesh Library or BR class 101 mesh library, or any of his other libraries.
*<b>duration (a floating point value)</b>
:The time, in seconds, that the mesh animation will take to move between the two states. If animated is set to 0, this will determine the fade duration when switching between meshes (fade duration on mesh objects in trainzbuild 5.0 + can get buggy)
</td></tr>
</table> 
<br>

== Misc ==

<table width=1200>

The misc container currently contains times, in seconds, for industry loading and unloading. Usually, these times are used to enable animations to run before or after loading/unloading. See also [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup]].

Each available tag is shown here with sample values. There are no defaults.
<tr><td>
misc
{
begin-load-time 5.0
begin-unload-time 5.0
end-load-time 1.0
end-unload-time 1.0
}

*<b>begin-load-time (a floating point value)</b>
:The time it takes for the wagon to load at an industry
*<b>begin-unload-time (a floating point value)</b>
:The time it takes for the wagon to unloading at an industry
*<b>end-load-time (a floating point value)</b>
:The time it takes for the wagon end loading at an industry
*<b>end-unload-time (a floating point value)</b>
:The time it takes for the wagon to end unloading at an industry
</td></tr>
</table>


== Marker-Lights ==

<table width=1200>
The Marker-Lights container is used to show or hide light meshes that are identied by entries in the config mesh-table.

Each tag is shown here with sample values. There are no defaults. See also [[HowTo/WagonX - Wagon Tutorial#Setting up the WagonX soup]]
<tr><td>
marker-lights
{
enabled 1
car-minimum-count 1
require-locomotive 1
night-only 0
front
{
head
{
mesh "null"
}
tail
{
mesh "lamp-front-red"
}
}
back
{
head
{
mesh "lamp-back-white"
}
tail
{
mesh "lamp-back-red"
}
}
}

*<b>enabled (1 = true, 0=false)</b>
:Whether or not the marker lights are active on this asset.
*<b>car-minimum-count (an integer number)</b>
:The minimum number of cars that must be present in the consist for the marker-lights to activate.
*<b>require-locomotive (1 = true, 0=false)</b>
:If set to 1, a traincar of Class locomotive will need to be present in the consist for the marker-lights to activate.
*<b>night-only (1 = true, 0=false)</b>
:If set to 1, the lamps will only be visible at night, otherwise they will be displayed 24/7.
*<b>Front/back head/tail containers</b>
:These containers identify the mesh to use for the front, back, head, and tail lamps. These meshes must be in the config mesh-table. See setting up the (LINK NEEDED) wagonx soup for examples.
</td></tr></table>


== Browser-Properties ==

<table width=1200>
<tr><td>
*The browser-properties container is a set of zero or more property containers that hold settings for a property such as a smoke effect, an attachment or even texture replacement. They are quite flexible and suitable most any traincar/loco property.
*A property can have sub properties that are activated with their parent.
*A property container has a number of tags with values. Many are common to different property types but some are unique to a property.
*A container need not contain all available tags.
*We start with a sample of two properties: one for a texture replacement (skin) and the second for a handbrake activation. These are representative only and may not be suitable for your asset,
</td></tr>

<tr><td>
browser-properties
{
0
{
enabled 1
property-visibility 1
name "Skin: "
property-id "p_skin"
consist-property-sync 1
description "Sets the weathering type"
kind "fx-replacement"
fx-replacement-type "texture-replacement"
meshes "null"
effects "texture-albedo,texture-parameter"
asset "texturelib"
files-path "null"
values "0;3,1;4,2;5"
default-index -1
trigger "user"
display-type "link"
display-values "Clean,Weathered,Dirty"
}
1
{
enabled 1
property-visibility 0
name "Handbrake State: "
property-id "p_handbrake"
description "Toggle the handbrake"
kind "mesh-attachment"
mesh-attachment-type "mesh-animation-frame"
meshes "handbrake-lever,braking-system"
values "0;0,30;30"
events "handbrake-release,handbrake-apply"
duration 3.2
default-index 0
trigger "both"
display-type "link"
display-values "release,apply"
}
}
</td></tr>
</table>

<table width=1200><tr><td>
===Supported Tags===
Tag explanations. Some examples are included in the definition and, for others, see above for sample of usage.
</td></tr></table>

<table width=1200><tr><td>
====enabled====
:Type: Boolean (1 = true, 0=false)
:Compulsory: No
:Default: No default.
:Desc: Whether or not this property is active. This is useful for debugging, or if you want to disable it without removing everything.
</td></tr></table>

<table width=1200><tr><td>
====property-visibility====
:Type: Integer - (0 = Hidden, 1 = Visible, 2 = Surveyor Only, 3 = Driver Only)
:Compulsory: No
:Default: 0 (hidden)
:Desc: Indicates whether the property will be visible in the Properties Browser and in what mode.
</td></tr></table>

<table width=1200><tr><td>
====name====
:Type: String
:Compulsory: Yes
:Default: None
:Desc: The display name of this property, as will appear on the properties page.
</td></tr></table>

<table width=1200><tr><td>
====child-properties====
:Type: A string of numbers separated by commas.
:Compulsory: No
:Default: None
:Desc: The list of properties that will activate when this property is activated. They will activate at the same index as the parent, similar to consist-property-sync. The property-visibility tag for the child properties should be set to 0. The child properties cannot have their own child-properties tag, and the property-visibility of the child-property must be 0, else it will not activate. You cannot set the child-property to yourself either.
:Example: child-properties "2,4,5"
</td></tr></table>

<table width=1200><tr><td>
====property-id====
:Type: String
:Compulsory: Yes
:Default: None
:Desc: The formal name (ID) of this property, used to identify and change this property. For example, If the name is <b>Workflow</b>, it might be a good idea to call this <b>p_workflow</b>. <div style="color: #ff0080">This must be unique for each browser-property</div>.
</td></tr></table>

<table width=1200><tr><td>
====consist-property-sync====
:Type: Integer - (0 off, 1 on (button), 2 on (automatic)
:Compulsory: No
:Default: None
:Desc: Whether or not to sync the property within the consist, if a tag with the same [[HowTo/WagonX - Technical Reference#property-sync-id]] exists in the other assets. Omitting or setting the tag to 0 disables this. Setting it to 1 will create a button to the right of the property that can be clicked on to sync the property. Setting it to 2 will automatically sync the property across the consist whenever a change in the property is detected.
</td></tr></table>

<table width=1200><tr><td>
====property-sync-id====
:Type: String
:Compulsory: No
:Default: None
:Desc: The ID that determines which assets will be affected when consist-property-sync is activated. Only assets that share this ID will be synced in the consist, so be sure to make it particular and unique.
:Example: property-sync-id "soundBell"
</td></tr></table>

<table width=1200><tr><td>
====description====
:Type: String
:Compulsory: No
:Default: None
:Desc: The description of this attachment as it will appear in the Properties Browser.
</td></tr></table>

<table width=1200><tr><td>
====kind====
:Type: String
:Compulsory: No
:Default: None
:Desc: The type of property this will be. Can be one of the options below. Most of these are derived from [[Class MeshObject|Class_MeshObject]]. For more info on implementing these, see [[HowTo/WagonX - Technical Reference#values]].
::*mesh-attachment
:::Manipulate the mesh’s animation, position, visibility, etc. See mesh-attachment-type.
::*fx-replacement
:::Change an effect in the mesh. See [[HowTo/WagonX - Technical Reference#fx-replacement-type]].
::*particle-effect
:::Activate/Deactivate/Edit a particle effect (smoke0, smoke1, etc). See [[HowTo/WagonX - Technical Reference#particle-effects]] and [[HowTo/WagonX - Technical Reference#particle-effect-type]].
::*sound-script
:::Used to play a sound-script sound within this asset. See [[HowTo/WagonX - Technical Reference#sound-triggers]].
::*config-edit
:::Used to edit a tag in the wagon-x config soup. See paths.

====particle-effect-type====
:Type: String (kind mesh-attachment only)
:Compulsory: No
:Default: None
:Desc: The type of PFX function this property will be if the [[HowTo/WagonX - Technical Reference#kind]] tag is set to particle-effect. Each one is hyperlinked to the corresponding trainzscript function, though it is not necessary to know them. See [[HowTo/WagonX - Technical Reference#values]] for instructions on how to implement these properties. Currently, only pfx-message is supported.
:Example: kind "particle-effect"
: particle-effect-type "pfx-message"
::*[[pfx_Message|<span style="color: #0080ff">pfx-message</span>]]
:::Send a message to enable/disable a particle effect.
</td></tr></table>

<table width=1200><tr><td>

====mesh-attachment-type====
:Type: String - (kind mesh-attachment only)
:Example: kind "mesh-attachment"
:: mesh-attachment-type "mesh-animation-frame"
:Compulsory: No
:Default: None
:Desc: The type of mesh property this property will be if the kind tag is set to mesh-attachment. Each one is hyperlinked to the corresponding trainzscript function, though it is not necessary to know them. See values for instructions on how to implement these properties.
::*[[Class_MeshObject#SetMeshVisible|<span style="color: #0080ff">mesh-toggle</span>]]
:::Toggle between the mesh(s) being visible or hidden.
::*[[Class_MeshObject#SetMeshOrientation|<span style="color: #0080ff">mesh-translation-orientation</span>]]
:::Sets the translation and orientation of the mesh(es)
::*[[Class_MeshObject#SetMeshAnimationFrame|<span style="color: #0080ff">mesh-animation-frame</span>]]
:::Sets the frame(s) the meshes animation will move between. Useful for door opening and closing animations, or animations that require more than 2 states.
::*[[Class_MeshObject#StartMeshAnimationLoop|<span style="color: #0080ff">mesh-animation-loop</span>]]
:::Start or stop an animation-loop on the mesh.
::*[[Class_MeshObject#SetMeshAnimationState|<span style="color: #0080ff">mesh-animation-state</span>]]
:::Sets the state of the mesh(s) animation.
::*[[Class_MeshObject#SetMeshAnimationSpeed|<span style="color: #0080ff">mesh-animation-speed</span>]]
:::Changes the speed of the meshes animation.

</td></tr></table>

<table width=1200><tr><td>

====fx-replacement-type====
:Type: String)(kind fx-replacement only)
:Example: kind "fx-replacement"
:::fx-replacement-type "texture-replacement"
:Compulsory: No
:Default: None
:Desc: The type of fx replacement effect this property will be if the [[HowTo/WagonX - Technical Reference#kind]] tag is set to fx-replacement. Each one is hyperlinked to the corresponding trainzscript function, though it is not necessary to know them. See [[HowTo/WagonX - Technical Reference#values]] for instructions on how to implement these properties.
::*[[Class_MeshObject#SetFXTextureReplacement|<span style="color: #0080ff">texture-replacement</span>]]
:::Replaces a texture effect in this asset to one within a texture-group asset.
::*[[Class_MeshObject#SetFXTextureReplacementTexture|<span style="color: #0080ff">texture-replacement-texture</span>]]
:::Replaces a texture effect in this asset to one located within this asset.
::*[[Class_MeshObject#SetFXCoronaTexture|<span style="color: #0080ff">corona</span>]]
:::Replaces a corona effect in the asset.
::*[[Class_MeshObject#SetFXNameText|<span style="color: #0080ff">name</span>]]
:::Replaces a name effect in the asset.
::*[[Class_MeshObject#SetFXAttachment|<span style="color: #0080ff">attachment</span>]]
:::Replaces an attachment effect in the asset.
::*[[Class_MeshObject#SetFXAnimationState|<span style="color: #0080ff">animation</span>]]
:::Plays/Stops an animation effect in the asset.

</td></tr></table>

<table width=1200><tr><td>

====duration====
:Type: Float
:Compulsory: No
:Default: None
:Desc: For kind mesh-animation and mesh-toggle. This tag determines the time to transition to the next state for the value. If it is 0, the transition will occur instantaneously. <b>(There may be issues with using this tag with mesh-toggle.)</b>
:Example: duration 3.2

</td></tr></table>

<table width=1200><tr><td>

====meshes====
:Type: String - (a list of mesh names from the mesh-table separated by commas)
:Example: meshes "handbrake-lever,braking-system"
:Compulsory: No
:Default: None
:Desc: The comma-separated mesh-table asset(s) to be modified by the property. Use this for [[HowTo/WagonX - Technical Reference#kind]] mesh-toggle or kind mesh-animation. Use this tag, the effect tag, or the asset tag, but not more than one.

</td></tr></table>

<table width=1200><tr><td>

====effects====
:Type: String - (a list of texture names (i.e. texture.txt names without the .txt) each separated by a comma)
:Example: effects "texture-albedo,texture-parameter"
:Compulsory: No
:Default: None
:Desc: The comma-separated effect(s) to be modified by the property. Only use this tag if you are using [[HowTo/WagonX - Technical Reference#kind]] fx-replacement. Use this tag, the mesh tag, or the asset tag, but not more than one.

</td></tr></table>

<table width=1200><tr><td>

====particle-effects====
:Type: String - (a list of integer numbers as a string)
:Example: particle-effects "0,1"
:Compulsory: No
:Default: None
:Desc: For kind particle-effect. The comma-separated list of PFX effects to be modified by the property. See kind for help on implementation. <b>There is currently no use for this tag as of yet. pfx-message doesn't need this because everything is already specified in the values tag.</b>

</td></tr></table>

<table width=1200><tr><td>

====target-asset====
:Type: String
:Example: target-asset "bogey-0"
:Compulsory: No
:Default: None
:Desc: This determines which assets config this property will manipulate. This tag is currently only used for manipulating a vehicles bogey (e.g. texture replacement). The name must be “bogey-” + the index of the bogey to edit. This gives you full access to the bogeys mesh-table, allowing you to set texture replacements, mesh toggles, and other properties within the bogey. This tag can be omitted if you are not doing bogey texture replacements. <b>Only properties of kind “mesh-attachment” or “fx-replacement” can be used for properties that use this tag.</b>

</td></tr></table>

<table width=1200><tr><td>

====asset====
:Type: String
:Example: asset "texturelib"
:Compulsory: No
:Default: None
:Desc: The kuid-table asset to be used by the property. Use this for cases where you need to reference another asset outside of this, such as a texture-replacement library. Use this tag, the [[HowTo/WagonX - Technical Reference#effects]] tag, the [[HowTo/WagonX - Technical Reference#meshes]] tag, or the [[HowTo/WagonX - Technical Reference#particle-effects]] tag, but not more than one.

</td></tr></table>

<table width=1200><tr><td>

====files-path====
:Type: String - (a list of two strings)
:Example: files-path "images/,.texture"
:Compulsory: No
:Default: None
:Desc: An optional tag that shortens the number of characters that need to be written to the “values“ tag, assuming they all share the same path or asset library and extension. The path and extension can be specified here (e.g. <b>files-path “images/left/.texture”</b>), where images/left is the path, and .texture is the extension for all the files.

</td></tr></table>

<table width=1200><tr><td>


====paths====
:Type: String - (a list of two strings)
:Example: paths "marker-lights/night-only""
:Compulsory: Yes
:Default: None
:Desc: For kind config-edit. A comma-separated list of paths that point to the tag in the wagon-x config to edit.

</td></tr></table>

<table width=1200><tr><td>

====values====
:Type: String - (a string list separated by special characters)
:Example1 values "0,15,30"
:Compulsory: No
:Default: None
:Desc: A comma-separated (and optionally semicolon-separated) list of all the files/values to be switched between. If the files-path tag is used, only include each file’s name (exclude the path and extension). This tag is required for all properties. If it is not wanted, leave the value at “1”, but keep the tag still. For booleans, use 1 for true, and 0 for false. For animations, specify the animation frames you want to toggle through. For details on using the semicolon separator to shorten properties, see [[HowTo/WagonX - Browser Properties Examples and Basic Tutorials#Using Semicolons to set multiple values in one property]].
:<b>Each kind has its own rules for what to put here, explained below. See the [[HowTo/WagonX - Technical Reference#kind]] property for more info on these.</b>

:::*For kind mesh-attachment:
::::*For mesh-attachment-type mesh-toggle, the value must be either 0 or 1 (visible/hidden) ???
::::*For mesh-attachment-type mesh-translation-orientation, the value must be a 3-dimensional vector with values separated by backticks, enclosed with round brackets for the translation, followed by a colon, then another round bracket-enclosed 3d vector for the orientation, as shown below. 0`2`4 is the translation, and 1.2`2`2 is the orientation (we have to use backticks because the comma is already used here for separating each index value).
::::Example: values "(0`2`4):(1.2`2`2),(0`0`0):(0`0`0)"

:::*For mesh-attachment-type mesh-animation-speed, the value is the speed of the animation for that index
:::*For mesh-attachment-type mesh-animation-loop, the value will be an integer bool (0 or 1) to indicate whether to start the loop, or stop it. You can create a separate property that controls the mesh-animation-speed, and link it via a [[HowTo/WagonX - Technical Reference#child-properties]] property to control the speed of the loop.
:::*For mesh-attachment type mesh-animation-frame, the value is the frame of the animation to jump to. Setting it to -1 will put that index at the last animation frame in the mesh (see [[Class_MeshObject#GetMeshAnimationFrameCount|<span style="color: #0080ff">GetMeshAnimationFrameCount</span>]]).
::::Example: values "0,30"
:::*For mesh-attachment-type mesh-animation-loop, the value can be 0 or 1, to start/stop the loop

:::*For kind sound-script, the value can be 0 or 1, to start/stop the soundscript event

:::*For kind config-edit, the value is a string indicating the string value to assign to the config tag.

:::*For kind particle-effect:
:::*For particle-effect-type pfx-message, the value follows the same rules for [[pfx message|<span style="color: #0080ff">pfx messages</span>]].
::::*particle-effect-type "pfx-message"
::::Example: values "+0+1,-1-0"

:::*For kind fx-replacement:
::::*For fx-replacement-type texture-replacement, the comma and/or. semicolon-separated values represent the index in the texture-group asset to find the texture. Setting the first value to 1 will reference the texture index 1, shown in the partial config for a textures asset below:
::::Values “0,2,1” will reference the textures in the texture container at indexes 0, 2, and 1, in that order when cycled through.
::::Example: values “0,2,1”

kuid <kuid:1234:123456>
username "test texture group asset"
trainz-build 4.6
description "test texture group"
textures
{
0 "textures\0albedo.texture"
1 "textures\1albedo.texture"
2 "textures\2albedo.texture"
3 "textures\0parameter.texture"
4 "textures\1parameter.texture"
5 "textures\2parameter.texture"
6 "textures\0normal.texture"
7 "textures\1normal.texture"
8 "textures\2normal.texture"
}

::::*For fx-replacement-type texture-replacement-texture, the comma and/or semicolon-separated values are the names of the files (ideally without the path or extension) to be referenced at that index.
::::Example: values "images/congleton.texture,images/burntisland.texture,images/buxton.texture,images/none.texture"
::::If you have the same path (and same extension) for all your files, you can greatly reduce the clutter by just specifying the path and extension once using the files-path tag. So, in this case the values entry would be:
::::Example: values "congleton,burntisland,buxton,none"

0
{
enabled 1
property-visibility 1
name "Workflow Text: "
property-id "p_workflow"
description "Sets the Workflow"
kind "fx-replacement"
fx-replacement-type "texture-replacement-texture"
consist-property-sync 1
meshes "null"
effects "texture-extra"
asset "null"
files-path "images/,.texture"
values "congleton,burntisland,buxton,none"
default-index 0
trigger "user"
display-type "list"
display-values "Congleton,Burntisland,Buxton,None"
}

::::*For fx-replacement-type attachment, the values are the names of the attachment effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].
::::*For fx-replacement-type corona, the values are the names of the corona effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].
::::*For fx-replacement-type animation, the values are the names of the animation effects to be replaced by the specified [[HowTo/WagonX - Technical Reference#asset]].
::::*For fx-replacement-type name, the values are the names that will replace the current name of the specified name effect..

</td></tr></table>

<table width=1200><tr><td>

====default-index====
:Type: Integer (-1 = random)
:Example: default-index 0
:Compulsory: No
:Default: 0
:Desc: The default index for the property to start at. This will be 0 if the tag is left out. If it is -1, it will choose a random index to start at.

</td></tr></table>

<table width=1200><tr><td>

====sound-triggers====
:Type: String - (a list of strings)
:Example: sound-triggers "bell_1,bell_2"
:Compulsory: No
:Default: None
:Desc: For kind sound-script only. This specifies the soundscript trigger(s) (comma separated) that this property will start/stop when the property is activated.

</td></tr></table>

<table width=1200><tr><td>

====trigger====
:Type: String
:Example: trigger "user"
:Compulsory: No
:Default: Null (ignored)
:Desc: The event that will trigger/activate this property. Can be either an external event, such as a coal-loading animation, or a user-controlled event, or both. Setting it to none is useful if this is a [[HowTo/WagonX - Technical Reference#child-properties]] property of another property. Possible values are:
:::*user
:::*event
:::*both
:::*none

</td></tr></table>

<table width=1200><tr><td>

====events====
:Type: String - (a list of strings)
:Example: events "handbrake-release,handbrake-apply"
:Compulsory: No
:Default: None
:Desc: For trigger kind “event” only. An array of the event(s) that must take place for the property value at the index to activate. Can be one of the following (separated by forward slashes and commas to save space).
:::*begin-load/end-load/begin-unload/end-unload
:::*handbrake-apply/handbrake-release
:::*trainbrake-apply/trainbrake-release
:::*headlight-on, headlight-off
:::*horn
:::*bell
:::*sanding
:::*pantograph-state-0/1/2/3 (see [[Class_Train#GetPantographState|<span style="color: #0080ff">GetPantographState</span>]])
:::*weather-0/1/2/3/4/5/6/7 (see [[Class_World#GetWeatherType|<span style="color: #0080ff">GetWeatherType</span>]])
:::*world-day/world-night
:::*queue-(0 - ?)- loaded/empty (e.g. <b>queue-0-loaded, queue-1-empty</b>)

</td></tr></table>

<table width=1200><tr><td>

:Type: String
:Example: display-type "link"
:Compulsory: No
:Default: None
:Desc: For trigger type “user” and “event” only. The type of button this will be. It can be any of the trainz property browser value types, plus “manual”, but not map-object or asset-list. <b>For trainzbuild 5.1 and 5.0, only link is supported for the View Details page.</b> Omitting this tag in combination with property-visibility set to 0 is useful for non-user triggers, such as world or train events.
:::*string
:::*int
:::*float
:::*list
:::*link

</td></tr></table>

<table width=1200><tr><td>

====display-values====
:Type: String - (a list of strings)
:Example: display-values "Clean,Weathered,Dirty"
:Compulsory: No
:Default: None
:Desc: For trigger type “user” and “event” only, and required for trigger type “user” properties to work, but optional for trigger type “event”. A list of comma-separated values which will be displayed in the view details page for the respective property. The number of values here must match the number of values in the “values” tag.

</td></tr></table>

<table width=1200>
=Copyright Notice=
Much of the content on this page and child pages was derived from Dundun92's original Google Docs document. Permission was granted to use that information here.
</table>