Overview

Path PyPoE/poe/constants.py
Version 1.0.0a0
Revision $Id: aeaf936c648dbd1604961b317f5cea47b94c53f8 $
Author Omega_K2

Description

Global constants for Path of Exile, such as version or distributor for use in the functions.

Agreement

See PyPoE/LICENSE

Documentation

class PyPoE.poe.constants.BETRAYAL_UPGRADE_SLOTS[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of betrayal upgrae slots (BetrayalUpgradeSlots.dat)

In some places in the game files these colours are referenced either by their id or by a character, so make sure to check which and use the according attribute.

Variables:
  • HELMET – Helmet slot
  • BOOTS – Boots slot
  • GLOVES – Gloves slot
  • BACK – Back slot
  • WEAPON – Weapon slot
  • None – Unused
class PyPoE.poe.constants.DELVE_UPGRADE_TYPE[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of delve upgrade type ( DelveUpgradeType.dat )

class PyPoE.poe.constants.DISTRIBUTOR[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Used to differentiate between the different distributors of the clients.

This constant is primarily virtual and has no direct relevance to the game files, but it is used in context of accounting for differences between the released versions of available Path of Exile clients.

Variables:
  • GGG – The standalone client
  • STEAM – The international steam client
  • GARENA – Garena client
  • INTERNATIONAL – The international client(s). This generally refers to the clients GGG is maintaining itself and share the same realm (i.e. currently the standalone and steam client)
  • ALL – All clients
  • DEFAULT – Default selection for clients, i.e. all.
class PyPoE.poe.constants.MAP_FRAGMENT_FAMILIES[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of map fragment families (MapFragmentFamilies.dat)

class PyPoE.poe.constants.MOD_DOMAIN[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of mod domains.

This constant is primarily used in relation to Mods.dat.

Variables:
  • ITEM – Generic item domain (but excluding items that have their own domain)
  • FLASK – Flask domain
  • MONSTER – Monster domain
  • CHEST – Chest domain, i.e. strongboxes or other type of chest-like containers
  • AREA – Area domain, i.e. for the various zones of Path of Exile
  • UNKNOWN1 –
  • UNKNOWN2 –
  • UNKNOWN3 –
  • MASTER – See CRAFTED
  • CRAFTED – Domain for crafted mods (previously MASTER)
  • MISC – Miscellaneous domain for jewel stuff, item limits, corruptions, etc
  • ATLAS – Atlas domain for modifiers that appear when using a sextant orb on the atlas
  • LEAGUESTONE – Leaguestone domain for modifiers that appear on league stones
  • ABYSS_JEWEL – Domain for modifiers that appear on Abyss jewels
  • MAP_DEVICE – For implicit modifiers that can be applied through the map device For example, vaal fragments or soul flasks
  • DELVE – For delve modifiers
  • DELVE_AREA – For modifiers appearing on delve areas
class PyPoE.poe.constants.MOD_GENERATION_TYPE[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of mod generation types.

This constant is primarily used in relation to Mods.dat.

Variables:
  • PREFIX – Prefix generation type
  • SUFFIX – Suffix generation type
  • UNIQUE – Whether the mod is directly given to an entity and not generanted by normal means. Commonly this can be found on unique monsters/items for example, but also as innate/implicit modifiers for example
  • NEMESIS – For ‘nemesis’ mods that can appear on monsters
  • CORRUPTED – For mods that are generated though item corruption
  • BLOODLINES – For ‘bloodlines’ mods that can appear on monsters
  • TORMENT – For ‘torment’ mods that can appear on monsters
  • TEMPEST – For ‘tempest’ mods that can appear on areas
  • TALISMAN – For ‘talisman’ mods that can appear on monsters
  • ENCHANTMENT – For the ascendancy/labyrinth enchantment mods that can appear on items
  • ESSENCE – For ‘essence’ mods that can appear on monsters
  • BESTIARY – For ‘bestiary’ modifiers that appear on bestiary monsters
  • DELVE_AERA – For modifiers that appear on delve areas
class PyPoE.poe.constants.RARITY[source]

Bases: enum.Enum

Representation of the possible rarities for items and monsters.

Variables:
  • NORMAL (RARITY) – Normal rarity (“white” colour)
  • MAGIC (RARITY) – Magic rarity (“blue” colour)
  • RARE (RARITY) – Rare rarity (“yellow” colour)
  • UNIQUE (RARITY) – Unique rarity (“brown” colour)
  • ANY (RARITY) – Any rarity
  • id (int) – When accessing a RARITY instance (e.x. RARITY.NORMAL) the id attribute denotes the integer that is sometimes used in the game files to represent the colour
  • name_upper (str) – When accessing a RARITY instance (e.x. RARITY.NORMAL) the upper attribute represents the textual representation with an upper case starting letter
  • name_lower (str) – When accessing a RARITY instance (e.x. RARITY.NORMAL) the lower attribute represents the textual representation with an lower case starting letter
  • colour (str) – When accessing a RARITY instance (e.x. RARITY.NORMAL) the colour attribute represents the textual representation of the associated colour
class PyPoE.poe.constants.SHOP_PACKAGE_PLATFORM[source]

Bases: PyPoE.poe.constants.IntEnumOverride

ShopPackagePlatform.dat

Variables:
  • PC – PC
  • XBOX – Microsoft XBox
  • PS – Sony Playstation
class PyPoE.poe.constants.SOCKET_COLOUR[source]

Bases: enum.Enum

Representation of item socket colours.

In some places in the game files these colours are referenced either by their id or by a character, so make sure to check which and use the according attribute.

Variables:
  • RED (SOCKET_COLOUR) – Red sockets usually associated with Strength
  • GREEN (SOCKET_COLOUR) – Green sockets usually associated with Dexterity
  • BLUE (SOCKET_COLOUR) – Blue sockets usually associated with Intelligence
  • WHITE (SOCKET_COLOUR) – White sockets
  • char (str) – When accessing a SOCKET_COLOUR instance (i.e. SOCKET_COLOUR.BLUE) the char attribute denotes the character that is sometimes used in the game files to represent the colour
  • id (int) – When accessing a SOCKET_COLOUR instance (i.e. SOCKET_COLOUR.BLUE) the id attribute denotes the integer that is sometimes used in the game files to represent the colour
class PyPoE.poe.constants.STAT_INTERPOLATION_TYPES[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of stat interpolation types (StatInterpolationTypes.dat)

Primarily used by GrantedEffects.dat

Variables:
  • CONSTANT – Constant scaling
  • LINEAR – Linear scaling
  • EXPONENTIAL –

    Exponential scaling

    skill_base =
    (
        GameConstants -> SkillDamageBaseEffectiveness +
        (GameConstants -> SkillDamageIncrementalEffectiveness * (
            MonsterLevel - 1
        ))
    ) *
    GrantedEffects['BaseEffectiveness'] *
    (1+GrantedEffects['IncrementalEffectiveness') ** (MonsterLevel - 1)
class PyPoE.poe.constants.VERSION[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Used to differentiate between the different release versions of the game, i.e. between delpoyment (live/stable) version and temporary betas for example.

This constant is primarily virtual and has no direct relevance to the game files, but it is used in context of accounting for differences between the released versions of available Path of Exile clients.

Variables:
  • STABLE – The stable version of Path of Exile. This will refer to the currently playable, public version.
  • BETA – Beta version of Path of Exile. As of currently, there is no beta running and this was only used for the Awakening Beta.
  • ALPHA – Alpha version of Path of Exile.
  • ALL – All registered version types.
  • DEFAULT – Default version (i.e. stable variants). For most use cases this is the preferred and default selection.
class PyPoE.poe.constants.WORDLISTS[source]

Bases: PyPoE.poe.constants.IntEnumOverride

Representation of words lists ( Wordlists.dat )

This constant is primarily used in relation to Words.dat

Variables:
  • ITEM_PREFIX – Prefix word of a randomly generated item name
  • ITEM_SUFFIX – Suffix word of a randomly generated item name; separate from the prefix
  • MONSTER_PREFIX – Prefix word of a randomly generated monster name.
  • MONSTER_SUFFIX – Suffix word of a randomly generated monster name; composite with the prefix
  • MONSTER_TITLE – Title (“the xxx”) of a randomly generated monster name
  • UNIQUE_ITEM – Name of a unique item
  • STRONGBOX_PREFIX – Prefix word of a randomly generated strongbox name
  • STRONGBOG_SUFFIX – Suffix word of a randomly generated strongbox name; separate from the prefix
  • ESSENCE – Name of an essence