Category List - Revision history

Ek.skirl: /* Builtin Codes */

2023-08-23T11:24:44Z

Builtin Codes

← Older revision		Revision as of 11:24, 23 August 2023
Line 11:		Line 11:
	The following builtin codes are commonly used:		The following builtin codes are commonly used:

			<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
	* "ACHC" - A [[KIND Achievement-Category]] asset		* "ACHC" - A [[KIND Achievement-Category]] asset
	* "ACHG" - A [[KIND Achievement-Group]] asset		* "ACHG" - A [[KIND Achievement-Group]] asset
Line 65:		Line 66:
	* "?WT" - An object with trigger functionality		* "?WT" - An object with trigger functionality
	* "?WX" - An object with junction functionality		* "?WX" - An object with junction functionality
			</div>

	Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.		Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.

Ek.skirl at 11:23, 23 August 2023

2023-08-23T11:23:19Z

← Older revision		Revision as of 11:23, 23 August 2023
Line 3:		Line 3:
	An asset's category list is typically determined by the game as the content is being installed, however it is also possible to introduce [[Custom category identifier]] for custom machine-parsing purposes. Custom codes always start with a hash ("#") character, whereas builtin codes never do.		An asset's category list is typically determined by the game as the content is being installed, however it is also possible to introduce [[Custom category identifier]] for custom machine-parsing purposes. Custom codes always start with a hash ("#") character, whereas builtin codes never do.

	= Syntax =		== Syntax ==
	A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.		A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.

	When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset. Search queries should typically be qualified to the maximum extent possible; for example "TR;TV" is preferred to "TV" if you wish to indicate a train vehicle. This helps ensure that future additions "fail safe", in the sense that they will not suddenly become "visible" to a script which does not know how to handle them correctly.		When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset. Search queries should typically be qualified to the maximum extent possible; for example "TR;TV" is preferred to "TV" if you wish to indicate a train vehicle. This helps ensure that future additions "fail safe", in the sense that they will not suddenly become "visible" to a script which does not know how to handle them correctly.

	= Builtin Codes =		== Builtin Codes ==
	The following builtin codes are commonly used:		The following builtin codes are commonly used:

Line 69:		Line 69:
	Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.		Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.

	= ~~Build In~~ Codes =		== Buildin Codes (update) ==
	(Update: August 23, 2023)		(Update: August 23, 2023)

	In the Trainz script "asset.gs" there are the current codes defined lines 401ff. The discussion page of this wiki page contains the current set of codes as a copy of the gs-script.		In the Trainz script "asset.gs" there are the current codes defined lines 401ff. The discussion page of this wiki page contains the current set of codes as a copy of the gs-script.

	= Script Functions =		== Script Functions ==
	The following script APIs utilise category lists:		The following script APIs utilise category lists:
	* class TrainzAssetSearch (via FILTER_CATEGORY)		* class TrainzAssetSearch (via FILTER_CATEGORY)
	* class NamedObjectInfo (via categoryString)		* class NamedObjectInfo (via categoryString)
	* World.GetNamedObjectList()		* World.GetNamedObjectList()

Ek.skirl: /* Script Functions */

2023-08-23T11:22:20Z

Script Functions

← Older revision		Revision as of 11:22, 23 August 2023
Line 68:		Line 68:

	Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.		Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.

			= Build In Codes =
			(Update: August 23, 2023)

			In the Trainz script "asset.gs" there are the current codes defined lines 401ff. The discussion page of this wiki page contains the current set of codes as a copy of the gs-script.

	= Script Functions =		= Script Functions =

Pw3r at 03:15, 2 February 2018

2018-02-02T03:15:28Z

← Older revision		Revision as of 03:15, 2 February 2018
Line 61:		Line 61:
	* "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.		* "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.
	* "TX" - A texture asset such as [[KIND Texture]] or [[KIND Texture-Group]]		* "TX" - A texture asset such as [[KIND Texture]] or [[KIND Texture-Group]]
			* "?WA" - An object with signal functionality
			* "?WM" - An object with trackmark functionality
			* "?WT" - An object with trigger functionality
			* "?WX" - An object with junction functionality

Pw3r at 06:39, 3 April 2017

2017-04-03T06:39:50Z

← Older revision		Revision as of 06:39, 3 April 2017
Line 32:		Line 32:
	* "IND" - A [[KIND Industry]] asset		* "IND" - A [[KIND Industry]] asset
	* "INTR" - A [[KIND Interior]] asset		* "INTR" - A [[KIND Interior]] asset
	* "IT" - A [[KIND ~~InterlockingTower~~]] asset		* "IT" - A [[KIND Interlocking-Tower]] asset
	* "LOCO" - A locomotive vehicle		* "LOCO" - A locomotive vehicle
	* "MESH" - A [[KIND Mesh]] or equivalent asset		* "MESH" - A [[KIND Mesh]] or equivalent asset
Line 60:		Line 60:
	* "TUT" - A tutorial session		* "TUT" - A tutorial session
	* "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.		* "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.
	* "TX" - A texture asset such as [[KIND Texture]] or [[KIND ~~TextureGroup~~]]		* "TX" - A texture asset such as [[KIND Texture]] or [[KIND Texture-Group]]

Pw3r at 06:38, 3 April 2017

2017-04-03T06:38:01Z

@@ Line 11: / Line 11: @@
 The following builtin codes are commonly used:
 * "TK" - A "track" spline. Shows in the track tab in Surveyor. Train vehicles run on this spline or its child splines.
-* "SPLN" - A "non track" spline. Shows in the object tab in Surveyor. Train vehicles cannot run on this spline.
+* "TO" - A trackside object
 * "TUN" - A tunnel spline. This typically runs under ground level and typically creates exit holes in the ground mesh.
-* "BRG" - A bridge spline. This typically runs above ground level and typically has child splines.
+* "TURN" - A [[KIND Turntable]] asset
-* "AGRP" - A [[KIND Asset-group]] asset.
+* "TUT" - A tutorial session
 * "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.
-* "TR" - A train-vehicle-related asset.
+* "TX" - A texture asset such as [[KIND Texture]] or [[KIND TextureGroup]]
-* "CMP" - A non-placeable component.
 Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.

Windwalkr at 07:38, 16 March 2017

2017-03-16T07:38:30Z

← Older revision		Revision as of 07:38, 16 March 2017
Line 1:		Line 1:
	Every Asset known to the Trainz environment has an associated [[Category List]] which helps to identify how the asset is used within Trainz. Unlike [[Category Class]], [[Category Era]], and [[Category Region]] codes, these category codes are intended purely for machine parsing and are not typically displayed to the user. They do not distinguish between items that a user might see as different (for example: "person", "house", "plant") but rather between items that the game code needs to treat differently (for example: "track", "scenery", "script library"). The category list implementation primarily exists for [[N3V Games]] internal reasons, however there are some very specific cases where this information is used externally (such as when writing certain types of script).		Every Asset known to the Trainz environment has an associated [[Category List]] which helps to identify how the asset is used within Trainz. Unlike [[Category Class]], [[Category Era]], and [[Category Region]] codes, these category codes are intended purely for machine parsing and are not typically displayed to the user. They do not distinguish between items that a user might see as different (for example: "person", "house", "plant") but rather between items that the game code needs to treat differently (for example: "track", "scenery", "script library"). The category list implementation primarily exists for [[N3V Games]] internal reasons, however there are some very specific cases where this information is used externally (such as when writing certain types of script).

	An asset's category list is typically determined by the game as the content is being installed, however it is also possible to introduce [[Custom category ~~identifiers~~]] for custom machine-parsing purposes. Custom codes always start with a hash ("#") character, whereas builtin codes never do.		An asset's category list is typically determined by the game as the content is being installed, however it is also possible to introduce [[Custom category identifier]] for custom machine-parsing purposes. Custom codes always start with a hash ("#") character, whereas builtin codes never do.

			= Syntax =
	A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.		A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.

	When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset. Search queries should typically be qualified to the maximum extent possible; for example "TR;TV" is preferred to "TV" if you wish to indicate a train vehicle. This helps ensure that future additions "fail safe", in the sense that they will not suddenly become "visible" to a script which does not know how to handle them correctly.		When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset. Search queries should typically be qualified to the maximum extent possible; for example "TR;TV" is preferred to "TV" if you wish to indicate a train vehicle. This helps ensure that future additions "fail safe", in the sense that they will not suddenly become "visible" to a script which does not know how to handle them correctly.

			= Builtin Codes =
	The following builtin codes are commonly used:		The following builtin codes are commonly used:

Windwalkr at 07:37, 16 March 2017

2017-03-16T07:37:20Z

← Older revision		Revision as of 07:37, 16 March 2017
Line 5:		Line 5:
	A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.		A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.

	When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset.		When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("\|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY\|TR;CMP;PANT" will match any bogey or pantograph asset. Search queries should typically be qualified to the maximum extent possible; for example "TR;TV" is preferred to "TV" if you wish to indicate a train vehicle. This helps ensure that future additions "fail safe", in the sense that they will not suddenly become "visible" to a script which does not know how to handle them correctly.

	The following builtin codes are commonly used:		The following builtin codes are commonly used:
Line 41:		Line 41:

	Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.		Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.

			= Script Functions =
			The following script APIs utilise category lists:
			* class TrainzAssetSearch (via FILTER_CATEGORY)
			* class NamedObjectInfo (via categoryString)
			* World.GetNamedObjectList()

Windwalkr: Created page with "Every Asset known to the Trainz environment has an associated Category List which helps to identify how the asset is used within Trainz. Unlike Category Class, [[Categ..."

2017-03-16T07:27:11Z

Created page with "Every Asset known to the Trainz environment has an associated Category List which helps to identify how the asset is used within Trainz. Unlike Category Class, [[Categ..."

New page

Every Asset known to the Trainz environment has an associated [[Category List]] which helps to identify how the asset is used within Trainz. Unlike [[Category Class]], [[Category Era]], and [[Category Region]] codes, these category codes are intended purely for machine parsing and are not typically displayed to the user. They do not distinguish between items that a user might see as different (for example: "person", "house", "plant") but rather between items that the game code needs to treat differently (for example: "track", "scenery", "script library"). The category list implementation primarily exists for [[N3V Games]] internal reasons, however there are some very specific cases where this information is used externally (such as when writing certain types of script).

An asset's category list is typically determined by the game as the content is being installed, however it is also possible to introduce [[Custom category identifiers]] for custom machine-parsing purposes. Custom codes always start with a hash ("#") character, whereas builtin codes never do.

A category list is formed of a small number of short codes, each separated by a semicolon; for example "TR;CMP;BOGY" is the current internal code for a bogey asset. No other assumptions should be made about the category list - the ordering of the codes may vary, additional codes may be present, and so on. There is no guarantee that a given asset will map to the same set of codes in every version of the game, however in practice the list is fairly stable.

When performing a search operation, the semicolon (";") character effectively acts as a "logical and" operator, hence "TR;CMP" matches "TR;CMP;BOGY" but not "TR;BOGY". The bar character ("|") is used in search terms to act as a low-precedence "logical or" operator, so "TR;CMP;BOGY|TR;CMP;PANT" will match any bogey or pantograph asset.

The following builtin codes are commonly used:

* "TK" - A "track" spline. Shows in the track tab in Surveyor. Train vehicles run on this spline or its child splines.
* "SPLN" - A "non track" spline. Shows in the object tab in Surveyor. Train vehicles cannot run on this spline.
* "TUN" - A tunnel spline. This typically runs under ground level and typically creates exit holes in the ground mesh.
* "BRG" - A bridge spline. This typically runs above ground level and typically has child splines.
* "AGRP" - A [[KIND Asset-group]] asset.
* "SS" - A [[KIND Profile]] asset.
* "RT" - A [[KIND Map]] asset.
* "SG" - A [[KIND Savegame]] asset.
* "TUT" - A tutorial session.
* "TO" - A trackside object.
* "TEND" - A tender vehicle.
* "LOCO" - A locomotive vehicle.
* "ROLL" - A rolling stock vehicle.
* "TV" - A [[KIND Traincar]] (train vehicle) asset. Shows in the Train tab in Surveyor.
* "TR" - A train-vehicle-related asset.
* "CMP" - A non-placeable component.
* "ESPC" - A [[KIND Engine]] asset.
* "BOGY" - A [[KIND Bogey]] asset.
* "INTR" - A [[KIND Interior]] asset.
* "PANT" - A [[KIND Pantograph]] asset.
* "HORN" - A [[KIND Hornsound]] asset.
* "ESND" - A [[KIND Enginesound]] asset.
* "REGN" - A [[KIND Region]] asset.
* "RU" - A [[KIND Behavior]] (Rule) asset.
* "DR" - A [[KIND Drivercharacter]] asset.
* "SLIB" - A [[KIND Library]] (Script Library) asset.
* "PROD" - A [[KIND Product]] asset.
* "PRDC" - A [[KIND Product-category]] asset.
* "HT" - A [[KIND HTML-asset]] asset.
* "MESH" - A [[KIND Mesh]] or equivalent asset.

Other builtin codes exist, however they are more limited in use and more likely to be replaced in the future. If you have a specific need to use a builtin code that is not listed here, it is recommended that you contact [[N3V Games]] with the code(s) and the proposed use-cases so that the usage can be vetted for future compatibility.