Module:Aicon/doc

[refresh]

This is the documentation page. It is transcluded into Module:Aicon. See Template:Documentation for more information.

This module implements {{Aicon}}, supports invocations from other modules.

See template documentation for how to use this module from template.

Functions

Other modules can invoke this module.

Exported function are listed below.

aIcon

This function generates an icon instance in the style of legacy achievements or advancements in Template:JE.

Syntax: aIcon ( InvIcon, Background, State, Link, InvFile )

• InvIcon: The name should handled by Module:Inventory icon (not effective when InvFile is specified).
• Background: The type of achievement or advancement this icon represents. Valid values: plain, oval, fancy, and plain-mini.
• State: The status of achievement or advancement this icon represents. Valid values: raw, worn (valid only when Background is not plain-mini).
• Link: Optional, the link target that the icon points to. No link by default.
• InvFile: Optional, replacing the default icon (provided by Module:Inventory icon) as an image file (omitting File: prefix).

main

This function is designed for template invocation, without extra parameter accepted, so not recomended to invoke it by other modules.

Dependencies

• Module:ProcessArgs
• Module:Inventory icon
• mw:Extension:TemplateStyles: Module:Aicon/styles.css