Module:Game/doc: Difference between revisions
Jump to navigation
Jump to search
>OmegaK2 (Created page with "{{ProgrammingModule}} __toc__ ==Overview== This module holds some constants and functions related to path of exile in general. ==Stucture== The module has the following st...") |
Mefisto1029 (talk | contribs) |
||
| (16 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Documentation subpage}} | ||
{{Meta module}} | |||
__TOC__ | |||
==Overview== | ==Overview== | ||
| Line 7: | Line 8: | ||
==Stucture== | ==Stucture== | ||
The module has the following structure | The module has the following structure | ||
| Line 13: | Line 13: | ||
| game.constants | | game.constants | ||
| General game constants, such as the attributes or classes | | General game constants, such as the attributes or classes | ||
|- | |||
| game.constants.item | |||
| item constants | |||
|- | |- | ||
| game.constants.mod | | game.constants.mod | ||
| Mod constants | | Mod constants | ||
|- | |||
| game.constants.monster | |||
| Monster constants | |||
|} | |} | ||
===Data=== | |||
{| class="wikitable" | |||
! rowspan="2" | Table Id | |||
! rowspan="2" | Description | |||
! colspan="5" | Available keys | |||
! rowspan="2" | 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.item.rarity | |||
| [[Rarity]] | |||
| {{yes}} | |||
| {{yes}} | |||
| {{yes}} | |||
| {{no}} | |||
| {{no}} | |||
| | |||
|- | |||
| game.constants.item.class | |||
| [[Item class]] | |||
| {{yes}} | |||
| {{yes}} | |||
| {{yes}} | |||
| {{no}} | |||
| {{no}} | |||
| | |||
|- | |||
| game.constants.mod.domains | |||
| [[Modifiers#Mod Domain|Mod Domain]] | |||
| {{no}} | |||
| {{no}} | |||
| {{no}} | |||
| {{yes}} | |||
| {{yes}} | |||
| | |||
|- | |||
| game.constants.mod.generation_types | |||
| [[Modifiers#Mod Generation Type|Mod Generation Type]] | |||
| {{yes}} | |||
| {{no}} | |||
| {{no}} | |||
| {{yes}} | |||
| {{yes}} | |||
| | |||
|- | |||
| game.constants.monster.categories | |||
| [[Monster]] categories | |||
| {{yes}} | |||
| {{yes}} | |||
| {{yes}} | |||
| {{no}} | |||
| {{no}} | |||
| | |||
|} | |||
===Exported data=== | |||
Data exported using [[Path of Exile 2 Wiki:PyPoE|pypoe]]. | |||
{| class="wikitable" | |||
! Table Id | |||
! Description | |||
! Keys | |||
! Subpage | |||
|- | |||
| game.constants.tags | |||
| Internal tags | |||
| <code>name</code><br>Optional name. | |||
| [[Module:Game/tags|tags]] | |||
|- | |||
| game.constants.item.gem_tags | |||
| [[Gem tags]] | |||
| <code>id</code><br>Internal numerical id + 1. | |||
<code>tag</code><br>Gem tag name. | |||
| [[Module:Game/gem_tags|gem_tags]] | |||
|- | |||
| game.constants.item.gem_tags_lookup | |||
| Lookup for [[gem tags]] | |||
| | |||
| [[Module:Game/gem_tags|gem_tags]] | |||
|} | |||
==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. --> | |||
{{Sister|poewiki}} | |||
}} | |||
Latest revision as of 10:24, 11 December 2025
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 |
| game.constants.monster | Monster constants |
Data
| Table Id | Description | Available keys | Extra keys | ||||
|---|---|---|---|---|---|---|---|
| full | long_upper | long_lower | short_upper | short_lower | |||
| game.constants.characters | Character |
| |||||
| game.constants.ascendancy | Ascendancy class |
| |||||
| game.constants.attributes | Attributes | ||||||
| game.constants.damage_types | Damage type | ||||||
| game.constants.difficulties | Difficulties |
| |||||
| game.constants.passive_types | Passive skill |
| |||||
| game.constants.item.rarity | Rarity | ||||||
| game.constants.item.class | Item class | ||||||
| game.constants.mod.domains | Mod Domain | ||||||
| game.constants.mod.generation_types | Mod Generation Type | ||||||
| game.constants.monster.categories | Monster categories | ||||||
Exported data
Data exported using pypoe.
| Table Id | Description | Keys | Subpage |
|---|---|---|---|
| game.constants.tags | Internal tags | nameOptional name. |
tags |
| game.constants.item.gem_tags | Gem tags | idInternal numerical id + 1.
|
gem_tags |
| game.constants.item.gem_tags_lookup | Lookup for gem tags | gem_tags |
Usage
This module should be loaded with mw.loadData().