WadPathFinder Class Reference

Wrapper for PathFinder that specializes in findings WADs. More...

#include <wadpathfinder.h>

Public Member Functions

 WadPathFinder (PathFinder pathFinder)
 
WadFindResult find (const QString &name)
 
void setAllowAliases (bool allowed)
 Can disable WAD aliasing for contexts where only specific WADs should be found. More...
 

Detailed Description

Wrapper for PathFinder that specializes in findings WADs.

By WAD we understand any extension file that can be loaded by the game, so not just .wad but also .pk3, .7z, .deh, etc.

WadPathFinder accepts an already configured PathFinder in its constructor. Usually, a default-constructed PathFinder already loads the paths from user configuration, however some callers, including plugins, can also add other paths to PathFinder. This allows customization of what paths will be searched depending on the context.

WadPathFinder considers WAD aliases configured by the user, such as freedoom2.wad being a valid replacement for doom2.wad. It also considers additional OS paths for WAD finding, if given OS has reasonable defaults for WAD files. As WadPathFinder is not MAIN_EXPORT, these features are outside of plugin control.

Additional paths appended on Linux:

  1. /usr/local/share/games/doom/
  2. /usr/share/games/doom/

Definition at line 76 of file wadpathfinder.h.

Member Function Documentation

void WadPathFinder::setAllowAliases ( bool  allowed)

Can disable WAD aliasing for contexts where only specific WADs should be found.

Definition at line 142 of file wadpathfinder.cpp.


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