Module:Exclusive/doc

From Terraria Wiki
Jump to navigation Jump to search

Lua.svgThis is the documentation page for Module:Exclusive.


This module is the core of the dynamic platform exclusivity system.

The basic function to invoke from templates is getInfo, which queries the exclusivity information database and stores the result to a set of dplvars. These are named in the format ex_<platform>, e.g. ex_d for Desktop, and they are either empty or set to y. The function does not produce any output.

The two other functions, eicons and simpleEicons, return the HTML code for the icons denoting platform exclusivity. The first function is intended to be used only by the {{eicons}} template, the second function can be used from any other module that includes platform exclusivity icons (such as Module:Item).

Important note: This module relies entirely on the database Module:Exclusive/data. The database is not updated automatically and instead requires periodic manual updates. Please see its documentation for instructions.