Template:Furnace/doc: Difference between revisions
CraftSpider (talk | contribs) m (CraftSpider moved page Template:Grid/Furnace/doc to Template:Furnace/doc: Grid is obsolete) |
CraftSpider (talk | contribs) (Updated documentation) |
||
Line 1: | Line 1: | ||
{{doc/start}} | {{doc/start}} | ||
{{lua|UI}} | |||
{{lua| | This template is used to create an interface that looks similar to the [[Furnace|Furnace's]]. | ||
This template is used to create | |||
See [[Template: | See [[Template:Inventory slot]] for basic slot usage, this documentation page will cover additional or different functions. | ||
== Usage == | == Usage == | ||
=== Definition === | === Definition === | ||
<pre style="max-width: 246px">{{ | <pre style="max-width: 246px">{{Furnace | ||
|Mod = Default mod name | |Mod = Default mod name | ||
|Input = Mod:InputName,Amount | |Input = Mod:InputName,Amount | ||
Line 18: | Line 17: | ||
=== Standard usage === | === Standard usage === | ||
<pre style="max-width: 128px">{{ | <pre style="max-width: 128px">{{Furnace | ||
|Input= Sand,17 | |Input= Sand,17 | ||
|Output= Glass,2 | |Output= Glass,2 | ||
Line 25: | Line 24: | ||
;produces: | ;produces: | ||
{{ | {{Furnace | ||
|Input= Sand,17 | |Input= Sand,17 | ||
|Output= Glass,2 | |Output= Glass,2 | ||
|Fuel= Coal,3 | |Fuel= Coal,3 | ||
}} | }} | ||
=== Animated === | === Animated === | ||
To make the | To make the slots animate, you make a list of blocks and objects you want to show, separated by semicolons. | ||
<pre style="max-width: 232px">{{ | <pre style="max-width: 232px">{{Furnace | ||
|Input= Sand,17; Oak Wood,10 | |Input= Sand,17; Oak Wood,10 | ||
|Output= Glass,2; Charcoal,10 | |Output= Glass,2; Charcoal,10 | ||
Line 42: | Line 39: | ||
;produces: | ;produces: | ||
{{ | {{Furnace | ||
|Input= Sand,17; Oak Wood,10 | |Input= Sand,17; Oak Wood,10 | ||
|Output= Glass,2; Charcoal,10 | |Output= Glass,2; Charcoal,10 | ||
Line 49: | Line 46: | ||
=== Mods === | === Mods === | ||
Mod images and normal images can be combined just like in a single | Mod images and normal images can be combined just like in a single slot. | ||
When uploading mod images, they must have the mod page name in parenthesis at the end. For example Fancystone (FancyPack). | When uploading mod images, they must have the mod page name in parenthesis at the end. For example Fancystone (FancyPack). | ||
The Mod parameter can be used to set a default used for all parameters, this is best used when all items in the furnace are modded items, or if the mod name is long and using the vanilla (v) parameter for the vanilla items in the furnace would be quicker. | The Mod parameter can be used to set a default used for all parameters, this is best used when all items in the furnace are modded items, or if the mod name is long and using the vanilla (v) parameter for the vanilla items in the furnace would be quicker. | ||
<pre style="max-width: 200px">{{ | <pre style="max-width: 200px">{{Furnace | ||
|Input= Gravel,64 | |Input= Gravel,64 | ||
|Output= FancyPack:Road,2 | |Output= FancyPack:Road,2 | ||
Line 60: | Line 57: | ||
}}</pre> | }}</pre> | ||
;or | ;or | ||
<pre style="max-width: 160px">{{ | <pre style="max-width: 160px">{{Furnace | ||
|Mod= FancyPack | |Mod= FancyPack | ||
|Input= v:Gravel,64 | |Input= v:Gravel,64 | ||
Line 77: | Line 74: | ||
The layout images can also be modified, for example: | The layout images can also be modified, for example: | ||
<pre style="max-width: 282px">{{ | <pre style="max-width: 282px">{{Furnace | ||
|Mod= | |Mod= The Aether | ||
|Input= | |Input= Holystone | ||
|Output= | |Output= Healing Stone | ||
|Fuel= | |Fuel= Ambrosium Shard | ||
|FuelUsage= | |FuelUsage= Transmute | ||
|Progress= | |Progress= Transmute | ||
}}</pre> | }}</pre> | ||
;Produces | |||
{{ | {{Furnace | ||
|Mod= | |Mod= The Aether | ||
|Input= | |Input= Holystone | ||
|Output= | |Output= Healing Stone | ||
|Fuel= | |Fuel= Ambrosium Shard | ||
|FuelUsage= | |FuelUsage= Transmute | ||
|Progress= | |Progress= Transmute | ||
}} | }} | ||
Images should be put in [[:Category:Grid mods layout]]. | Images should be put in [[:Category:Grid mods layout]]. | ||
== See also == | == See also == | ||
{{ | {{UI see also}} | ||
{{doc/end}} | {{doc/end}} |
Latest revision as of 20:42, 19 May 2017
This template uses Module:UI, a script written in the Lua programming language. Please see wp:Lua and mw:Extension:Scribunto to learn more about Lua. |
This template is used to create an interface that looks similar to the Furnace's.
See Template:Inventory slot for basic slot usage, this documentation page will cover additional or different functions.
Usage
Definition
{{Furnace |Mod = Default mod name |Input = Mod:InputName,Amount |Output = Mod:OutputName,Amount |Fuel = Mod:FuelName,Amount }}
Standard usage
{{Furnace |Input= Sand,17 |Output= Glass,2 |Fuel= Coal,3 }}
- produces
Animated
To make the slots animate, you make a list of blocks and objects you want to show, separated by semicolons.
{{Furnace |Input= Sand,17; Oak Wood,10 |Output= Glass,2; Charcoal,10 |Fuel= Coal,3 }}
- produces
Mods
Mod images and normal images can be combined just like in a single slot.
When uploading mod images, they must have the mod page name in parenthesis at the end. For example Fancystone (FancyPack).
The Mod parameter can be used to set a default used for all parameters, this is best used when all items in the furnace are modded items, or if the mod name is long and using the vanilla (v) parameter for the vanilla items in the furnace would be quicker.
{{Furnace |Input= Gravel,64 |Output= FancyPack:Road,2 |Fuel= Coal,5 }}
- or
{{Furnace |Mod= FancyPack |Input= v:Gravel,64 |Output= Road,2 |Fuel= v:Coal,5 }}
- produces
Note the links of the Road, Gravel and Coal.
The layout images can also be modified, for example:
{{Furnace |Mod= The Aether |Input= Holystone |Output= Healing Stone |Fuel= Ambrosium Shard |FuelUsage= Transmute |Progress= Transmute }}
- Produces
Images should be put in Category:Grid mods layout.
See also
- {{Crafting Table}}
- {{Inventory Table}}
- {{Furnace}}
- {{Brewing Stand}}
- {{Hotbar}}
- {{Inventory slot}}
- Module:UI
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.