"Queues" container

Revision as of 16:52, 3 February 2009 (view source) Windwalkr (Talk | contribs) m

Revision as of 23:58, 3 February 2010 (view source) Windwalkr (Talk | contribs) m (1 revision) Newer edit →

---

Revision as of 23:58, 3 February 2010

The "queues" Container is a top-level config.txt file entry used by various Content Types.

The "queues" Container is a list of queue subcontainers (Queues) with no standalone tags. Queues are used by certain asset types (such as KIND Industry and KIND Traincar) to 'hold' KIND Product instances. Queues can make use of animated meshes or custom attachments to visually represent the amount of product they hold in game. Each queue subcontainer uses the following format.

Instances of queue subcontainers are represented in TrainzScript via Class ProductQueue.

Contents 1 Supported Tags 1.1 size 1.2 product-kuid 1.3 initial-count 1.4 passenger-queue 1.5 per-hour 1.6 animated-mesh 1.7 custom-attachments 1.8 attachment-points 1.9 allowed-products 1.10 allowed-categories 1.11 conflicts-with-queues 2 Categories

Supported Tags

Each queue subcontainer supports the following tags. Each tag is shown here with its default value.

 size                  0
 product-kuid          <KUID:0:0>
 initial-count         0
 passenger-queue       0
 per-hour              120
 animated-mesh         ""
 custom-attachments    ""
 attachment-points
 {
 }
 allowed-products
 {
 }
 allowed-categories
 {
 }
 conflicts-with-queues
 {
 }

size

Type: Positive Integer

Desc: The maximum size of the queue, in other words this is the maximum amount of product the queue can 'hold'.

product-kuid

Type: KUID

Desc: Used in conjuntion with the 'initial-count' tag, product-kuid specifies the initial KIND Product type in the queue.

initial-count

Type: Positive Integer

Desc: Used in conjuntion with the 'product-kuid' tag, initial-count specifies the initial amount of product in the queue.

passenger-queue

Type: Boolean

Desc: Specifies that the queue can hold passengers.

per-hour

Type: Positive Integer

Desc: This flag is used for passenger stations and sets the base number of passengers that will accumulate over the period of one hour.

animated-mesh

Type: String

Desc: Specifies the name of an animated mesh from the mesh table. This mesh is used to visually represent the amount of product in the queue while in game and should animate from empty to full.

custom-attachments

Type: String

Desc: Specifies that this queue has custom attachment points. Custom attachments are used in game to visually represent the amount of product in the queue. An 'attachment-points' container is used to list the custom attachments.

attachment-points

Type: String Container

Desc: The 'attachment-points' container lists all of the mesh attachment points used to visually represent the amount of product in the queue. When the queue is empty the meshes attached on these points will be invisible, as the queue fills they will be progressively shown. The number of attachment points cannot exceed the total queue size.

allowed-products

Type: KUID Container

Desc: Lists the KUIDs of all of the various KIND Product assets that can accumulate in the queue.

allowed-categories

Type: KUID Container

Desc: Lists the KUIDs of all of the KIND Product-category assets that can accumulate in the queue. Allowing a product category means that all products of this category are allowed, they therefore do not need to be specified in the 'allowed-products' container.

conflicts-with-queues

Type: String Container

Desc: Sets a number of queues that this queue conlicts with. If any of the conflicting queues have product in them, then product cannot be added to this queue.

Categories