JoinError Class Reference

Indicator of error for the server join process. More...

#include <joinerror.h>

Public Types

enum  JoinErrorType {
  NoError, MissingWads, ConfigurationError, Critical,
  Terminate, CanAutomaticallyInstallGame
}
 

Public Member Functions

 JoinError (JoinErrorType errorType)
 
 JoinError (const JoinError &other)
 
void addMissingWad (const PWad &wad)
 
void clearMissingWads ()
 
const QString & error () const
 
bool isError () const
 
bool isMissingIwadOnly () const
 
bool isMissingWadsError () const
 
const QString & missingIwad () const
 
const QList< PWad > & missingWads () const
 
JoinErroroperator= (const JoinError &other)
 
void setError (const QString &error)
 
void setMissingIwad (const QString &iwad)
 
void setMissingWads (const QList< PWad > &wads)
 
void setType (JoinErrorType type)
 
JoinErrorType type () const
 

Detailed Description

Indicator of error for the server join process.

This structure contains information about whether an error occured and if it did - what type of error it is. Based on this GUI can make a decision on how to handle the error and whether to try again.

Definition at line 41 of file joinerror.h.

Member Enumeration Documentation

Enumerator
Terminate 

Aborts without printing error.

Useful if plugin wants to do its own error handling.

CanAutomaticallyInstallGame 

Game executable was not found but it can be automatically installed by the plugin.

Definition at line 44 of file joinerror.h.

Member Function Documentation

const QString & JoinError::missingIwad ( ) const

This is valid only if type == MissingWads.

Definition at line 104 of file joinerror.cpp.

const QList< PWad > & JoinError::missingWads ( ) const

This is valid only if type == MissingWads.

Definition at line 109 of file joinerror.cpp.


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