Module:GenericData/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
initial doc
 
LVL (talk | contribs)
Updated doc for soul distribution function
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 40: Line 40:


{{#invoke:GenericData|get_tiered_item_price|5}}
{{#invoke:GenericData|get_tiered_item_price|5}}
==get_lane_phase_gold_share_frac==
Provides access to "LanePhaseGoldShareFrac" data (soul distribution percentages when multiple players kill a lane trooper).
===Parameters===
* '''index''' - 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>
{{#invoke:GenericData|get_lane_phase_gold_share_frac|1}}
<code><nowiki>{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}}</nowiki></code>
{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}}
<code><nowiki>{{#invoke:GenericData|get_lane_phase_gold_share_frac|3}}</nowiki></code>
{{#invoke:GenericData|get_lane_phase_gold_share_frac|3}}

Revision as of 15:03, 2 July 2025

Overview

Provides access to generic/miscellaneous data from Data:GenericData.json

Functions

get_objective_param

Provides access to "ObjectiveParams" data.

Parameters

  • key - key to access

Examples

{{#invoke:GenericData|get_objective_param|GoldPerOrb}}

0

get_rejuv_param

Provides access to "RejuvParams" data.

Parameters

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

Examples

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

30

{{#invoke:GenericData|get_rejuv_param|TrooperHealthMult|3}}

2.3

get_tiered_item_price

Provides access to "ItemPricePerTier" data.

Parameters

  • tier - list index to access that represents the tier of the item

Examples

{{#invoke:GenericData|get_tiered_item_price|5}}

6400

get_lane_phase_gold_share_frac

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

Parameters

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

Examples

{{#invoke:GenericData|get_lane_phase_gold_share_frac|1}} ERROR: This function is deprecated. Use `get_trooper_gold_share_frac` instead.

{{#invoke:GenericData|get_lane_phase_gold_share_frac|2}} ERROR: This function is deprecated. Use `get_trooper_gold_share_frac` instead.

{{#invoke:GenericData|get_lane_phase_gold_share_frac|3}} ERROR: This function is deprecated. Use `get_trooper_gold_share_frac` instead.