Paths Class Reference

Wrapper class for OS paths used by the game. More...

#include <Paths.h>

Collaboration diagram for Paths:

Public Member Functions
	Paths (const CmdLineArgs &args)
const OsPath &	Root () const
	Returns the game's root directory. More...
const OsPath &	RData () const
	Returns directory for read-only data installed with the game. More...
const OsPath &	GameData () const
	Returns directory for game-managed data and mods. More...
const OsPath &	UserData () const
	Returns directory for user-created data Only things created in response to an explicit user action should go here. More...
const OsPath &	Config () const
	Returns config file directory. More...
const OsPath &	Cache () const
	Returns cache directory. More...
const OsPath &	Logs () const
	Returns logs directory. More...

Static Private Member Functions
static OsPath	Root (const OsPath &argv0)
static OsPath	RootData (const OsPath &argv0)
static OsPath	XDG_Path (const char *envname, const OsPath &home, const OsPath &defaultPath)

Private Attributes
OsPath	m_root
OsPath	m_rdata
OsPath	m_gameData
OsPath	m_userData
OsPath	m_config
OsPath	m_cache
OsPath	m_logs

Detailed Description

Wrapper class for OS paths used by the game.

Constructor & Destructor Documentation

Paths()

Paths::Paths

(

const CmdLineArgs &

args

)

Member Function Documentation

Cache()

const OsPath & Paths::Cache ( ) const

inline

Returns cache directory.

Config()

const OsPath & Paths::Config ( ) const

inline

Returns config file directory.

GameData()

const OsPath & Paths::GameData ( ) const

inline

Returns directory for game-managed data and mods.

Logs()

const OsPath & Paths::Logs ( ) const

inline

Returns logs directory.

RData()

const OsPath & Paths::RData ( ) const

inline

Returns directory for read-only data installed with the game.

Root() [1/2]

const OsPath & Paths::Root ( ) const

inline

Returns the game's root directory.

Root() [2/2]

OsPath Paths::Root ( const OsPath &  argv0 )

staticprivate

RootData()

OsPath Paths::RootData ( const OsPath &  argv0 )

staticprivate

UserData()

const OsPath & Paths::UserData ( ) const

inline

Returns directory for user-created data Only things created in response to an explicit user action should go here.

(note: only Windows currently treats this differently than GameData)

XDG_Path()

OsPath Paths::XDG_Path ( const char *  envname, const OsPath &  home, const OsPath &  defaultPath  )

staticprivate

Member Data Documentation

m_cache

OsPath Paths::m_cache

private

m_config

OsPath Paths::m_config

private

m_gameData

OsPath Paths::m_gameData

private

m_logs

OsPath Paths::m_logs

private

m_rdata

OsPath Paths::m_rdata

private

m_root

OsPath Paths::m_root

private

m_userData

OsPath Paths::m_userData

private

---

The documentation for this class was generated from the following files:

• /home/docker/jenkins/workspace/technical-docs/source/ps/GameSetup/Paths.h
• /home/docker/jenkins/workspace/technical-docs/source/ps/GameSetup/Paths.cpp