KIND Product - Revision history

Mjolnir: /* Supported Tags */

2014-06-25T18:42:21Z

Supported Tags

← Older revision		Revision as of 18:42, 25 June 2014
Line 13:		Line 13:

	=Supported Tags=		=Supported Tags=
	The [[KIND Product]] [[config.txt file]] supports the following tags. Each tag is ~~show~~ here with its default value.		The [[KIND Product]] [[config.txt file]] supports the following tags. Each tag is shown here with its default value.

	kind "product"		kind "product"
Line 69:		Line 69:
	:Compulsory: No		:Compulsory: No
	:Desc: The ''product-texture'' tag allows the specification of a local texture file to use when this product is visible as a bulk load. (TBD: link to product queue description.)		:Desc: The ''product-texture'' tag allows the specification of a local texture file to use when this product is visible as a bulk load. (TBD: link to product queue description.)


	=Downloads=		=Downloads=

Pcas1986: Changed format to other similar pages

2014-02-14T04:37:33Z

Changed format to other similar pages

← Older revision		Revision as of 04:37, 14 February 2014
Line 1:		Line 1:
	~~{{ORP-top}}~~
	==Product data type tag==		==Product data type tag==
	'''KIND Product''' defines a "product type" for use with Trainz interactive industries. Products are not directly placeable within the game, but [[KIND Industry]], [[KIND Traincar]] may be configured to consume, produce, or contain the various product types. Individual product instances may be visible to the user in-game.		'''KIND Product''' defines a "product type" for use with Trainz interactive industries. Products are not directly placeable within the game, but [[KIND Industry]], [[KIND Traincar]] may be configured to consume, produce, or contain the various product types. Individual product instances may be visible to the user in-game.
Line 16:		Line 15:
	The [[KIND Product]] [[config.txt file]] supports the following tags. Each tag is show here with its default value.		The [[KIND Product]] [[config.txt file]] supports the following tags. Each tag is show here with its default value.

			kind "product"
	instance-type "resource"		instance-type "resource"
	mass 0.0		mass 0.9
	product-category <NULLKUID>		product-category <NULLKUID>
	product-texture ""		product-texture ""
	icon-texture ""		icon-texture ""
	allows-mixing 0		allows-mixing 1

			====kind====
			:Type: String
			:Compulsory: Yes from 3.4
			:Desc: Identifies the asset as Kind Product.

			====allows-mixing====
			:Type: Boolean
			:Compulsory: Yes from 3.4
			:Desc: If set to '1', this product type may be mixed with other products in a single product queue. This is appropriate for some classes of boxed goods, for example, but not appropriate for most gases, liquids, or solid bulk loads such as gravel or coal.

			====icon-texture====
			:Type: String (image file name including path)
			:Compulsory: No
			:Desc: The ''icon-texture'' tag defines an icon which is used when referring to this product in-game, for example in a [[KIND Industry]] configuration panel.

	====instance-type====		====instance-type====
			:Type: String
			:Compulsory: Yes from 3.4
			:Desc: This tag describes how products of this type are created (instanced) within a [["queues" Container\|product queue]] and may be one of the following values:

	{\| border~~=1 cellspacing~~=1 cellpadding=2		{\| border=1 cellpadding=2\|colspan=2\|
	\|colspan="2~~"\|<font size="+1">The ''instance-type'' tag describes how products of this type are instanced within a [["queues" Container\|product queue]] and may be one of the following values:</font>~~		\| '''''resource''''' \|\| This indicates that instances of this product type are uniform, and that the software can track this product with a total number rather than a description of each instance.
	\|-
	\| '''''resource'''''\|\| This indicates that instances of this product type are uniform, and that the software can track this product with a total number rather than a description of each instance.
	* ''This is by far the most efficient 'instance-type' and should be used unless there is a very strong reason to use another type.''		* ''This is by far the most efficient 'instance-type' and should be used unless there is a very strong reason to use another type.''
	\|-		\|-
	\|'''''instance''''' \|\| This indicates that each instance of this product is of a specific sub-type. The subtype is assigned randomly when the instance is first created, but is preserved as the instance is moved from queue to queue throughout the system.		\|'''''instance''''' \|\| This indicates that each instance of this product is of a specific sub-type. The subtype is assigned randomly when the instance is first created, but is preserved as the instance is moved from queue to queue throughout the system.
	* Queues of this ''instance-type'' are currently limited to 254 instances for performance reasons.		* Queues of this ''instance-type'' are currently limited to 254 instances for performance reasons.
	\|-		\|-
	\| '''''unique''''' \|\| This indicates that each instance of this product is a true gamescript object. The object is preserved as the instance is moved from queue to queue throughout the system.		\| '''''unique''''' \|\| This indicates that each instance of this product is a true gamescript object. The object is preserved as the instance is moved from queue to queue throughout the system.
	* Queues of this ''instance-type'' are currently limited to 4 instances for performance reasons.		* Queues of this ''instance-type'' are currently limited to 4 instances for performance reasons.
	\|}		\|}


	====mass====		====mass====
	Determines the mass (in kilograms) of a single unit (or, single instance) of this product. This is used when calculating the mass of a loaded [[KIND Traincar]] instance.		:Type: Float
			:Compulsory: Yes from 3.4
			:Desc: Determines the mass (in kilograms) of a single unit (or, single instance) of this product. This is used when calculating the mass of a loaded [[KIND Traincar]] instance.

	====product-category====		====product-category====
	Each product type may be assigned to a single [[KIND Product-category]].		:Type: Kuid
			:Compulsory: Yes
			:Desc: Each product type may be assigned to a single [[KIND Product-category]].

	====product-texture====		====product-texture====
	The ''product-texture'' tag allows the specification of a local texture file to use when this product is visible as a bulk load. (TBD: link to product queue description.)		:Type: String (image file name including path)
			:Compulsory: No
			:Desc: The ''product-texture'' tag allows the specification of a local texture file to use when this product is visible as a bulk load. (TBD: link to product queue description.)
	~~====icon-texture====~~
	~~The ''icon-texture'' tag defines an icon which is used when referring to this product in-game, for example in a [[KIND Industry]] configuration panel.~~


	~~====allows-mixing====~~
	If set to '1', this product type may be mixed with other products in a single product queue. This is appropriate for some classes of boxed goods, for example, but not appropriate for most gases, liquids, or solid bulk loads such as gravel or coal.


Line 64:		Line 76:

	=Categories=		=Categories=
	[[Category:Asset KIND]]		[[Category:Asset KIND\|P]]
	~~{{ORP-bot\|Product,KIND}}~~

Fabartus: /* instance-type */ fmt as table, emp imp pts

2013-07-27T03:06:56Z

instance-type: fmt as table, emp imp pts

← Older revision		Revision as of 03:06, 27 July 2013
Line 25:		Line 25:

	====instance-type====		====instance-type====
	~~The ''instance-type'' tag describes how products of this type are instanced within a [["queues" Container\|product queue]] and may be one of the following values:~~

	* ''resource'' - This indicates that instances of this product type are uniform, and that we can track this product with a total number rather than a description of each instance. This is by far the most efficient ''instance-type'' and should be used unless there is a very strong reason to use another type.
	* ''instance'' - This indicates that each instance of this product is of a specific sub-type. The subtype is assigned randomly when the instance is first created, but is preserved as the instance is moved from queue to queue throughout the system. Queues of this ''instance-type'' are currently limited to 254 instances for performance reasons.
	* ''unique'' - This indicates that each instance of this product is a true gamescript object. The object is preserved as the instance is moved from queue to queue throughout the system. Queues of this ''instance-type'' are currently limited to 4 instances for performance reasons.

			{\| border=1 cellspacing=1 cellpadding=2
			\|colspan="2"\|<font size="+1">The ''instance-type'' tag describes how products of this type are instanced within a [["queues" Container\|product queue]] and may be one of the following values:</font>
			\|-
			\| '''''resource'''''\|\| This indicates that instances of this product type are uniform, and that the software can track this product with a total number rather than a description of each instance.
			* ''This is by far the most efficient 'instance-type' and should be used unless there is a very strong reason to use another type.''
			\|-
			\|'''''instance''''' \|\| This indicates that each instance of this product is of a specific sub-type. The subtype is assigned randomly when the instance is first created, but is preserved as the instance is moved from queue to queue throughout the system.
			* Queues of this ''instance-type'' are currently limited to 254 instances for performance reasons.
			\|-
			\| '''''unique''''' \|\| This indicates that each instance of this product is a true gamescript object. The object is preserved as the instance is moved from queue to queue throughout the system.
			* Queues of this ''instance-type'' are currently limited to 4 instances for performance reasons.
			\|}

	====mass====		====mass====

Fabartus: /* Downloads */ {{Sect-stub}}

2013-07-27T02:54:16Z

Downloads: {{Sect-stub}}

← Older revision		Revision as of 02:54, 27 July 2013
Line 54:		Line 54:
	=Downloads=		=Downloads=
	''Attach sample files here''		''Attach sample files here''
			{{Sect-stub}}

	=Categories=		=Categories=
	[[Category:Asset KIND]]		[[Category:Asset KIND]]
	{{ORP-bot\|Product,KIND}}		{{ORP-bot\|Product,KIND}}

Fabartus: fmt

2013-07-27T02:52:31Z

fmt

← Older revision		Revision as of 02:52, 27 July 2013
Line 1:		Line 1:
	[[KIND Product]] defines a "product type" for use with Trainz interactive industries. Products are not directly placeable within the game, but [[KIND Industry]], [[KIND Traincar]] may be configured to consume, produce, or contain the various product types. Individual product instances may be visible to the user in-game.		{{ORP-top}}
			==Product data type tag==
			'''KIND Product''' defines a "product type" for use with Trainz interactive industries. Products are not directly placeable within the game, but [[KIND Industry]], [[KIND Traincar]] may be configured to consume, produce, or contain the various product types. Individual product instances may be visible to the user in-game.


	=KIND Hierarchy=		==KIND Hierarchy==
			*[[TrainzBaseSpec]]

	==Parent Classes==		==Parent Classes==
	* [[KIND Mesh]]		* [[KIND Mesh]]
Line 54:		Line 58:
	=Categories=		=Categories=
	[[Category:Asset KIND]]		[[Category:Asset KIND]]
			{{ORP-bot\|Product,KIND}}

Windwalkr: 1 revision

2010-02-03T13:59:14Z

1 revision

← Older revision	Revision as of 13:59, 3 February 2010
(No difference)

Windwalkr at 06:43, 3 February 2009

2009-02-03T06:43:12Z

New page

[[KIND Product]] defines a "product type" for use with Trainz interactive industries. Products are not directly placeable within the game, but [[KIND Industry]], [[KIND Traincar]] may be configured to consume, produce, or contain the various product types. Individual product instances may be visible to the user in-game.

=KIND Hierarchy=
==Parent Classes==
* [[KIND Mesh]]
==Child Classes==
* ''none.''

=Supported Tags=
The [[KIND Product]] [[config.txt file]] supports the following tags. Each tag is show here with its default value.

instance-type "resource"
mass 0.0
product-category <NULLKUID>
product-texture ""
icon-texture ""
allows-mixing 0

====instance-type====
The ''instance-type'' tag describes how products of this type are instanced within a [["queues" Container|product queue]] and may be one of the following values:

* ''resource'' - This indicates that instances of this product type are uniform, and that we can track this product with a total number rather than a description of each instance. This is by far the most efficient ''instance-type'' and should be used unless there is a very strong reason to use another type.
* ''instance'' - This indicates that each instance of this product is of a specific sub-type. The subtype is assigned randomly when the instance is first created, but is preserved as the instance is moved from queue to queue throughout the system. Queues of this ''instance-type'' are currently limited to 254 instances for performance reasons.
* ''unique'' - This indicates that each instance of this product is a true gamescript object. The object is preserved as the instance is moved from queue to queue throughout the system. Queues of this ''instance-type'' are currently limited to 4 instances for performance reasons.

====mass====
Determines the mass (in kilograms) of a single unit (or, single instance) of this product. This is used when calculating the mass of a loaded [[KIND Traincar]] instance.

====product-category====
Each product type may be assigned to a single [[KIND Product-category]].

====product-texture====
The ''product-texture'' tag allows the specification of a local texture file to use when this product is visible as a bulk load. (TBD: link to product queue description.)

====icon-texture====
The ''icon-texture'' tag defines an icon which is used when referring to this product in-game, for example in a [[KIND Industry]] configuration panel.

====allows-mixing====
If set to '1', this product type may be mixed with other products in a single product queue. This is appropriate for some classes of boxed goods, for example, but not appropriate for most gases, liquids, or solid bulk loads such as gravel or coal.

=Downloads=
''Attach sample files here''

=Categories=
[[Category:Asset KIND]]