GameExeFactory Class Reference

Returns executable file retrievers from plugins to Doomseeker. More...

#include <gameexefactory.h>

+ Inheritance diagram for GameExeFactory:

Public Member Functions

 GameExeFactory (EnginePlugin *plugin)
 
QList< ExeFilePathadditionalExecutables (int execType) const
 [Virtual] Additional paths to any executable that matches the bit mask. More...
 
GameFileList gameFiles () const
 [Virtual] List of all game files associated with this game. More...
 
EnginePluginplugin () const
 Gets EnginePlugin associated with this object. More...
 

Protected Member Functions

QList< ExeFilePathadditionalExecutables_default (int execType) const
 
GameFileList gameFiles_default () const
 
 POLYMORPHIC_SETTER_DECLARE_CONST (GameFileList, GameExeFactory, gameFiles,())
 
 POLYMORPHIC_SETTER_DECLARE_CONST (QList< ExeFilePath >, GameExeFactory, additionalExecutables,(int))
 

Detailed Description

Returns executable file retrievers from plugins to Doomseeker.

Doomseeker will use this factory to retrieve file lists for operations that are not directly tied into connecting to specific servers. It expects these files to be configured by the user.

When connecting to servers different executables may be required depending on the Server itself (for example for different game versions). To handle this case Server::clientExe() returns an ExeFile instance which allows more flexibility in behavior implementation.

See also
EnginePlugin::Data

Definition at line 53 of file gameexefactory.h.

Member Function Documentation

QList<ExeFilePath> GameExeFactory::additionalExecutables ( int  execType) const

[Virtual] Additional paths to any executable that matches the bit mask.

Return any paths to any additional executables that may match the execType bitmask field. Executables should exist on the local machine. These executables will be used by Doomseeker to present users with additional choices, for example to pick a different executable when creating a new game.

Default implementation does nothing and returns an empty list.

Parameters
execTypeGameFile::ExecType bitmask field. Return only executables that match this bitmask. Match criteria are to be decided by the plugin.
GameFileList GameExeFactory::gameFiles ( ) const

[Virtual] List of all game files associated with this game.

This list is used to generate path configurators in plugin configuration box.

Read doc for GameFile.

EnginePlugin * GameExeFactory::plugin ( ) const

Gets EnginePlugin associated with this object.

Definition at line 55 of file gameexefactory.cpp.


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