Module:LevelTables/doc: Difference between revisions

One Bar (talk | contribs)
Create doc for level tables
 
LVL (talk | contribs)
Added documentation on new changes.
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This module is used to create tables that display a stat of the heroes against the souls of each level powerup.
This module is used to create tables that display a stat of the heroes against the souls of each level powerup. The data comes from [[Data:HeroData.json]] and [[Data:SoulUnlockData.json]].


A table is created with <br><nowiki>{{#invoke:LevelTables|write_power_increase_table|</nowiki>''(stat)''}}<br>
The primary function creates a theme-aware, collapsible section containing a data table. This is invoked with:
where ''(stat)'' is replaced with one of the power level increase stats.
'''<nowiki>{{#invoke:LevelTables|write_power_increase_table|</nowiki>''(stat)''|title=''Section Title''}}'''
where '''''(stat)''''' is replaced with one of the power level increase stats, and '''''Section Title''''' is the text that appears in the header of the collapsible box.


Currently, the valid stats are '''BulletDamage''', '''MaxHealth''', '''TechPower''', '''LightMeleeDamage''', '''HeavyMeleeDamage'''
The generated table provides a summary of key milestones and includes an expandable '[Show All]' button for each hero to view the complete scaling data.


The stat keys and names are stored in the private variable ''level_scaling_key_to_name'', so if a new stat gets added to level scaling in ''HeroData.json'', you can add it to that variable.
Currently, the valid stats are '''BulletDamage''', '''MaxHealth''', '''TechPower''', '''LightMeleeDamage''', and '''HeavyMeleeDamage'''


Since the alternate fires of some heroes' guns are not stored in ''HeroData.json'', there is a varibale to store the damage and scaling called ''alt_fires''.
The stat keys and names are stored in the private variable ''level_scaling_key_to_name'', so if a new stat gets added to level scaling in [[Data:HeroData.json|HeroData.json]], you can add it to that variable.
 
Since the alternate fires of some heroes' guns are not stored in [[Data:HeroData.json|HeroData.json]], there is a variable to store the damage and scaling called ''alt_fires''.


Here is an example of the Bullet Damage Table:
Here is an example of the Bullet Damage Table:
{{#invoke:LevelTables|write_power_increase_table|BulletDamage}}
{{#invoke:LevelTables|write_power_increase_table|BulletDamage|title=Base Bullet Damage}}
 
This module also has a function to write a list of heroes with multi-shot weapons, how many shots their weapon has, how much base damage a shot does, and how much damage a shot increases by per boon.
 
The list is automatically sorted alphabetically (ignoring "The" for names like The Doorman) and provides accurate descriptions for special cases, such as heroes whose multi-pellet attacks only deal damage once.
 
This list can be invoked with: <br>'''<nowiki>{{#invoke:LevelTables|write_multishot_stats}}</nowiki>'''
 
This is what the generated list looks like:
 
{{#invoke:LevelTables|write_multishot_stats}}