Template:UI Pager/doc

UI Pager is a template used to generate a UI Pager, where items are added sequentially into pages of UI and navigation are added if there exists multiple pages. It uses the fill=border by default and sequentially allocates items inside the border.

Shop UI is a similar template but defaults to replaces the close button with a selling hopper on the bottom row.

Skill UI is a template where items are added sequentially into pages of UI in a snake formation, useful for skill experience UIs. It uses fill=true by default.

Rewards UI is similar to Skill UI, with a different formation to suit Rewards UIs.

Syntax
UI Pager, Shop UI, Skill UI, and Rewards UI uses these common parameters. title
 * All parameters and syntax available to UI can also be used here.
 * Any UI slots specified (for example: 1, 5=Diamond) will be written/overridden to every page generated by this template. Using rowN/colN syntax or writing to non-border slots will result in undefined behaviour, so it is not recommended.
 * - The UI title. This can be any form of text. In the title, if used, $($0$)$ will be replaced with the max. pages, and {1} will be replaced by the total pages.
 * - All the UI item slots, each using a syntax same as UI.
 * The items will be allocated to the slots within the border from top-left to bottom-right. When a UI is full, it automatically writes into a new UI.
 * Extra back/forth arrows will be added to each page if there are multiple.
 * - A shorthand to add ({0}/{1}) before title. Default false.
 * - If true and if is true, put the index at the end of the UI title. Default false.
 * - A shorthand to enclose the whole thing inside a . Default false.
 * The default arrow on all pages will return to return_id if specified.
 * If id is specified, each page is named:, -2, -3, ...
 * If hide is specified, it will only be applied to the first page. Default false.
 * All pages except the first will be hidden. This cannot be changed.

Shop UI has these additional parameters:
 * - This puts a shop confirmation slot next to the closing button:

Output Patterns
For Skill UI and Rewards UI, starting from index 2, it allocates items to slots following a pattern. The output patterns are shown below.

Skill UI has a cyclic page flipping system. Rewards UI will follow the right-click flipping (scroll fast).

UI Pager Example
This is a simplified version of Curator's UI, generating 30 items in the pager:


 * Produces

Shop UI Example
This is an example taken from Bea's UI: