No edit summary |
No edit summary |
||
(32 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}}__NOTOC__ |
{{Documentation subpage}}__NOTOC__ |
||
== Description == |
== Description == |
||
− | This module stores all data about the currently existing playable cards in alphabetical order. Whenever card changes occur this |
+ | This module stores all data about the currently existing playable cards in alphabetical order. Whenever card changes occur this module needs to be updated respectively. |
;Syntax |
;Syntax |
||
Line 8: | Line 8: | ||
["card name (variant)"] = { |
["card name (variant)"] = { |
||
affinity = , |
affinity = , |
||
+ | card_id = , |
||
description = , |
description = , |
||
starter_card = , |
starter_card = , |
||
type = , |
type = , |
||
construction_time = , |
construction_time = , |
||
+ | gender = , |
||
+ | movement_speed = , |
||
orbs = , |
orbs = , |
||
power_cost = , |
power_cost = , |
||
Line 24: | Line 27: | ||
edition = , |
edition = , |
||
rarity = , |
rarity = , |
||
+ | booster_locations = , |
||
upgrade_locations = , |
upgrade_locations = , |
||
− | + | general_upgrade_text = , |
|
abilities = { |
abilities = { |
||
{ |
{ |
||
− | name = ability |
+ | name = ability 1, |
type = , |
type = , |
||
− | + | hide_on_card = , |
|
− | + | upgrade_availability = , |
|
affinity_dependency = , |
affinity_dependency = , |
||
cost = , |
cost = , |
||
Line 38: | Line 42: | ||
upgrade_text = , |
upgrade_text = , |
||
}, { |
}, { |
||
− | name = ability |
+ | name = ability n, |
type = , |
type = , |
||
− | + | hide_on_card = , |
|
− | + | upgrade_availability = , |
|
affinity_dependency = , |
affinity_dependency = , |
||
cost = , |
cost = , |
||
Line 52: | Line 56: | ||
</pre> |
</pre> |
||
− | ;Parameter and |
+ | ;Parameter and Syntax Explanation |
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;" |
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;" |
||
! width=20% | Parameter |
! width=20% | Parameter |
||
Line 78: | Line 82: | ||
*<code>"Shadow"</code> |
*<code>"Shadow"</code> |
||
|- |
|- |
||
− | | <code> |
+ | | <code>card_id</code> || The card's unique id for upgrade 0, to be used for scripting purposes. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
+ | *<code>{{pht|Custom integer}}</code> |
||
+ | |- |
||
+ | | <code>description</code> || Descriptive sentence that is shown in the card's tooltip above the abilities. Use <code><nowiki><br></nowiki></code> for a custom line break. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
||
*<code>"{{pht|Custom text}}"</code> |
*<code>"{{pht|Custom text}}"</code> |
||
+ | **If it changes with upgrades use the following syntax: |
||
+ | ***<code><nowiki>{</nowiki>"{{pht|Custom text}}", "{{pht|Custom text}}", "{{pht|Custom text}}", "{{pht|Custom text}}"<nowiki>}</nowiki></code> |
||
|- |
|- |
||
| <code>starter_card</code> || Indicates that the card is owned by all players as a PvE starter card. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
| <code>starter_card</code> || Indicates that the card is owned by all players as a PvE starter card. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
||
Line 95: | Line 104: | ||
**If it changes with upgrades use the following syntax: |
**If it changes with upgrades use the following syntax: |
||
***<code><nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki></code> |
***<code><nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki></code> |
||
+ | |- |
||
+ | | <code>gender</code> || Gender class of the card. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
||
+ | *Only applicable if <code>type</code> is <code>"Unit"</code>. |
||
⚫ | |||
+ | *<code>"Female"</code> for female units |
||
+ | *<code>nil</code> for neutral units |
||
+ | |- |
||
+ | | <code>movement_speed</code> || Movement speed of the unit in meters per second (shown at the top of the tooltip). || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
||
+ | *Only applicable if <code>type</code> is <code>"Unit"</code>. |
||
+ | **<code>{{pht|Custom integer}}</code> |
||
|- |
|- |
||
| <code>orbs</code> || Required orbs of the card, ordered from right to left; up to 4 separated by comma; all mono or dual color combinations are allowed. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
| <code>orbs</code> || Required orbs of the card, ordered from right to left; up to 4 separated by comma; all mono or dual color combinations are allowed. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
Line 164: | Line 183: | ||
*<code>"Lost Souls"</code> |
*<code>"Lost Souls"</code> |
||
*<code>"Amii"</code> |
*<code>"Amii"</code> |
||
+ | *<code>Rebirth</code> |
||
|- |
|- |
||
| <code>rarity</code> || Rarity icon in the bottom right corner, influenced by <code>edition</code> (does not work alone). || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
| <code>rarity</code> || Rarity icon in the bottom right corner, influenced by <code>edition</code> (does not work alone). || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
||
Line 170: | Line 190: | ||
*<code>"Rare"</code> |
*<code>"Rare"</code> |
||
*<code>"Ultra Rare"</code> |
*<code>"Ultra Rare"</code> |
||
+ | |- |
||
+ | | <code>booster_locations</code> || Names of the boosters from which the card can be drawn. Only required if the card has been assigned to a booster that deviates from its orbs' colors or if the card's orbs constitute it being [[Legendary|Neutral/Legendary]] and thus sorting based on orb colors is not possible. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
||
+ | *<code>"{{pht|booster name}}"</code> |
||
+ | *Available boosters: |
||
+ | **<code>General</code> |
||
+ | **<code>Fire</code> |
||
+ | **<code>Frost</code> |
||
+ | **<code>Nature</code> |
||
+ | **<code>Shadow</code> |
||
+ | **<code>Amii</code> |
||
+ | **<code>Bandits</code> |
||
+ | **<code>Fire/Frost</code> |
||
+ | **<code>Lost Souls</code> |
||
+ | **<code>Stonekin</code> |
||
+ | **<code>Twilight</code> |
||
+ | *If the card cannot be obtained via booster opening, use <code>None</code> instead. |
||
+ | *If it is more than one, use a table instead: |
||
+ | **<code><nowiki>{</nowiki>"{{pht|booster name 1}}", ..., "{{pht|booster name n}}"<nowiki>}</nowiki></code> |
||
|- |
|- |
||
| <code>upgrade_locations</code> || Campaign drop locations of each upgrade card. Most left being upgrade 1, most right being upgrade 3. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
| <code>upgrade_locations</code> || Campaign drop locations of each upgrade card. Most left being upgrade 1, most right being upgrade 3. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
||
*Not required if the '''variant''' is <code>(Promo)</code>. |
*Not required if the '''variant''' is <code>(Promo)</code>. |
||
− | **<code><nowiki>{</nowiki>{{pht|map name}}, {{pht|map name}}, {{pht|map name}}<nowiki>}</nowiki></code> |
+ | **<code><nowiki>{</nowiki>"{{pht|map name}}", "{{pht|map name}}", "{{pht|map name}}"<nowiki>}</nowiki></code> |
|- |
|- |
||
− | | <code> |
+ | | <code>general_upgrade_text</code> || Text on upgrade cards that does not belong to a specific ability. Changes in <code>construction_time</code>, <code>power_cost</code>, <code>damage</code> or <code>health</code> are excluded and will be displayed automatically. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
*<code><nowiki>{</nowiki>"{{pht|Custom text upgrade 1}}", "{{pht|Custom text upgrade 2}}", "{{pht|Custom text upgrade 3}}"<nowiki>}</nowiki></code> |
*<code><nowiki>{</nowiki>"{{pht|Custom text upgrade 1}}", "{{pht|Custom text upgrade 2}}", "{{pht|Custom text upgrade 3}}"<nowiki>}</nowiki></code> |
||
− | **If the custom text is not |
+ | **If the custom text is not required for all upgrades simply leave the respective upgrade blank: <code>"",</code> |
|- |
|- |
||
| colspan="4" style="background-color:#070F19;" | '''Ability related parameters''' (this block repeats as many times as there are abilities) |
| colspan="4" style="background-color:#070F19;" | '''Ability related parameters''' (this block repeats as many times as there are abilities) |
||
Line 191: | Line 229: | ||
*<code>nil</code>, if no icon is shown in front of the name |
*<code>nil</code>, if no icon is shown in front of the name |
||
|- |
|- |
||
− | |<code> |
+ | |<code>hide_on_card</code> || Disables the ability to be shown on the card, but limits it to the tooltip. || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
*If false (default): <code>nil</code> |
*If false (default): <code>nil</code> |
||
*If true: <code>true</code> |
*If true: <code>true</code> |
||
|- |
|- |
||
− | | <code> |
+ | | <code>upgrade_availability</code> || Indicates on which card upgrade levels the ability is available. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
+ | *If the ability is not available on all upgrades use the following syntax : |
||
⚫ | |||
+ | **<code><nowiki>{</nowiki>{{pht|boolean}}, {{pht|boolean}}, {{pht|boolean}}, {{pht|boolean}}<nowiki>}</nowiki></code> |
||
− | *<code>1</code>, <code>2</code>, <code>3</code> |
||
+ | **Most left boolean is upgrade 0, most right upgrade 3. |
||
+ | **If available: <code>true</code> |
||
+ | **If not available: <code>false</code> |
||
|- |
|- |
||
| <code>affinity_dependency</code> || Affinity dependency of the ability, is tied to card parameter <code>affinity</code>, defaults to <code>False</code> || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
| <code>affinity_dependency</code> || Affinity dependency of the ability, is tied to card parameter <code>affinity</code>, defaults to <code>False</code> || style="text-align:center;" | [[File:True.svg|17px|link=|True]] || |
||
Line 209: | Line 250: | ||
**If the value is not present on all upgrades, simply leave the respective upgrade blank: <code>"",</code> |
**If the value is not present on all upgrades, simply leave the respective upgrade blank: <code>"",</code> |
||
|- |
|- |
||
− | | <code>description</code> || Full description of the ability, use <code>%s</code> as placeholder for values which change on upgrades. Use <code> |
+ | | <code>description</code> || Full description of the ability, use <code>%s</code> as placeholder for values which change on upgrades. Use <code><nowiki><br></nowiki></code> for a custom line break. Usage of templates like [[Template:Ability icon|Ability icon]] is also permitted. || style="text-align:center;" | [[File:False.svg|17px|link=|False]] || |
*<code>"{{pht|Custom text}}"</code> |
*<code>"{{pht|Custom text}}"</code> |
||
|- |
|- |
||
Line 215: | Line 256: | ||
*<code><nowiki>{</nowiki>{{pht|value upgrade 0}}, {{pht|value upgrade 1}}, {{pht|value upgrade 2}}, {{pht|value upgrade 3}}<nowiki>}</nowiki></code> |
*<code><nowiki>{</nowiki>{{pht|value upgrade 0}}, {{pht|value upgrade 1}}, {{pht|value upgrade 2}}, {{pht|value upgrade 3}}<nowiki>}</nowiki></code> |
||
**If the value is not present on all upgrades, simply leave the respective upgrade blank: <code>"",</code> |
**If the value is not present on all upgrades, simply leave the respective upgrade blank: <code>"",</code> |
||
+ | **If the delta per upgrade is more than just a number use preceding and closing <code>"</code> too. |
||
*If there are multiple placeholders in an ability, arrange them in a table: |
*If there are multiple placeholders in an ability, arrange them in a table: |
||
− | *<code><nowiki>{</nowiki><nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki>, <nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki>, <nowiki>{</nowiki>{{pht|...}}<nowiki>}</nowiki><nowiki>}</nowiki></code> |
+ | **<code><nowiki>{</nowiki><nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki>, <nowiki>{</nowiki>{{pht|value}}, {{pht|value}}, {{pht|value}}, {{pht|value}}<nowiki>}</nowiki>, <nowiki>{</nowiki>{{pht|...}}<nowiki>}</nowiki><nowiki>}</nowiki></code> |
|- |
|- |
||
− | | <code>upgrade_text</code> || Text displayed on the upgrade card, that specifically belongs to this ability. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
+ | | <code>upgrade_text</code> || Text displayed on the upgrade card, that specifically belongs to this ability. Learning an ability upon reaching a certain upgrade is excluded and will be displayed automatically. Use <code><nowiki><br></nowiki></code> for a custom line break. || style="text-align:center;" | [[File:Circle.svg|17px|link=|Conditional]] || |
*<code><nowiki>{</nowiki>"{{pht|Custom text upgrade 1}}", "{{pht|Custom text upgrade 2}}", "{{pht|Custom text upgrade 3}}"<nowiki>}</nowiki></code> |
*<code><nowiki>{</nowiki>"{{pht|Custom text upgrade 1}}", "{{pht|Custom text upgrade 2}}", "{{pht|Custom text upgrade 3}}"<nowiki>}</nowiki></code> |
||
− | **If the custom text is not |
+ | **If the custom text is not required for all upgrades simply leave the respective upgrade blank: <code>"",</code> |
|} |
|} |
||
== See also == |
== See also == |
||
− | *Module [[Module: |
+ | *Module [[Module:Card|Card]] |
− | *Module [[Module: |
+ | *Module [[Module:Card/get|Card/get]] |
− | *Module [[Module: |
+ | *Module [[Module:Card/has|Card/has]] |
*Category [[:Category:Modules|Modules]] |
*Category [[:Category:Modules|Modules]] |
||
Revision as of 14:29, 16 September 2021
Description
This module stores all data about the currently existing playable cards in alphabetical order. Whenever card changes occur this module needs to be updated respectively.
- Syntax
All cards' data is stored in a standardized way as shown below.
["card name (variant)"] = { affinity = , card_id = , description = , starter_card = , type = , construction_time = , gender = , movement_speed = , orbs = , power_cost = , charges = , squadqsize = , class = , weapon_type = , counter = , size = , damage = , health = , edition = , rarity = , booster_locations = , upgrade_locations = , general_upgrade_text = , abilities = { { name = ability 1, type = , hide_on_card = , upgrade_availability = , affinity_dependency = , cost = , description = , values = , upgrade_text = , }, { name = ability n, type = , hide_on_card = , upgrade_availability = , affinity_dependency = , cost = , description = , values = , upgrade_text = , } } },
- Parameter and Syntax Explanation
Parameter | Explanation / Usage Notes | Omissible | Accepted Input |
---|---|---|---|
["<card name> <variant>"] |
Full name of the card followed by the variant. |
| |
affinity |
Overwrites indicated affinity by variant (for promo cards with affinities). |
| |
card_id |
The card's unique id for upgrade 0, to be used for scripting purposes. |
| |
description |
Descriptive sentence that is shown in the card's tooltip above the abilities. Use <br> for a custom line break. |
| |
starter_card |
Indicates that the card is owned by all players as a PvE starter card. |
| |
type |
Type of the card. |
| |
construction_time |
Base construction time of the building in seconds. |
| |
gender |
Gender class of the card. |
| |
movement_speed |
Movement speed of the unit in meters per second (shown at the top of the tooltip). |
| |
orbs |
Required orbs of the card, ordered from right to left; up to 4 separated by comma; all mono or dual color combinations are allowed. |
| |
power_cost |
Power cost of the card. |
| |
charges |
Number of times the fully charged card can be played before the recharge cooldown starts. |
| |
squadsize |
Amount of individual members of which the the squad consists. |
| |
class |
Class of the card |
| |
weapon_type |
Attack type of the card, Melee and Ranged can be influenced by counter . |
| |
counter |
Size type countered by the card, can be influenced by weapon_type , omit if weapon_type is "Special" . |
| |
size |
Size type of the card. |
| |
damage |
Displayed attack value of the card. |
| |
health |
Amount of health points the entity has. |
| |
edition |
Edition icon in the bottom right corner, influenced by rarity (does not work alone). |
| |
rarity |
Rarity icon in the bottom right corner, influenced by edition (does not work alone). |
| |
booster_locations |
Names of the boosters from which the card can be drawn. Only required if the card has been assigned to a booster that deviates from its orbs' colors or if the card's orbs constitute it being Neutral/Legendary and thus sorting based on orb colors is not possible. |
| |
upgrade_locations |
Campaign drop locations of each upgrade card. Most left being upgrade 1, most right being upgrade 3. |
| |
general_upgrade_text |
Text on upgrade cards that does not belong to a specific ability. Changes in construction_time , power_cost , damage or health are excluded and will be displayed automatically. |
| |
Ability related parameters (this block repeats as many times as there are abilities) | |||
name |
Name of the ability. | Custom text of moderate length | |
type |
Type of the ability. |
| |
hide_on_card |
Disables the ability to be shown on the card, but limits it to the tooltip. |
| |
upgrade_availability |
Indicates on which card upgrade levels the ability is available. |
| |
affinity_dependency |
Affinity dependency of the ability, is tied to card parameter affinity , defaults to False |
| |
cost |
Power cost of the ability, omit if free (0) |
| |
description |
Full description of the ability, use %s as placeholder for values which change on upgrades. Use <br> for a custom line break. Usage of templates like Ability icon is also permitted. |
| |
values |
Corresponding values to the placeholders, enter in same order as they occur in description . |
| |
upgrade_text |
Text displayed on the upgrade card, that specifically belongs to this ability. Learning an ability upon reaching a certain upgrade is excluded and will be displayed automatically. Use <br> for a custom line break. |
|
See also