Plugin API

All classes exported by Doomseeker and usable in Plugin API. More...

Classes

class  Application
 Program central hub of information. More...
 
class  ConfigPage
 Base class for configuration pages. More...
 
class  CreateServerDialogApi
 Plugin proxy for CreateServerDialog. More...
 
class  CreateServerDialogPage
 Base class to be used by plugins to define custom pages in Create Game dialog. More...
 
class  DataPaths
 Represents directories used by Doomseeker to store data. More...
 
class  DataStreamOperatorWrapper
 Wraps around QDataStream stream operators to provide cleaner reading interface. More...
 
class  DMFlag
 A game setting that is a part of a group of settings that can be OR'ed logically as a single integer. More...
 
class  DMFlagsSection
 A group of DMFlag objects that can be safely OR'ed together to form a meaningful value. More...
 
class  DoomseekerFilePaths
 Static class responsible for retrieving paths to data files used by Doomseeker. More...
 
class  EngineConfigPage
 Base for configuration pages for plugins; provides some default behavior. More...
 
class  EnginePlugin
 
class  ExeFile
 Access to external program executables (game clients, servers, and so on). More...
 
class  ExeFilePath
 A simple executable path & working dir structure. More...
 
class  GameClientRunner
 Creates command line that launches the client executable of the game and connects it to a server. More...
 
class  GameCreateParams
 Game parametrization data used when creating new games. More...
 
class  GameCVar
 A general game setting or variable (like fraglimit). More...
 
class  GameCVarProvider
 Creates GameCVar set. More...
 
class  GameExeFactory
 Returns executable file retrievers from plugins to Doomseeker. More...
 
class  GameFile
 Game file definition allows to browse this file in configuration box. More...
 
class  GameFileList
 GameFile collection. More...
 
class  GameHost
 Creates game servers, offline games or demo playbacks. More...
 
class  GameMode
 Game mode representation. More...
 
class  Ini
 Configuration handler. More...
 
class  IniSection
 INI section representation. More...
 
class  IniVariable
 INI variable representation. More...
 
class  IRCNetworkEntity
 Data structure that describes and defines a connection to an IRC network or server. More...
 
class  IwadAndWadsPickerDialog
 Simple dialog box where user can pick path to IWAD and additional game files. More...
 
class  JoinError
 Indicator of error for the server join process. More...
 
class  Log
 Log manager. More...
 
class  MasterClient
 Abstract base for all MasterClients. More...
 
class  Message
 Message object used to pass messages throughout the Doomseeker's system. More...
 
class  PathFinder
 Performs a case-insensitive (OS independent) file searches. More...
 
class  PathFinderResult
 Result of multiple file search operation done by PathFinder. More...
 
class  Player
 Data structure that holds information about players in a server. More...
 
class  PlayersList
 
class  PWad
 PWAD hosted on a server. More...
 
class  Random
 Random values generator. More...
 
class  RConProtocol
 Remote console protocol interface. More...
 
class  Scanner
 Scanner reads scripts by checking individual tokens. More...
 
class  Server
 A representation of a server for a given game. More...
 
class  ServerConnectParams
 A DTO for GameClientRunner; exchanges information between main program and plugins, and allows future extensions. More...
 
class  SettingsProvider
 
class  SettingsProviderQt
 
class  Skill
 Game difficulty setting. More...
 
class  Strings
 
class  TooltipGenerator
 
class  Version
 Provides interface for plugins and for Doomseeker itself to obtain version information on the program. More...
 

Files

file  serverptr.h
 
file  serverstructs.h
 

Typedefs

typedef int gamemode_id
 Unique identifier of a GameMode within the plugin. More...
 

Enumerations

enum  GameFile::ExecType {
  Client = 0x1, Server = 0x2, Offline = 0x4, Cso = Client | Server | Offline,
  CreateGame = Server | Offline
}
 Executable types recognised by Doomseeker. More...
 

Detailed Description

All classes exported by Doomseeker and usable in Plugin API.

Please note that while this lists only these classes that are supposed to be used inside plugin code, these classes also declare public methods that are meant to be used from inside Doomseeker core code only. These methods are marked as such in documentation text, and using them inappropriately may lead to undefined behavior.

Typedef Documentation

typedef int gamemode_id

Unique identifier of a GameMode within the plugin.

This is an integral value that can be cast to GameMode::StandardGameMode or whatever other integral value the plugin provides. It is used to uniquely identify the GameMode and is stored in game setup configurations created by "Create Game" dialog box.

gamemode_id should be a small integer that can be safely cast to int regardless of the underlying CPU architecture. Plugins should not change ID of a GameMode in their version history once a concrete value is decided upon. Plugins also should not overlap GameMode::StandardGameMode values.

When hosting a game, plugin should be prepared that the passed gamemode_id will be GameMode::SGM_Unknown, upon which plugin should leave it up to the game to pick the game mode.

Definition at line 348 of file serverstructs.h.

Enumeration Type Documentation

Executable types recognised by Doomseeker.

Definition at line 79 of file gamefile.h.