Module:GenericData/doc: Difference between revisionsGive feedback
initial doc |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Overview= | =Overview= | ||
Provides access to generic/miscellaneous data from [[Data:GenericData.json]] | Provides access to generic/miscellaneous data from [[Data:GenericData.json]] | ||
=Functions= | =Functions= | ||
| Line 10: | Line 10: | ||
===Examples=== | ===Examples=== | ||
<code><nowiki>{{#invoke:GenericData|get_objective_param| | <code><nowiki>{{#invoke:GenericData|get_objective_param|Tier1GoldKill}}</nowiki></code> | ||
{{#invoke:GenericData|get_objective_param| | {{#invoke:GenericData|get_objective_param|Tier1GoldKill}} | ||
==get_rejuv_param== | ==get_rejuv_param== | ||
Provides access to "RejuvParams" | Provides access to data related to the Rejuvenator. | ||
'''Note:''' Some values (e.g., buff stats like <code>MaxHP</code>) are hard-coded in the module, while others are read from the "RejuvParams" table in [[Data:GenericData.json]]. Some JSON parameters may be for obsolete mechanics. | |||
===Parameters=== | ===Parameters=== | ||
* '''key''' - key to access | * '''key''' - The key to access (e.g., <code>MaxHP</code>, <code>RejuvinatorRebirthDuration</code>). | ||
* ''' | * '''index''' - (OPTIONAL) The list index to access if the key's value is an array. | ||
===Examples=== | ===Examples=== | ||
<code><nowiki>{{#invoke:GenericData|get_rejuv_param| | <code><nowiki>{{#invoke:GenericData|get_rejuv_param|MaxHP}}</nowiki></code> | ||
{{#invoke:GenericData|get_rejuv_param| | {{#invoke:GenericData|get_rejuv_param|MaxHP}} | ||
<code><nowiki>{{#invoke:GenericData|get_rejuv_param| | <code><nowiki>{{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}}</nowiki></code> | ||
{{#invoke:GenericData|get_rejuv_param| | {{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}} | ||
==get_tiered_item_price== | ==get_tiered_item_price== | ||
| Line 34: | Line 36: | ||
===Parameters=== | ===Parameters=== | ||
* '''tier''' - list index to access | * '''tier''' - The list index to access, which represents the tier of the item. | ||
===Examples=== | ===Examples=== | ||
| Line 40: | Line 42: | ||
{{#invoke:GenericData|get_tiered_item_price|5}} | {{#invoke:GenericData|get_tiered_item_price|5}} | ||
==get_trooper_gold_share_frac== | |||
Provides access to "TrooperKillGoldShareFrac" data (soul distribution percentages when multiple players kill a lane trooper). | |||
===Parameters=== | |||
* '''index''' - The number of players splitting the souls (1 = solo, 2 = duo, etc.). | |||
===Examples=== | |||
<code><nowiki>{{#invoke:GenericData|get_trooper_gold_share_frac|3}}</nowiki></code> | |||
{{#invoke:GenericData|get_trooper_gold_share_frac|3}} | |||
==get_hero_gold_share_frac== | |||
Provides access to "HeroKillGoldShareFrac" data (soul distribution percentages when multiple players kill an enemy hero). | |||
===Parameters=== | |||
* '''index''' - The number of players splitting the souls (1 = solo, 2 = duo, etc.). | |||
===Examples=== | |||
<code><nowiki>{{#invoke:GenericData|get_hero_gold_share_frac|4}}</nowiki></code> | |||
{{#invoke:GenericData|get_hero_gold_share_frac|4}} | |||
==get_streetbrawl_param== | |||
Provides access to "StreetBrawl" data (respawn times, gold per round, objective health, etc.). | |||
===Parameters=== | |||
* '''key''' - The key to access (e.g., <code>m_vecGoldPerRound</code>, <code>m_iScoreToWin</code>). | |||
* '''index''' - (OPTIONAL) The list index to access if the key's value is an array (e.g., <code>1</code> for Round 1). If omitted, returns a comma-separated list of all values. | |||
===Examples=== | |||
<code><nowiki>{{#invoke:GenericData|get_streetbrawl_param|m_iScoreToWin}}</nowiki></code> | |||
{{#invoke:GenericData|get_streetbrawl_param|m_iScoreToWin}} | |||