Module:GenericData/doc: Difference between revisions

(2 intermediate revisions by the same user not shown)

Line 10:

===Examples===

<code><nowiki>{{#invoke:GenericData|get_objective_param|~~GoldPerOrb~~}}</nowiki></code>

<code><nowiki>{{#invoke:GenericData|get_objective_param|Tier1GoldKill}}</nowiki></code>

==get_rejuv_param==

Provides access to "RejuvParams" ~~data~~.

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===

* '''key''' - key to access

* '''key''' - The key to access (e.g., <code>MaxHP</code>, <code>RejuvinatorRebirthDuration</code>).

* '''~~midboss_deaths~~''' - (OPTIONAL) list index to access ~~that represents how many times midboss has died,~~ if the ~~provided~~ key's value is ~~a list~~

* '''index''' - (OPTIONAL) The list index to access if the key's value is an array.

===Examples===

<code><nowiki>{{#invoke:GenericData|get_rejuv_param|~~RejuvinatorExpirationWarningTiming~~}}</nowiki></code>

<code><nowiki>{{#invoke:GenericData|get_rejuv_param|MaxHP}}</nowiki></code>

{{#invoke:GenericData|get_rejuv_param|~~RejuvinatorExpirationWarningTiming~~}}

<code><nowiki>{{#invoke:GenericData|get_rejuv_param|~~TrooperHealthMult~~|3}}</nowiki></code>

<code><nowiki>{{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}}</nowiki></code>

{{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}}

==get_tiered_item_price==

Line 34:

Line 36:

===Parameters===

* '''tier''' - list index to access ~~that~~ represents the tier of the item

* '''tier''' - The list index to access, which represents the tier of the item.

===Examples===

Line 41:

Line 43:

==~~get_lane_phase_gold_share_frac~~==

==get_trooper_gold_share_frac==

Provides access to "~~LanePhaseGoldShareFrac~~" data (soul distribution percentages when multiple players kill a lane trooper).

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>

==get_hero_gold_share_frac==

Provides access to "HeroKillGoldShareFrac" data (soul distribution percentages when multiple players kill an enemy hero).

===Parameters===

* '''index''' - ~~Number~~ of players splitting the souls (1 = solo, 2 = duo, etc.)

* '''index''' - The number of players splitting the souls (1 = solo, 2 = duo, etc.).

===Examples===

<code><nowiki>{{#invoke:GenericData|~~get_lane_phase_gold_share_frac~~|1}}</nowiki></code>

<code><nowiki>{{#invoke:GenericData|get_hero_gold_share_frac|4}}</nowiki></code>

==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.

<code><nowiki>{{#invoke:GenericData|~~get_lane_phase_gold_share_frac~~|2}}</nowiki></code>

===Examples===

~~{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}}~~

<code><nowiki>{{#invoke:GenericData|get_streetbrawl_param|m_iScoreToWin}}</nowiki></code>

~~<code><nowiki>~~{{#invoke:GenericData|~~get_lane_phase_gold_share_frac~~|~~3}}</nowiki></code>~~

~~{{#invoke:GenericData|get_lane_phase_gold_share_frac|3~~}}

Module:GenericData/doc: Difference between revisionsGive feedback

LVL (talk | contribs)

@@ Line 10: / Line 10: @@
 ===Examples===
-<code><nowiki>{{#invoke:GenericData|get_objective_param|GoldPerOrb}}</nowiki></code>
+<code><nowiki>{{#invoke:GenericData|get_objective_param|Tier1GoldKill}}</nowiki></code>
-{{#invoke:GenericData|get_objective_param|GoldPerOrb}}
+{{#invoke:GenericData|get_objective_param|Tier1GoldKill}}
 ==get_rejuv_param==
-Provides access to "RejuvParams" data.
+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===
-* '''key''' - key to access
+* '''key''' - The key to access (e.g., <code>MaxHP</code>, <code>RejuvinatorRebirthDuration</code>).
-* '''midboss_deaths''' - (OPTIONAL) list index to access that represents how many times midboss has died, if the provided key's value is a list
+* '''index''' - (OPTIONAL) The list index to access if the key's value is an array.
 ===Examples===
-<code><nowiki>{{#invoke:GenericData|get_rejuv_param|RejuvinatorExpirationWarningTiming}}</nowiki></code>
+<code><nowiki>{{#invoke:GenericData|get_rejuv_param|MaxHP}}</nowiki></code>
-{{#invoke:GenericData|get_rejuv_param|RejuvinatorExpirationWarningTiming}}
+{{#invoke:GenericData|get_rejuv_param|MaxHP}}
-<code><nowiki>{{#invoke:GenericData|get_rejuv_param|TrooperHealthMult|3}}</nowiki></code>
+<code><nowiki>{{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}}</nowiki></code>
-{{#invoke:GenericData|get_rejuv_param|TrooperHealthMult|3}}
+{{#invoke:GenericData|get_rejuv_param|RejuvinatorRebirthDuration|1}}
 ==get_tiered_item_price==
@@ Line 34: / Line 36: @@
 ===Parameters===
-* '''tier''' - list index to access that represents the tier of the item
+* '''tier''' - The list index to access, which represents the tier of the item.
 ===Examples===
@@ Line 41: / Line 43: @@
 {{#invoke:GenericData|get_tiered_item_price|5}}
-==get_lane_phase_gold_share_frac==
+==get_trooper_gold_share_frac==
-Provides access to "LanePhaseGoldShareFrac" data (soul distribution percentages when multiple players kill a lane trooper).
+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''' - Number of players splitting the souls (1 = solo, 2 = duo, etc.)
+* '''index''' - The number of players splitting the souls (1 = solo, 2 = duo, etc.).
 ===Examples===
-<code><nowiki>{{#invoke:GenericData|get_lane_phase_gold_share_frac|1}}</nowiki></code>
+<code><nowiki>{{#invoke:GenericData|get_hero_gold_share_frac|4}}</nowiki></code>
-{{#invoke:GenericData|get_lane_phase_gold_share_frac|1}}
+{{#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.
-<code><nowiki>{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}}</nowiki></code>
+===Examples===
-{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}}
+<code><nowiki>{{#invoke:GenericData|get_streetbrawl_param|m_iScoreToWin}}</nowiki></code>
-<code><nowiki>{{#invoke:GenericData|get_lane_phase_gold_share_frac|3}}</nowiki></code>
+{{#invoke:GenericData|get_streetbrawl_param|m_iScoreToWin}}
-{{#invoke:GenericData|get_lane_phase_gold_share_frac|3}}