Ver el código de «Módulo:LootChest/doc»

{{documentation header}}

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

== .base usage ([[:Template:LootChest]]) ==
Genera una tabla de contenido de los cofres designados, con las columnas correspondientes a diversas estadísticas acerca de la disponibilidad de esos objetos.

=== Invocando ===

Toma cualquier número de parámetros de cofre, y cualquier número de parámetros de columna, sin ningún orden en particular.

Si no aparecen los parámetros de cofre, muestra todos ellos; del mismo modo para los parámetros de columna.

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

=== Parámetros de cofre ===
{{#invoke:LootChest|doc}}

=== Parámetros de columna ===
{{#invoke:LootChest|doc2}}

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

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

== .base2 usage ([[:Template:LootChestItem]]) ==
Imprime un resumen de la disponibilidad de este objeto en los diversos cofres generados en el mundo.

=== Invocando ===

Toma exactamente un nombre de objeto como parámetro.

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

=== Parámetros de objeto ===
{{#invoke:LootChest|doc3}}

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

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

== Maintenimiento ==

<!-- the variable 'ver' indicates how current the data is. -->
{{#vardefine:checked|1.8.8}}{{

#vardefine:current|{{#ifeq:{{v|nolink=1}}|{{#var:checked}}|1|0}} }}<span style="background-color:#ffffc2; color:{{
#ifeq:{{#var:current}}|1|green|firebrick}};">The tables are current as of [[{{#var:checked}}]]{{
#ifeq:{{#var:current}}|1||&nbsp;(should be checked/updated to {{v}})}}.</span>

<!-- indicate here the source used, and sign with ~~~~.  -->
* The source for 1.8.8 was the decompiled .jar. [[User:Anomie x|Anomie x]] ([[User talk:Anomie x|talk]]) 07:54, 29 October 2015 (UTC)

{{#vardefine:checked|15w44a}}{{

#vardefine:current|{{#ifeq:{{v|nolink=1|weekly=1}}|{{#var:checked}}|1|0}} }}<span style="background-color:#ffffc2; color:{{
#ifeq:{{#var:current}}|1|green|firebrick}};">The tables are current as of snapshot [[{{#var:checked}}]]{{
#ifeq:{{#var:current}}|1||&nbsp;(should be checked/updated to {{v|weekly=1}})}}.</span>

<!-- indicate here the source used, and sign with ~~~~.  -->
* The source for 14w44a was the loot table from the .jar. [[User:Anomie x|Anomie x]] ([[User talk:Anomie x|talk]]) 07:54, 29 October 2015 (UTC)

=== 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> = { <nowiki>'</nowiki>''<sprite-type>''<nowiki>'</nowiki> [, id=<nowiki>'</nowiki>''<sprite-id>''<nowiki>'</nowiki>] [, link=<nowiki>'</nowiki>''<item-link>''<nowiki>'</nowiki>] [, title=<nowiki>'</nowiki>''<item-text>''<nowiki>'</nowiki>] [, cannot_stack=''false''] [, plural=''(false|<nowiki>'</nowiki><custom-plural-word><nowiki>'</nowiki>)''] [, note=<nowiki>'</nowiki>''<note-name>''<nowiki>'</nowiki>] }</code> 
* <code>p.notes</code> 
:: <code><nowiki>'</nowiki>''<note-name>''<nowiki>'</nowiki> = <nowiki>'</nowiki>''<note-full-text>''<nowiki>'</nowiki></code>

* <code>p.chests[n].pools[n]</code> 
** rolls
:: <code>{ ''<min-number-of-stacks>'', ''<max-number-of-stacks>'' }</code>
* <code>p.chests[n].pools[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.

==== Keys ====
* <code>''id''</code>: A different ID, from [[Template:ItemSprite]] or [[Template:BlockSprite]].
* <code>''link''</code>: A link to a page that is different from the sprite-id name.
* <code>''title''</code>: A name for an item that is different from the sprite-id name.
* <code>''note''</code>: Indicates that a note will appear next to this item in the table.
* <code>''cannot_stack''</code>: used in LootChestItem.  Use this to indicate that the item comes in groups rather than in stacks.
* <code>''plural''</code>: used in LootChestItem.  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.

==== Valores ====
* <code>''<item-id>''</code>: these must match a sprite name for the items/block as defined in [[:Module:BlockSprite/IDs]] or [[:Module:ItemSprite/IDs]], unless <code>''id''</code> is included in the item definition.
* <code>''<sprite-id>''</code>: these must match a sprite name for the items/block as defined in [[:Module:BlockSprite/IDs]] or [[:Module:ItemSprite/IDs]].
* <code>''<sprite-type>''</code>: either <code>''item''</code> or <code>''block''</code>

=== Funciones ===
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 will be found, per-chest (not per-structure).

== Casos testeados ==

=== Test de objetos ===

{{#invoke:LootChest|base2_test}}

=== Test de cofres ===

==== <nowiki>{{LootChest}}</nowiki> ====
{{LootChest|dev=1}}

==== <nowiki>{{LootChest|chance}}</nowiki> ====
{{LootChest|chance|dev=1}}

==== <nowiki>{{LootChest|stronghold-altar|stronghold-library|stronghold-storeroom}}</nowiki> ====
{{LootChest|stronghold-altar|stronghold-library|stronghold-storeroom|dev=1}}

==== <nowiki>{{LootChest|altar|library|storeroom|stacksize|chance}}</nowiki> ====
{{LootChest|altar|library|storeroom|stacksize|chance|dev=1}}

==== <nowiki>{{LootChest|bonus}}</nowiki> ====
{{LootChest|bonus|dev=1}}

==== <nowiki>{{LootChest|desert}}</nowiki> ====
{{LootChest|desert}}

==== <nowiki>{{LootChest|jungle}}</nowiki> ====
{{LootChest|jungle|dev=1}}

==== <nowiki>{{LootChest|dungeon}}</nowiki> ====
{{LootChest|dungeon|dev=1}}

==== <nowiki>{{LootChest|igloo}}</nowiki> ====
{{LootChest|igloo|dev=1}}

==== <nowiki>{{LootChest|mineshaft}}</nowiki> ====
{{LootChest|mineshaft|dev=1}}

==== <nowiki>{{LootChest|nether-fortress}}</nowiki> ====
{{LootChest|nether-fortress|dev=1}}

==== <nowiki>{{LootChest|fortress}}</nowiki> ====
{{LootChest|fortress|dev=1}}

==== <nowiki>{{LootChest|village}}</nowiki> ====
{{LootChest|village|dev=1}}

==== <nowiki>{{LootChest|village|chance}}</nowiki> ====
{{LootChest|village|chance|dev=1}}

=== Notas ===

<references group="note"/>

<includeonly>
<!-- Template categories/interwiki here -->
</includeonly>
<noinclude>
<!-- Documentation categories/interwiki here -->
</noinclude>