Anonymous
×
Create a new article
Write your page title here:
We currently have 632 articles on SpellForce Wiki - Rohens encyclopedia. Type your article name above or click on one of the titles below and start writing!



SpellForce Wiki - Rohens encyclopedia

Template:CoE Item: Difference between revisions

Basara (talk | contribs)
No edit summary
Basara (talk | contribs)
still work in progress
Line 2: Line 2:
<noinclude>
<noinclude>
==CoE Item==
==CoE Item==
Inserts a block item for CoE. Typical items are abilities, statuses, room expansions, items, recipes, etc.
Inserts a block item for CoE. Typical items are abilities, statuses, room expansions, artifacts, recipes, ingredients, etc.


''NOTE: Most parameters are optional, only use what is needed.''
===Example Preview===


===Usage===
<div class="item-block">
<nowiki>
<div>
{{CoE Item
  <div class="item-icon">[[Image:SF CoE Icon Battle Robe.png|50px]]</div>
</nowiki><br><nowiki>
  <div class="item-title">Battle Robe</div>
|title = [Name/Title]
</div>
</nowiki><br><nowiki>
  <div class="item-subtitle">Artifact, Ingredient, Light Armor</div>
|sub-title = [Subtitle] </nowiki>''OPTIONAL''<nowiki>
<div>
</nowiki><br><br>''OPTIONAL DESCRIPTION LINES''<br><br><nowiki>
  <div class="item-threshold>[[Image:SF CoE Elemental 2.png|50px]] [[Image:SF CoE Life 1.png|25px]]</div>
  <div class="item-cost>[[Image:SF CoE Item Gold Cost.png|30px]] 10</div>
</div>
  <div class="item-block-splitter">[[Image:SF CoE Item Block Splitter.png|320px]]</div>
  <div class="item-text">+2 Speed</div>
  <div class="item-text">Grants <div class="tooltip-short">Quick Reflexes<span style="margin: 5px; display: block;height: auto; max-width: 250px;" border="0">[[Image:SF CoE Ability Quick Reflexes.png]]</span></div></div>
</div>
 
===Using This Template & Parameters===
 
Parameters define the data that gets be passed to the template. That's how the template "knows" what to display for you. They can loosely be called variables.


|line-1-start    = [Description]
''The ONLY required parameter is title.'' But if that is the only parameter you list, it will be an empty box (besides the item title).
</nowiki><br><nowiki>
|line-1-tooltip      = [tooltip text] </nowiki>''OPTIONAL''<nowiki>
</nowiki><br><nowiki>
|line-1-tooltip-type  = [tooltip-short] or [tooltip] or [tooltip-long] </nowiki>''defaults to tooltip if no class is included''<nowiki>
</nowiki><br><nowiki>
|line-1-end    = [text that goes after the tooltip] </nowiki>''OPTIONAL''<nowiki>
</nowiki><br><nowiki>
|line-1-image    = [tooltip image file name]
</nowiki><br><br><nowiki>


|line-2-start    = [Description]
''THIS TEMPLATE'S'' parameters do not need to be used in order, but you do need to specify the parameter name, the = sign, and then the data/text you want to use, separated by the | sign. See the [[#See Example Usage|Example Usage]] section below.
</nowiki><br><nowiki>
|line-2-tooltip      = [tooltip text] </nowiki>''OPTIONAL''<nowiki>
</nowiki><br><nowiki>
|line-2-tooltip-type  = [tooltip-short] or [tooltip] or [tooltip-long] </nowiki>''defaults to tooltip if no class is included''<nowiki>
</nowiki><br><nowiki>
|line-2-end    = [text that goes after the tooltip] </nowiki>''OPTIONAL''<nowiki>
</nowiki><br><nowiki>
|line-2-image    = [tooltip image file name]
</nowiki><br><br><nowiki>


|line-3-start = [Description]
;Table Column Explanations
</nowiki><br><nowiki>
:'''Parameter''' is the name for what you are describing.
|line-3-tooltip = [tooltip text] </nowiki>''OPTIONAL''<nowiki>
:'''Value''' is the text/info you want to show.
</nowiki><br><nowiki>
:'''Example''' is what is shown in the Example Usage and Example Preview sections.
|line-3-tooltip-type  = [tooltip-short] or [tooltip] or [tooltip-long] </nowiki>''defaults to tooltip if no class is included''<nowiki>
</nowiki><br><nowiki>
|line-3-end = [text that goes after the tooltip] </nowiki>''OPTIONAL''<nowiki>
</nowiki><br><nowiki>
|line-3-image = [tooltip image file name]
</nowiki><br><nowiki>


}}
{| class="wikitable"
</nowiki>
|+ Template Parameters
! Parameter
! Value
! Example
|-
|title
|The name of the item you are making.
|''Battle Robe''
|-
|sub-title
|Sub-classes or categories the item falls into.
|''Artifact, Ingredient, Light Armor''
|-
|icon
|File name for the icon.
|''SF CoE Ability Quick Reflexes.png''
|-
|value-gold
|The gold value of the item.
|''10''
|-
|value-mana
|The mana value of the item.
|
|-
|value-elemental
|The elemental ([[Image:SF CoE Elemental 1.png|20px]]) value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
|''2''
|-
|value-life
|The life ([[Image:SF CoE Life 1.png|20px]]) value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
|''1''
|-
|value-death
|The death ([[Image:SF CoE Death 1.png|20px]]) value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
|
|-
|value-life
|The arcane ([[Image:SF CoE Arcane 1.png|20px]]) value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
|
|-
|line-1
|rowspan="3"|The [first / second / third] line of the description (before any tooltip text).
|''+2 Speed''
|-
|line-2
|''Grants''
|-
|line-3
|
|-
|tooltip-1-type
|rowspan="3"|If there is no tooltip, do not use this parameter.<br>Use "tooltip", "tooltip-short", or "tooltip-long" to determine how far above the text the tooltip image should begin.
|
|-
|tooltip-2-type
|''tooltip-short''
|-
|tooltip-3-type
|
|-
|tooltip-1
|rowspan="3"|If there is no tooltip, do not use this parameter.<br>The text that makes the tooltip display with mouse hover.
|
|-
|tooltip-2
|''Quick Reflexes''
|-
|tooltip-3
|
|-
|tooltip-1-img
|rowspan="3"|If there is no tooltip, do not use this parameter.<br>File name for the tooltip image.
|
|-
|tooltip-2-img
|''SF CoE Ability Quick Reflexes.png''
|-
|tooltip-3-img
|
|-
|line-1-end
|rowspan="3"|If there is no tooltip, do not use this parameter.<br>Text that appears after a tooltip (if any).
|
|-
|line-2-end
|
|-
|line-3-end
|
|}


===Example Usage===
===Example Usage===
Line 74: Line 150:
</nowiki>
</nowiki>


===Example Preview===


<div class="item-block">
<div>
  <div class="item-icon">[[Image:SF CoE Icon Battle Robe.png|50px]]</div>
  <div class="item-title">Battle Robe</div>
</div>
  <div class="item-subtitle">Artifact, Ingredient, Light Armor</div>
<div>
  <div class="item-threshold>[[Image:SF CoE Elemental 2.png|50px]] [[Image:SF CoE Life 1.png|25px]]</div>
  <div class="item-cost>[[Image:SF CoE Item Gold Cost.png|25px]] 10</div>
</div>
  <div class="item-block-splitter">[[Image:SF CoE Item Block Splitter.png|320px]]</div>
  <div class="item-text">+2 Speed</div>
  <div class="item-text">Grants <div class="tooltip-short">Quick Reflexes<span style="margin: 5px; display: block;height: auto; max-width: 250px;" border="0">[[Image:SF CoE Ability Quick Reflexes.png]]</span></div></div>
</div>


==Template Markup==
==Template Markup==

Revision as of 18:28, 25 September 2023


CoE Item

Inserts a block item for CoE. Typical items are abilities, statuses, room expansions, artifacts, recipes, ingredients, etc.

Example Preview

Battle Robe
Artifact, Ingredient, Light Armor
10
+2 Speed
Grants
Quick Reflexes

Using This Template & Parameters

Parameters define the data that gets be passed to the template. That's how the template "knows" what to display for you. They can loosely be called variables.

The ONLY required parameter is title. But if that is the only parameter you list, it will be an empty box (besides the item title).

THIS TEMPLATE'S parameters do not need to be used in order, but you do need to specify the parameter name, the = sign, and then the data/text you want to use, separated by the | sign. See the Example Usage section below.

Table Column Explanations
Parameter is the name for what you are describing.
Value is the text/info you want to show.
Example is what is shown in the Example Usage and Example Preview sections.
Template Parameters
Parameter Value Example
title The name of the item you are making. Battle Robe
sub-title Sub-classes or categories the item falls into. Artifact, Ingredient, Light Armor
icon File name for the icon. SF CoE Ability Quick Reflexes.png
value-gold The gold value of the item. 10
value-mana The mana value of the item.
value-elemental The elemental () value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.). 2
value-life The life () value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.). 1
value-death The death () value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
value-life The arcane () value (ingredients, artifacts, etc.) or threshold (recipes, room extensions, etc.).
line-1 The [first / second / third] line of the description (before any tooltip text). +2 Speed
line-2 Grants
line-3
tooltip-1-type If there is no tooltip, do not use this parameter.
Use "tooltip", "tooltip-short", or "tooltip-long" to determine how far above the text the tooltip image should begin.
tooltip-2-type tooltip-short
tooltip-3-type
tooltip-1 If there is no tooltip, do not use this parameter.
The text that makes the tooltip display with mouse hover.
tooltip-2 Quick Reflexes
tooltip-3
tooltip-1-img If there is no tooltip, do not use this parameter.
File name for the tooltip image.
tooltip-2-img SF CoE Ability Quick Reflexes.png
tooltip-3-img
line-1-end If there is no tooltip, do not use this parameter.
Text that appears after a tooltip (if any).
line-2-end
line-3-end

Example Usage

{{CoE Item
|title = Battle Robe
|sub-title = Artifact, Ingredient, Light Armor
|line-1-start = +2 Speed
|line-2-start = Grants
|line-2-tooltip = Quick Reflexes
|line-2-tooltip-type = tooltip-short
|line-2-image = Image:SF CoE Ability Quick Reflexes.png
}}


Template Markup

tooltip