Trainz/containers/queues container

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

The queues Container is a list of queue subcontainers (Queues) with no standalone tags. Queues are used by certain asset types (such as and ) to establish runtime memory space allocation to 'hold' , and to define the legal values of their contents.
 * In essence, because product can be loaded and unloaded or produced and consumed during operations, each queue establishes variables which change dynamically in the game. These memory set asides can then be accessed and used by supporting TrainzScript code.
 * Queues can make use of animated meshes or custom attachments to visually represent the amount of product they hold in game.
 * Instances of queue subcontainers are represented in via.


 * Each queue subcontainer uses the following format:

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

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

size

 * Data Type: Positive Integer
 * Data element description: The maximum size of the queue, in other words this is the maximum amount of product the queue can 'hold'.

product-kuid

 * Data Type: KUID
 * Data element description: Used in conjunction with the 'initial-count' tag, product-kuid specifies the initial type in the queue.

initial-count

 * Data Type: Positive Integer
 * Data element description: Used in conjunction with the 'product-kuid' tag, initial-count specifies the initial amount of product in the queue.

passenger-queue

 * Data Type: Boolean
 * Data element description: Specifies that the queue can hold passengers.

per-hour

 * Data Type: Positive Integer
 * Data element description: 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

 * Data Type: String
 * Data element description: 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

 * Data Type: String
 * Data element description: 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

 * Data Type: String Container
 * Data element description: 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-categories

 * Data Type: KUID Container
 * Data element description: Lists the KUIDs of all of the 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 '' subcontainer.


 * On the other hand, using an kind, means one must be defined which matches the limits of the industry or rolling stock asset.

allowed-products
Allowed-products can be considered a list of specific products when a class of products, as that specified by above is too broad or otherwise inappropriate.
 * Data Type: KUID subcontainer
 * Data element description: Lists the KUIDs of all of the various assets that can accumulate in the queue.

allowed-products {     0                                  1                                 }
 * example
 * Listed kuids are assets of defined class assets.

conflicts-with-queues

 * Data Type: String Container
 * Data element description: Sets a number of queues that this queue conflicts with. If any of the conflicting queues have any product in them, then a conflictable product cannot be added to this queue.


 * Otherwise, products might be added to more than one queue if they do not exclude each other.

queues-ID
queues-ID is a placeholder for an content creator specified identifier name (so is variable). Names of identifiers (queues-ID) are used by other parts of Trainz software to identify and interact with the data initialized in the queue data structures.
 * In the below examples, the role of 'queues-ID' is obvious given that each is just one single nested level of  within the queue data block (group of elements), immediately after (inside) the forming the boundaries of the queue block of data.
 * In order of appearance in the examples below they are:
 * 1)  prod0 Locomotive with two consumption queues.
 * 2)  locomotive_diesel_fuel_queue
 * 3)  locomotive_sand_queue Some other interesting uses...
 * 4)  load
 * 5)  cattle_q Passenger Station with multiple consumption and source queues...
 * 6)  passengers_on_0
 * 7)  passengers_on_1
 * 8)  passengers_on_2
 * 9)  passengers_off_0
 * 10)  passengers_off_1
 * 11)  passengers_off_2
 * Note in the examples, the processes data structures are the same level of indentation as the queues-ID identifier.

Queues in a Stock Car

 * Stock Car in this case has nothing to do with NASCAR but is the older livestock useage: sheep, pigs, cows, etc.

queues { prod0 {   size                                15 initial-count                      0 product-kuid                        attachment-points {     0                                 "a.load0" 1                                "a.load1" 2                                "a.load2" 3                                "a.load3" 4                                "a.load4" 5                                "a.load5" 6                                "a.load6" 7                                "a.load7" 8                                "a.load8" 9                                "a.load9" 10                               "a.load10" 11                               "a.load11" 12                               "a.load12" 13                               "a.load13" 14                               "a.load14" }   allowed-products {     0                                  1                                 2                                 } } }

Queues in a Locomotive
queues { locomotive_diesel_fuel_queue {   size                                18571 initial-count                      1000 product-kuid                        allowed-products {     0                                  } }  locomotive_sand_queue {   size                                1585 initial-count                      1000 product-kuid                        allowed-products {     0                                  } } }

Queues in a Boxcar
kuid                                    username                               "40ft Southern AAR DD boxcar" kind                                   "traincar" mass                                   23012 engine                                 0 enginespec                              description                            "AAR 1937 design standard 40ft 50ton  automobile boxcar as used by CNO&TP(Southern)." author                                 "Randall (Whitepass) White" organisation                           "TPR"

queues { load {   size                                7 initial-count                      0 product-kuid                        allowed-products {     0                                  2                                 3                                <kuid2:30671:9080810:1> 4                                <kuid2:30671:9080510:1> 5                                <kuid2:30671:98702901:1> 6                                <kuid2:30671:9840820:1> 7                                <kuid2:124017:27009:1> 8                                <kuid2:30671:9870899:1> 9                                <kuid2:30671:9870190:1> } } }

Examples in industries
Industry types involve a companion or sister container: which are presented as well below to best demonstrate the interworkings and associations.
 * These examples may have to be placed in a sub-page because of length:

Consumption only Industry
This meat packing industry outputs nothing, acting as a livestock consumer.

kuid                                   <kuid2:69695:106:3> trainz-build                           2.4 light                                  1 type                                   "industrial"* region                                 "GP&W"* category-region-0                      "US" category-era-0                         "1990s" category-era-1                         "1950s" category-era-2                         "1940s" category-class                         "BC" script                                 "meatworks" class                                  "meatworks"

queues { cattle_q {   size                                256 initial-count                      256 product-kuid                       <kuid2:30671:90102101:1> attachment-points {     0                                 "a.gen_goods0" 1                                "a.gen_goods1" 2                                "a.gen_goods2" ... yes a list of 256 attachment points for cattle 254                              "a.gen_goods254" 255                              "a.gen_goods255" } } }

processes { multi_consumer_producer {   start-enabled                       1 duration                           60 inputs {     0      {        amount                          1 queue                          "cattle_q" }   }    outputs {   }  } }

attached-track { cattledepot {   track                               <kuid:-1:15> vertices {     0                                 "a.track0a" 1                                "a.track0b" 2                                "a.track0c" 3                                "a.track0d" } } }

attached-trigger { cattletrig1 {   att                                 "a.trig0" radius                             6.5 } }

Multiplatform Train Station
kuid                                   <kuid2:316:28003:1> kind                                   "industry" script                                 "Station" class                                  "Station" category-class                         "BR" username                               "Austin Large Station" category-region                        "CA;US" category-era                           "1890s;1900s;1910s;1920s;1930s;1940s;1950s;1960s;1970s" trainz-build                           2.5

queues { passengers_on_0 {   passenger-queue                     "1" size                               30 initial-count                      8 product-kuid                       <kuid:-3:10060> attachment-points {     0                                 "a.passon01" 1                                "a.passon02" 2                                "a.passon03" 3                                "a.passon04 ...      28                                "a.passon29"      29                                "a.passon30"    }  }  passengers_on_1  {    passenger-queue                     "1"    size                                30    initial-count                       8    product-kuid                        <kuid:-3:10060>    attachment-points    {      0                                 "a.passon31"      1                                 "a.passon32"      2                                 "a.passon33 ...     28                                "a.passon59" 29                               "a.passon60" } }  passengers_on_2 {   passenger-queue                     "1" size                               20 initial-count                      8 product-kuid                       <kuid:-3:10060> attachment-points {     0                                 "a.passon61" 1                                "a.passon62" ...     18                                "a.passon79" 19                               "a.passon80" } }  passengers_off_0 {   passenger-queue                     "1" size                               18 initial-count                      0 product-kuid                       <kuid:-3:10060> attachment-points {     0                                 "a.passoff01" 1                                "a.passoff02" ...     16                                "a.passoff17" 17                               "a.passoff18" } }  passengers_off_1 {   passenger-queue                     "1" size                               17 initial-count                      0 product-kuid                       <kuid:-3:10060> attachment-points {     0                                 "a.passoff19" 1                                "a.passoff20" ...     16                                "a.passoff35" } }  passengers_off_2 {   passenger-queue                     "1" size                               18 initial-count                      0 product-kuid                       <kuid:-3:10060> attachment-points {     0                                 "a.passoff36" 1                                "a.passoff37" ...     15                                "a.passoff51" 16                               "a.passoff52" } } }

processes { passenger_spawn_0 {   start-enabled                       1 duration                           20 outputs {     0      {        amount                          1 queue                          "passengers_on_0" }   }  }  passenger_spawn_1 {   start-enabled                       1 duration                           20 outputs {     0      {        amount                          1 queue                          "passengers_on_1" }   }  }  passenger_spawn_2 {   start-enabled                       1 duration                           20 outputs {     0      {        amount                          1 queue                          "passengers_on_2" }   }  }  passenger_delete_0 {   start-enabled                       1 duration                           3 inputs {     0      {        amount                          1 queue                          "passengers_off_0" }   }  }  passenger_delete_1 {   start-enabled                       1 duration                           3 inputs {     0      {        amount                          1 queue                          "passengers_off_1" }   }  }  passenger_delete_2 {   start-enabled                       1 duration                           3 inputs {     0      {        amount                          1 queue                          "passengers_off_2" }   }  } }