Module:HeroData/doc: Difference between revisions

(3 intermediate revisions by one other user not shown)

Line 69:

=== get_alt_fire_var ===

Retrieve a hero's variable's from "AltFire" table. Works the same as get_hero_var

Retrieve a hero's variable's value from "AltFire" table. Works the same as get_hero_var

====Examples====

Line 109:

* '''hero_var''' - Key of the hero's variable that is inside either "Spirit Scaling" or "Level Scaling", see [[Data:HeroData.json]]

* '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to.

* '''no_template''' - OPTIONAL, return numerical value instead of scaling template. Has to be defined as "true"

====Examples====

Line 117:

Line 118:

<pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}</pre>

{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}

No template

<pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}</pre>

{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}

====Notes====

Line 123:

Line 128:

=== hero_has_stat ===

Checks if a hero possesses a specific stat in their Base data, Level Scaling (Boons), or Spirit Scaling. Used primarily for conditionally hiding rows in infoboxes.

The base value is looked up in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block, the same as get_hero_var. A stat counts as present when its base value is non-zero, or when it has any non-zero scaling.

====Parameters====

Line 133:

Line 140:

=== get_hero_key ===

Returns the key of the specified hero's english name

Returns the key of the specified hero's english name. A hero key may also be passed, in which case it is returned unchanged. Matching is case-insensitive. Returns "Hero not found." when the input matches no hero.

====Parameters====

* '''hero_name''' - Name of the hero in english

* '''hero_name''' - Name of the hero in english, or a hero key

====Example====

<pre>{{#invoke:HeroData|get_hero_key|Abrams}}</pre>

=== resolve_key ===

The same lookup as get_hero_key, but returns an empty string instead of "Hero not found." when the input matches no hero. Intended for templates that need to branch on whether the input names a hero at all.

====Parameters====

* '''hero_name_or_key''' - Name of the hero in english, or a hero key

====Example====

<pre>{{#invoke:HeroData|resolve_key|Abrams}}</pre>

=== get_ability_key ===

Line 161:

Line 178:

<pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>

=== ~~write_hero_comparison_table~~ ===

=== has_tags ===

~~Writes~~ the ~~[[Hero Comparison]] table~~ for a ~~specific Level and Spirit Power~~

Returns "true" when the hero has description tags, or an empty string otherwise. Intended for templates that need to hide a tag block entirely for heroes without tags.

====Parameters====

* '''~~level~~''' - ~~Number~~ of ~~[[Level]]s / Power Increases~~

* '''name''' - Name of the hero in english

* '''spirit_power''' - Amount of Spirit power

~~Both parameters are optional, as if both are 0 or not provided,~~ the ~~outputted table will be at base and will also include the level/SS scaling~~ in ~~each cell along with the base value, rather than the scaled value.~~

====Example====

~~From wikitext:<br>~~

<pre>{{#invoke:HeroData|has_tags|Abrams}}</pre>

<pre>{{#invoke:HeroData|~~write_hero_comparison_table|LEVEL~~|~~SPIRITPOWER~~}}</pre>

~~Which outputs~~

=== write_role_playstyle_quote ===

Line 219:

Line 230:

== Internal Utility Functions ==

The following functions are ~~primarily for internal use but may be useful for advanced users~~:

The following functions are called directly from Lua by other modules, not from wikitext:

=== get_json_item ===

Line 227:

Line 238:

* '''name''' - Name of the hero in english

=== ~~get_similar_items~~ ===

=== get_stat ===

Returns an ~~array~~ of hero ~~tables that have~~ a ~~specified property~~

Returns the value of a stat, checking the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block. Returns nil when the hero has no such stat. This is the shared lookup behind get_hero_var, get_list_elem and hero_has_stat.

====Parameters====

* '''hero_data''' - Hero table, such as the one returned by get_json_item

* '''stat''' - Key of the stat

=== get_scalings ===

Returns an ordered list of a hero's scalings for a stat, Level first then Spirit:

<pre>{ { type = "Level", value = 1.5 }, { type = "Spirit", value = 0.04 } }</pre>

Absent and zero scalings are omitted, so an empty list means the stat does not scale.

====Parameters====

* '''hero_data''' - Hero table

* '''stat''' - Key of the stat

* '''include_zero''' - OPTIONAL, keep scalings whose value is 0. Only get_hero_scaling_data needs this.

=== has_stat ===

Returns true when a hero has a non-zero base value for a stat, or any scaling for it. Backs hero_has_stat.

====Parameters====

* '''hero_data''' - Hero table

* '''stat''' - Key of the stat

=== find_hero_key ===

Resolves a hero key or an english hero name to a hero key, case-insensitively. Returns nil when the input matches no hero. Backs get_hero_key and resolve_key.

====Parameters====

* '''input''' - Hero key or english hero name

=== hero_tag ===

Returns a hero's Nth description tag, or an empty string when there is no such tag. Backs get_hero_tag and has_tags.

====Parameters====

* '''hero_en''' - Name of the hero in english

* '''index''' - Which tag to return (1, 2 or 3)

=== write_scalar_str ===

Returns the expanded <code>Ss</code> or <code>PI</code> template for a scaling value, or an empty string when the value is 0.

====Parameters====

* '''scaling_value''' - The scaling amount

* '''scaling_type''' - "Spirit" or "Level"

* '''compact''' - OPTIONAL, render the compact form with the value shown

=== get_hero_scaling_data ===

'''Deprecated''', use get_scalings instead. Returns a table keyed by scaling value, so an entry is silently dropped when Level and Spirit scale by the same amount, and zero scalings are kept. Retained only for [[Module:HeroComparisonTable]].

====Parameters====

* '''~~property~~''' - ~~Property key to search for~~

* '''hero_data''' - Hero table

* '''stat''' - Key of the stat

== Scaling System ==

Module:HeroData/doc: Difference between revisionsGive feedback

Vergir (talk | contribs)

@@ Line 69: / Line 69: @@
 === get_alt_fire_var ===
-Retrieve a hero's variable's from "AltFire" table. Works the same as get_hero_var
+Retrieve a hero's variable's value from "AltFire" table. Works the same as get_hero_var
 ====Examples====
@@ Line 109: / Line 109: @@
 * '''hero_var''' - Key of the hero's variable that is inside either "Spirit Scaling" or "Level Scaling", see [[Data:HeroData.json]]
 * '''sig_figs_or_localize''' - OPTIONAL, # of sig figs to round to.
+* '''no_template''' - OPTIONAL, return numerical value instead of scaling template. Has to be defined as "true"
 ====Examples====
@@ Line 117: / Line 118: @@
 <pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}</pre>
 {{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2}}
+No template
+<pre>{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}</pre>
+{{#invoke:HeroData|get_hero_scalar|hero_atlas|Level|BulletDamage|2|no_template=true}}
 ====Notes====
@@ Line 123: / Line 128: @@
 === hero_has_stat ===
 Checks if a hero possesses a specific stat in their Base data, Level Scaling (Boons), or Spirit Scaling. Used primarily for conditionally hiding rows in infoboxes.
+The base value is looked up in the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block, the same as get_hero_var. A stat counts as present when its base value is non-zero, or when it has any non-zero scaling.
 ====Parameters====
@@ Line 133: / Line 140: @@
 === get_hero_key ===
-Returns the key of the specified hero's english name
+Returns the key of the specified hero's english name. A hero key may also be passed, in which case it is returned unchanged. Matching is case-insensitive. Returns "Hero not found." when the input matches no hero.
 ====Parameters====
-* '''hero_name''' - Name of the hero in english
+* '''hero_name''' - Name of the hero in english, or a hero key
 ====Example====
 <pre>{{#invoke:HeroData|get_hero_key|Abrams}}</pre>
+=== resolve_key ===
+The same lookup as get_hero_key, but returns an empty string instead of "Hero not found." when the input matches no hero. Intended for templates that need to branch on whether the input names a hero at all.
+====Parameters====
+* '''hero_name_or_key''' - Name of the hero in english, or a hero key
+====Example====
+<pre>{{#invoke:HeroData|resolve_key|Abrams}}</pre>
+{{#invoke:HeroData|resolve_key|Abrams}}
 === get_ability_key ===
@@ Line 161: / Line 178: @@
 <pre>{{#invoke:HeroData|get_hero_tag|Abrams|1}}</pre>
-=== write_hero_comparison_table ===
+=== has_tags ===
-Writes the [[Hero Comparison]] table for a specific Level and Spirit Power
+Returns "true" when the hero has description tags, or an empty string otherwise. Intended for templates that need to hide a tag block entirely for heroes without tags.
 ====Parameters====
-* '''level''' - Number of [[Level]]s / Power Increases
+* '''name''' - Name of the hero in english
-* '''spirit_power''' - Amount of Spirit power
-Both parameters are optional, as if both are 0 or not provided, the outputted table will be at base and will also include the level/SS scaling in each cell along with the base value, rather than the scaled value.
 ====Example====
-From wikitext:<br>
+<pre>{{#invoke:HeroData|has_tags|Abrams}}</pre>
-<pre>{{#invoke:HeroData|write_hero_comparison_table|LEVEL|SPIRITPOWER}}</pre>
+{{#invoke:HeroData|has_tags|Abrams}}
-Which outputs
-{{#invoke:HeroData|write_hero_comparison_table|11|200}}
 === write_role_playstyle_quote ===
@@ Line 219: / Line 230: @@
 == Internal Utility Functions ==
-The following functions are primarily for internal use but may be useful for advanced users:
+The following functions are called directly from Lua by other modules, not from wikitext:
 === get_json_item ===
@@ Line 227: / Line 238: @@
 * '''name''' - Name of the hero in english
-=== get_similar_items ===
+=== get_stat ===
-Returns an array of hero tables that have a specified property
+Returns the value of a stat, checking the hero's top-level data, then the 'Weapon' block, then the 'AltFire' block. Returns nil when the hero has no such stat. This is the shared lookup behind get_hero_var, get_list_elem and hero_has_stat.
+====Parameters====
+* '''hero_data''' - Hero table, such as the one returned by get_json_item
+* '''stat''' - Key of the stat
+=== get_scalings ===
+Returns an ordered list of a hero's scalings for a stat, Level first then Spirit:
+<pre>{ { type = "Level", value = 1.5 }, { type = "Spirit", value = 0.04 } }</pre>
+Absent and zero scalings are omitted, so an empty list means the stat does not scale.
+====Parameters====
+* '''hero_data''' - Hero table
+* '''stat''' - Key of the stat
+* '''include_zero''' - OPTIONAL, keep scalings whose value is 0. Only get_hero_scaling_data needs this.
+=== has_stat ===
+Returns true when a hero has a non-zero base value for a stat, or any scaling for it. Backs hero_has_stat.
+====Parameters====
+* '''hero_data''' - Hero table
+* '''stat''' - Key of the stat
+=== find_hero_key ===
+Resolves a hero key or an english hero name to a hero key, case-insensitively. Returns nil when the input matches no hero. Backs get_hero_key and resolve_key.
+====Parameters====
+* '''input''' - Hero key or english hero name
+=== hero_tag ===
+Returns a hero's Nth description tag, or an empty string when there is no such tag. Backs get_hero_tag and has_tags.
+====Parameters====
+* '''hero_en''' - Name of the hero in english
+* '''index''' - Which tag to return (1, 2 or 3)
+=== write_scalar_str ===
+Returns the expanded <code>Ss</code> or <code>PI</code> template for a scaling value, or an empty string when the value is 0.
+====Parameters====
+* '''scaling_value''' - The scaling amount
+* '''scaling_type''' - "Spirit" or "Level"
+* '''compact''' - OPTIONAL, render the compact form with the value shown
+=== get_hero_scaling_data ===
+'''Deprecated''', use get_scalings instead. Returns a table keyed by scaling value, so an entry is silently dropped when Level and Spirit scale by the same amount, and zero scalings are kept. Retained only for [[Module:HeroComparisonTable]].
 ====Parameters====
-* '''property''' - Property key to search for
+* '''hero_data''' - Hero table
+* '''stat''' - Key of the stat
 == Scaling System ==