wowlib::fs::FileSystemSettings Struct Reference

#include <wowlib/fs/filesystem.hpp>

Static Public Member Functions
static Result< FileSystemSettings >	detect (std::filesystem::path clientPath, Locale locale=Locale::enUS, std::optional< std::filesystem::path > projectDirectory={}, std::optional< std::filesystem::path > listfileCsv={}, FileDataID customFdidStart=DefaultCustomFdidStart)

Public Attributes
const std::filesystem::path	clientPath
	The client installation root (the directory containing Data/).
const ClientVersion	version
	The client version; selects the storage backend and MPQ chain.
const Locale	locale = Locale::enUS
const std::optional< std::filesystem::path >	projectDirectory {}
const std::optional< std::filesystem::path >	listfileCsv {}
const FileDataID	customFdidStart {DefaultCustomFdidStart}
const std::optional< std::string >	cascProduct {}

Detailed Description

Definition at line 38 of file filesystem.hpp.

Member Function Documentation

detect()

Result< FileSystemSettings > wowlib::fs::FileSystemSettings::detect ( std::filesystem::path clientPath, Locale locale = Locale::enUS, std::optional< std::filesystem::path > projectDirectory = {}, std::optional< std::filesystem::path > listfileCsv = {}, FileDataID customFdidStart = DefaultCustomFdidStart )

static

Returns

the settings, or the error ClientInstall.detect raised

Parameters

clientPath	the installation directory holding Data/
locale	client locale
projectDirectory	the project-directory overlay
listfileCsv	the working listfile CSV
customFdidStart	first FileDataID for added files

Definition at line 28 of file filesystem.cpp.

References clientPath, customFdidStart, wowlib::fs::ClientInstall::detect(), listfileCsv, locale, and projectDirectory.

Member Data Documentation

cascProduct

const std::optional<std::string> wowlib::fs::FileSystemSettings::cascProduct {}

Definition at line 53 of file filesystem.hpp.

Referenced by wowlib::fs::FileSystem::open().

clientPath

const std::filesystem::path wowlib::fs::FileSystemSettings::clientPath

The client installation root (the directory containing Data/).

Definition at line 40 of file filesystem.hpp.

Referenced by detect(), and wowlib::fs::FileSystem::open().

customFdidStart

const FileDataID wowlib::fs::FileSystemSettings::customFdidStart {DefaultCustomFdidStart}

Definition at line 51 of file filesystem.hpp.

Referenced by detect().

listfileCsv

const std::optional<std::filesystem::path> wowlib::fs::FileSystemSettings::listfileCsv {}

Definition at line 49 of file filesystem.hpp.

Referenced by detect(), and wowlib::fs::FileSystem::open().

locale

const Locale wowlib::fs::FileSystemSettings::locale = Locale::enUS

Definition at line 45 of file filesystem.hpp.

Referenced by detect(), and wowlib::fs::FileSystem::open().

projectDirectory

const std::optional<std::filesystem::path> wowlib::fs::FileSystemSettings::projectDirectory {}

Definition at line 47 of file filesystem.hpp.

Referenced by detect(), and wowlib::fs::FileSystem::open().

version

const ClientVersion wowlib::fs::FileSystemSettings::version

The client version; selects the storage backend and MPQ chain.

Definition at line 43 of file filesystem.hpp.

Referenced by wowlib::fs::FileSystem::open().

---

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

• src/wowlib/fs/filesystem.hpp
• src/wowlib/fs/filesystem.cpp