Module:Game/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>OmegaK2
(→‎Usage: removed language interwikis)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{ProgrammingModule}}
{{Documentation subpage}}


__toc__
{{Meta module}}
__TOC__


==Overview==
==Overview==
Line 7: Line 8:


==Stucture==
==Stucture==
The module has the following structure
The module has the following structure


Line 14: Line 14:
| General game constants, such as the attributes or classes
| General game constants, such as the attributes or classes
|-
|-
| game.contants.item
| game.constants.item
| item constants
| item constants
|-
|-
Line 22: Line 22:


===Data===
===Data===
{| class="wikitable"
{| class="wikitable"
! rowspan="2" | Table Id  
! rowspan="2" | Table Id  
! rowspan="2" | Description
! rowspan="2" | Description
! colspan="5" | Available keys
! colspan="5" | Available keys
! Extra keys
|-
|-
! full
! full
Line 33: Line 33:
! short_upper
! short_upper
! short_lower
! short_lower
|-
| game.constants.characters
| [[Character]]
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
* id - internal id
|-
| game.constants.ascendancy
| [[Ascendancy class]]
| {{no}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
* id - internal id
* character - character id
|-
|-
| game.constants.attributes
| game.constants.attributes
Line 41: Line 62:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|
|-  
|-  
| game.constants.damage_types
| game.constants.damage_types
| [[Damage type]]
| {{no}}
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
|  
|  
|-
| game.constants.difficulties
| [[Difficulties]]
| {{yes}}
| {{yes}}
| {{yes}}
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
* resistances - resist cap
* minimum_level - minimum required level to enter
* label - one letter label
|-
| game.constants.passive_types
| [[Passive skill]]
| {{no}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
| {{yes}}
| {{yes}}
| {{no}}
|
* type - 'normal' or 'ascendancy'
|-  
|-  
| game.constants.tags
| game.constants.tags
Line 57: Line 102:
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
|-  
|-  
| game.constants.item.rarity
| game.constants.item.rarity
Line 65: Line 111:
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
|-  
|-  
| game.constants.item.class
| game.constants.item.class
Line 73: Line 120:
| {{no}}
| {{no}}
| {{no}}
| {{no}}
|
|-  
|-  
| game.constants.item.gem_tags
| game.constants.item.gem_tags
Line 81: Line 129:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|
|-  
|-  
| game.constants.mod.domains
| game.constants.mod.domains
Line 89: Line 138:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|
|-  
|-  
| game.constants.mod.generation_types
| game.constants.mod.generation_types
Line 97: Line 147:
| {{yes}}
| {{yes}}
| {{yes}}
| {{yes}}
|
|}
|}
==Usage==
This module should be loaded with <code>[[mw:Extension:Scribunto/Lua_reference_manual#mw.loadData|mw.loadData()]]</code>.
{{Documentation categories|
<!-- Categories and interwikis go here. -->
}}

Latest revision as of 15:56, 2 October 2024

This subpage provides documentation for Module:Game.

This is a meta module.

This module is meant to be used only by other modules. It should not be invoked in wikitext.

Overview

This module holds some constants and functions related to path of exile in general.

Stucture

The module has the following structure

game.constants General game constants, such as the attributes or classes
game.constants.item item constants
game.constants.mod Mod constants

Data

Table Id Description Available keys Extra keys
full long_upper long_lower short_upper short_lower
game.constants.characters Character No No No No No
  • id - internal id
game.constants.ascendancy Ascendancy class No No No No No
  • id - internal id
  • character - character id
game.constants.attributes Attributes No Yes Yes Yes Yes
game.constants.damage_types Damage type No No No Yes Yes
game.constants.difficulties Difficulties Yes Yes Yes No No
  • resistances - resist cap
  • minimum_level - minimum required level to enter
  • label - one letter label
game.constants.passive_types Passive skill No Yes No Yes No
  • type - 'normal' or 'ascendancy'
game.constants.tags internal tags Yes No No No No
game.constants.item.rarity Rarity Yes Yes Yes No No
game.constants.item.class Item class Yes Yes Yes No No
game.constants.item.gem_tags Gem tags Yes Yes Yes Yes Yes
game.constants.mod.domains Mod Domain No No No Yes Yes
game.constants.mod.generation_types Mod Generation Type Yes No No Yes Yes

Usage

This module should be loaded with mw.loadData().