Overview

Path PyPoE/poe/path.py
Version 1.0.0a0
Revision $Id: e0133d976e9bec360dd743009b66a7f719090a8b $
Author Omega_K2

Description

Utilities for retrieving Path of Exile related paths.

Agreement

See PyPoE/LICENSE

Documentation

class PyPoE.poe.path.PoEPath(version=<VERSION.STABLE: 1>, distributor=<DISTRIBUTOR.ALL: 7>)[source]

Bases: object

Class for retrieving default paths related to path of exile.

Warning

Currently this only works on the Windows platform, as there is no official Path of Exile client on Linux.

__init__(version=<VERSION.STABLE: 1>, distributor=<DISTRIBUTOR.ALL: 7>)[source]

Change the version or distributor if you only watch to search for specific installations.

Parameters:
get_installation_paths(only_existing=True)[source]

Returns a PoEPathList instance containing PoEPathValues depending on the version and distributor values set on class construction.

Parameters:only_existing (bool) – If True, only existing directory will be returned.
Returns:returns a PoEPathList containing PoEPathValues
Return type:list