Cobblemon Wiki

Template:RandomItemSequence/doc: Difference between revisions

Template Discussion
< Template:RandomItemSequence
No edit summary
No edit summary
Line 1: Line 1:
Generic wrapper template to render randomized sequences of items.
Generic template to render randomized sequences of items.


== Usage ==
== Usage ==


This template is intended to be extended by other templates that define specific item groups in an indiscriminately randomized sequence. In addition, when using this as a wrapper it avoids repeatedly passing long lists of semicolon-separated items in multiple page invocations to reduce clutter.
This template allows editors to render an indiscriminately randomized sequence of items. Each invocation of the template produces its own independent order.


Example:
Example:
<pre>
<pre>
{{RandomItemSequence
{{RandomItemSequence
| items = Milk Bucket; Moomoo Milk; Water Bucket
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Apricorn Sprouts
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| tooltip = Example items
| link = OptionalLink
| link = [[Apricorn Sprout]]
}}
}}
</pre>
</pre>
Produces:
Produces:
{{RandomItemSequence
{{RandomItemSequence
| items = Milk Bucket; Moomoo Milk; Water Bucket
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Apricorn Sprouts
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| tooltip = Example items
| link = OptionalLink
| link = [[Apricorn Sprout]]
}}
}}
== Parameters ==
== Parameters ==
* '''items''' (required) – Semicolon-separated list of item names.
* '''items''' (required) – Semicolon-separated list of item names. <ref>See [[Template:ItemSlot]]</ref>
* '''tooltip''' (optional) – Text displayed when hovering over the item sequence. Defaults to the first item if omitted.
* '''tooltip''' (optional) – Text displayed when hovering over the item sequence. Defaults to the first item if omitted. <ref>See [[Template:ItemSlot]]</ref>
* '''link''' (optional) – Page to link to when the item sequence is clicked.
* '''link''' (optional) – Page to link to when the item sequence is clicked. <ref>See [[Template:ItemSlot]]</ref>
* '''reseed''' (optional) – Set to "false" for deterministic output (the sequence stays the same across multiple invocations on the same page). Default is true, so every invocation has a new random order.
* '''reseed''' (optional) – Numeric value used to explicitly seed the random number generator. If provided, the same seed will produce the same item sequence every time.


== Notes ==
== Notes ==
* Use this wrapper to create specific templates for different item groups (e.g., flavor seasonings, effect seasonings, bait seasonings) so editors don’t have to input long lists each time while also avoiding repetitive sequences of materials for better aesthetics.
* Multiple invocations on the same page will produce independent random orders unless a numeric `reseed` is provided. 
* The template relies on [[Module:RandomItemSequence]] for shuffling and rendering.
* This template can be used directly for deterministic sequences or as a building block in wrapper templates for predefined item groups.
* Multiple invocations on the same page will have independent random orders unless "reseed=false" is used.

Revision as of 20:38, 28 December 2025

Generic template to render randomized sequences of items.

Usage

This template allows editors to render an indiscriminately randomized sequence of items. Each invocation of the template produces its own independent order.

Example: 

{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Apricorn Sprouts
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| link = [[Apricorn Sprout]]
}}
{{RandomItemSequence
| items = Red Apricorn Sprout; Blue Apricorn Sprout; Pink Apricorn Sprout; Yellow Apricorn Sprout; Green Apricorn Sprout; Black Apricorn Sprout; White Apricorn Sprout
| tooltip = Example items
| link = [[Apricorn Sprout]]
}}

Produces:


Pink Apricorn Sprout.pngRed Apricorn Sprout.pngBlack Apricorn Sprout.pngYellow Apricorn Sprout.pngWhite Apricorn Sprout.pngGreen Apricorn Sprout.pngBlue Apricorn Sprout.png
Apricorn Sprouts




Green Apricorn Sprout.pngBlack Apricorn Sprout.pngRed Apricorn Sprout.pngBlue Apricorn Sprout.pngWhite Apricorn Sprout.pngPink Apricorn Sprout.pngYellow Apricorn Sprout.png
Example items




Blue Apricorn Sprout.pngGreen Apricorn Sprout.pngYellow Apricorn Sprout.pngBlack Apricorn Sprout.pngPink Apricorn Sprout.pngRed Apricorn Sprout.pngWhite Apricorn Sprout.png
Example items



Parameters

  • items (required) – Semicolon-separated list of item names. [1]
  • tooltip (optional) – Text displayed when hovering over the item sequence. Defaults to the first item if omitted. [2]
  • link (optional) – Page to link to when the item sequence is clicked. [3]
  • reseed (optional) – Numeric value used to explicitly seed the random number generator. If provided, the same seed will produce the same item sequence every time.

Notes

  • Multiple invocations on the same page will produce independent random orders unless a numeric `reseed` is provided.
  • This template can be used directly for deterministic sequences or as a building block in wrapper templates for predefined item groups.
  1. ↑ See Template:ItemSlot
  2. ↑ See Template:ItemSlot
  3. ↑ See Template:ItemSlot
Retrieved from "https://wiki.cobblemon.com/index.php?title=Template:RandomItemSequence/doc&oldid=8113"