The OpenD Programming Language

standardpaths

Functions for retrieving standard paths in cross-platform manner.

Public Imports

xdgpaths public import xdgpaths;: Undocumented in source.

Members

Enums

FolderFlag enum FolderFlag: Control behavior of functions.
StandardPath enum StandardPath: Location types that can be passed to writablePath and standardPaths functions.

Functions

homeDir string homeDir(): Current user home directory.
roamingPath deprecated string roamingPath(FolderFlag params): Path to Roaming data directory. Windows only.
savedGames deprecated string savedGames(FolderFlag params): Location where games may store their saves. Windows only. Note: This is common path for games. One should use subfolder for their game saves.
standardPaths string[] standardPaths(StandardPath type): Get paths for various locations.
standardPaths string[] standardPaths(StandardPath type, string subfolder): Evaluate paths for various locations and append subfolder.
writablePath string writablePath(StandardPath type, FolderFlag params): Get writable path for specific location.
writablePath string writablePath(StandardPath type, string subfolder, FolderFlag params): Evaluate writable path for specific location and append subfolder. This can be used with StandardPath.config and StandardPath.data to retrieve folder specific for this application instead of generic path.

Meta

Source

See Source File

Authors

Roman Chistokhodov

License

Boost License 1.0.

Copyright

Roman Chistokhodov 2015-2016