View source for Module:LootChest/doc

{{documentation header}}

'''This module has been modified in order to provide better support for Parallel items.'''

<div style="clear: right; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none;">__TOC__</div>

{{see also|Chest loot}}

== Maintenance ==
{{see also|Module:LootChest/items|Module:LootChest/chests}}

<!-- attest to versions and sign here -->

{| class="wikitable"
|-
| {{DataChecked|java|1.20.1}}
| 20:49, June 9 2022 (UTC)
|-
| {{DataChecked|snapshot|1.20.2 Pre-release 1}}
| 18:43, 20 April 2022 (UTC)
|-
| {{DataChecked|bedrock|1.19.0}}
| 20:49, June 9 2022 (UTC)
|-
| {{DataChecked|beta|beta 1.19.80.22}}
| 18:43, January 23 2023 (UTC)
|}

== .base usage ([[:Template:LootChest]]) ==
Generates a table of the contents of the designated chests, with columns corresponding to various statistics about the availability of those items.

=== Invoking ===

It takes any number of chest parameters, and any number of column parameters, in no particular order.

If no chest parameters are listed, it displays them all; likewise for column parameters.

<pre>
{{#invoke:LootChest|base
 [ |<chestParam1> ... |<chestParamN> ]
 [ |<columnHideParam1> ... |<columnHideParamN> ]
}}</pre>

=== Chest parameters ===
{{#invoke:LootChest|doc}}

=== Column parameters ===
{{#invoke:LootChest|doc2}}

=== Example ===
<code><nowiki>{{#invoke:LootChest|base}}</nowiki></code> &rarr; all chests and all columns

<code><nowiki>{{#invoke:LootChest|base|weaponsmith|jungle|bonus|chance|stacksize}}</nowiki></code> &rarr; only weaponsmith and jungle chests, and only 'stacksize' and 'chance' columns

== .base2 usage ([[Template:LootChestItem]] inline) ==
Prints a summary of this item's availability in the various worldgen chests.

=== Invoking ===

It takes exactly one item name as a parameter.

<pre>{{#invoke:LootChest|base2|<itemParam>}}</pre>

=== Item parameters ===
{{#invoke:LootChest|doc3}}

=== Example ===
<code><nowiki>{{#invoke:LootChest|base2|iron-ingot}}</nowiki></code> &rarr;

{{#invoke:LootChest|base2|iron-ingot|nocat=1}}

<code><nowiki>{{#invoke:LootChest|base2|emerald}}</nowiki></code> &rarr;

{{#invoke:LootChest|base2|emerald|nocat=1}}

== .base3 usage ([[Template:LootChestItem]] table) ==
Prints a summary of this item's availability in the various worldgen chests in the form of a table.

=== Invoking ===

It takes exactly one item name as a parameter.

<pre>{{#invoke:LootChest|base3|<itemParam>}}</pre>

=== Item parameters ===
''Same as [[#Item parameters|above]]''

=== Example ===
<code><nowiki>{{#invoke:LootChest|base3|emerald}}</nowiki></code> &rarr; {{#invoke:LootChest|base3|emerald|nocat=1}}

== Source ==

* The data is set up within <code>p</code> so that it can be pulled directly from (or compared directly to) the minecraft loot table files.
* stack size given here (and given in code) ''can'' be larger than the stackable size of the item, prominently in the case of enchanted books. However this fact does not affect the calculated values. This is because the game puts the right number of items, but unstacked rather than stacked.

=== Data structure ===
* <code>p.items</code> 
:: <code><nowiki>'</nowiki>''<item-id>''<nowiki>'</nowiki> = {</code>
:::: This key must match a sprite name for the items/blocks defined in [[Template:BlockSprite]] or [[Template:ItemSprite]], unless <code>''id''</code> is included in the item definition.
::: <code><nowiki>'</nowiki>''<sprite-type>''<nowiki>'</nowiki></code>
:::: Either <code>''item''</code> or <code>''block''</code>.
::: <code>[, id=<nowiki>'</nowiki>''<sprite-id>''<nowiki>'</nowiki>]</code>
:::: Use this to specify a sprite defined in [[Template:BlockSprite]] or [[Template:ItemSprite]].  Otherwise it uses the sprite with the name given by <code>''item-id''</code>.
::: <code>[, link=<nowiki>'</nowiki>''<item-link>''<nowiki>'</nowiki>]</code>
:::: A link to a page that is different from the sprite-id name.  Used in Template:LootChest.
::: <code>[, title=<nowiki>'</nowiki>''<item-text>''<nowiki>'</nowiki>]</code>
:::: A name for an item that is different from the sprite-id name.
::: <code>[, cannot_stack=''false'']</code>
:::: Use this to indicate that the item comes in groups rather than in stacks.  Used in Template:LootChestItem.
::: <code>[, plural=''(false|<nowiki>'</nowiki><custom-plural-word><nowiki>'</nowiki>)'']</code>
:::: Use <code>''false''</code> when a word has no plural, like 'Nether Wart'.  Use a custom plural word when you cannot simply append an 's' to the base word to make it plural, like 'Bottles o' Enchanting'.  Used in Template:LootChestItem.
::: <code>[, preserve_case=''false'']</code>
:::: Use <code>''false''</code> when an item name should follow the capitalization exactly specified in <code>''title''</code>, and not follow sentence case, like 'TNT'.
::: <code>[, note=<nowiki>'</nowiki>''<note-name>''<nowiki>'</nowiki>]</code>
:::: Indicates that a note appears next to this item in the table. (notes are defined directly below the item list)
:: <code>}</code> 
* <code>p.notes</code> 
:: <code><nowiki>'</nowiki>''<note-name>''<nowiki>'</nowiki> = <nowiki>'</nowiki>''<note-full-text>''<nowiki>'</nowiki></code>

* <code>p.chests[n].poolsJava[n]</code> 
* <code>p.chests[n].poolsJavaUpcoming[n]</code> 
* <code>p.chests[n].poolsBedrock[n]</code> 
* <code>p.chests[n].poolsBedrockUpcoming[n]</code> 
** rolls
:: <code>{ ''<min-number-of-stacks>'', ''<max-number-of-stacks>'' }</code>
* <code>p.chests[n].poolsJava[n].items</code> 
* <code>p.chests[n].poolsJavaUpcoming[n].items</code> 
* <code>p.chests[n].poolsBedrock[n].items</code> 
* <code>p.chests[n].poolsBedrockUpcoming[n].items</code> 
:: <code><nowiki>'</nowiki>''<item-id>''<nowiki>'</nowiki> = { ''<min-stack-size>'', ''<max-stack-size>'', ''<item-weight>'' }</code>

* <code>p.synonyms</code> 
:: <code><nowiki>'</nowiki>''<chest-name-synonym>''<nowiki>'</nowiki> = <nowiki>'</nowiki>''<original-interally-valid-chest-name>''<nowiki>'</nowiki></code>
:: Allows additional chest names to be used as parameters, in addition to the ones defined in p.chests.

* <code>p.display_names</code> 
:: <code><nowiki>'</nowiki>''<chest-name-given-via-parameter>''<nowiki>'</nowiki> = <nowiki>'</nowiki>''<name-displayed-in-single-chest-table>''<nowiki>'</nowiki></code>
:: If a single chest parameter is used, this defines the name it is called in the summary text above the table.

* <code>p.columns</code> 
:: <code><nowiki>'</nowiki>''<column-name>''<nowiki>'</nowiki> = <nowiki>'</nowiki>''<column-full-description>''<nowiki>'</nowiki></code>
:: The column descriptions, found either in the tooltip on the column header, or in the summary text above the table.

=== Functions ===
The following functions are made available at the top of the file, for ease of inspection.
* <code>calc_average_amount_this_item_per_chest</code>
:: ''average'' number of a certain item (not number of stacks), per-chest (not per-structure).
* <code>calc_chance_any_of_this_item_per_chest</code>
:: chance that ''at least one'' of a certain item is present, per-chest (not per-structure).

== Item tests ==
<pre>
{{#invoke:LootChest|base2_test}}</pre>

{{#invoke:LootChest|base2_test}}

=== Notes ===

{{notelist|FN}}

<includeonly>
<!-- Template categories/interwiki here -->
[[Category:Modules]]

[[es:Módulo:LootChest]]
[[fr:Module:CoffreRécompenses]]
[[ja:モジュール:LootChest]]
[[ko:모듈:LootChest]]
[[pt:Módulo:LootChest]]
[[uk:Модуль:Здобич зі скринь]]
[[zh:Module:LootChest]]
</includeonly>
<noinclude>
<!-- Documentation categories/interwiki here -->
[[es:Módulo:LootChest/doc]]
[[fr:Module:CoffreRécompenses/doc]]
[[ja:モジュール:LootChest/doc]]
[[ko:모듈:LootChest/설명문서]]
[[pt:Módulo:LootChest/doc]]
[[uk:Модуль:Здобич зі скринь/док]]
[[zh:Module:LootChest/doc]]
</noinclude>