KIND Product

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(fmt)
m (→‎Supported Tags)
 
(3 intermediate revisions by 2 users not shown)
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 14: 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"
 
  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====
−
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:
+
: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:
  
−
* ''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.
+
{| border=1 cellpadding=2|colspan=2|
−
* ''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.
+
| '''''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.  
−
* ''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.
+
* ''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====
−
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.
+
−
 
+
  
 
=Downloads=
 
=Downloads=
 
''Attach sample files here''
 
''Attach sample files here''
−
 
+
{{Sect-stub}}
  
 
=Categories=
 
=Categories=
−
[[Category:Asset KIND]]
+
[[Category:Asset KIND|P]]
−
{{ORP-bot|Product,KIND}}
+

Latest revision as of 04:42, 26 June 2014

Contents

[edit] 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.


[edit] KIND Hierarchy

[edit] Parent Classes

[edit] Child Classes

  • none.


[edit] Supported Tags

The KIND Product config.txt file supports the following tags. Each tag is shown here with its default value. 

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

[edit] kind

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

[edit] 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.

[edit] 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.

[edit] instance-type

Type: String
Compulsory: Yes from 3.4
Desc: This tag describes how products of this type are created (instanced) within a product queue and may be one of the following values:
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.


[edit] mass

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.

[edit] product-category

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

[edit] product-texture

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.)

[edit] Downloads

Attach sample files here

This section is a stub. You can help TrainzOnline's other users by adding to the content in this section or page. If you unfamiliar with Wiki editing, see the How-to-edit pages.


[edit] Categories

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=KIND_Product&oldid=7357"
Personal tools