Файл ErrorHandlerModule.c

См. исходные тексты.

Структуры данных
class	ErrorHandlerModule
	Definition and API of an ErrorHandlerModule - Do not insert any logic here! (as this class is not moddable) Подробнее...

Функции
void	ErrorHandlerModuleScript ()
	Constructor, by default calls the function that will fill the ErrorDataMap.
void	~ErrorHandlerModuleScript ()
void	InitOptionalVariables ()
	Function which gets called before FillErrorDataMap, designed to set Optional Variales before ErrorProperties are created.
void	FillErrorDataMap ()
	Function to fill up m_ErrorDataMap, gets called in the Constructor.
ErrorProperties	GetProperties (int errorCode)
	Fetches the ErrorProperties for the error code.
override string	GetClientMessage (int errorCode, string additionalInfo="")
	Fetches the Client message for the error code.
override string	GetLastClientMessage (int errorCode)
	Fetches the Client message for the error code, attempting to retrieve the data from the latest.
override string	GetServerMessage (int errorCode, string additionalInfo="")
	Fetches the Server message for the error code.
override string	GetLastServerMessage (int errorCode)
	Fetches the Server message for the error code, attempting to retrieve the data from the latest.
override void	OnErrorThrown (int errorCode, owned string additionalInfo="")
	Event that gets triggered when an error of the owned category is thrown. Do not call directly! Call ErrorModuleHandler.ThrowError instead.
void	InsertDialogueErrorProperties (int code, string message, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling, using the Optional Variables.
void	InsertHeaderDialogueErrorProperties (int code, string message, string header, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling with custom header.
void	InsertPrefixDialogueErrorProperties (int code, string message, string prefix, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling with custom prefix.
void	InsertExtendedPrefixDialogueErrorProperties (int code, string message, string prefix, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling with extended prefix.
void	InsertExtendedPrefixSplitDialogueErrorProperties (int code, string message, string prefix, string serverMessage, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling with extended prefix and separate server message.
void	InsertSplitDialogueErrorProperties (int code, string message, string serverMessage, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
	Insert an error with Dialogue as handling with separate server message.
void	InsertErrorProperties (int code, string message="")
	Insert an error with no handling.

Переменные
class ErrorHandlerModule	m_Header = ""
	This is where to input logic and extend functionality of ErrorHandlerModule.
string	m_Prefix = ""
	Optional: Prefix (e.g. Fixed text at the start of the messages in the module)
ref UIScriptedMenu	m_UIHandler = null
	Optional: The UI the handler might generally use
int	m_LastErrorThrown = 0
	Holds the last thrown error in this module, defaults to 0.
string	m_LastAdditionalInfo = ""
	Holds the last additional info passed in.
ref map< int, ref ErrorProperties >	m_ErrorDataMap = new map<int, ref ErrorProperties>()
	Map containing the codes that exist for the ErrorHandlerModule The code links to ErrorProperties This contains at the very least the Message for the error Additionally, it can contain the way to handle the error (e.g. Throw a Dialogue with the message)

Функции

ErrorHandlerModuleScript()

void ErrorHandlerModuleScript ( )

protected

Constructor, by default calls the function that will fill the ErrorDataMap.

    {
        InitOptionalVariables();
        FillErrorDataMap();
    }

Перекрестные ссылки FillErrorDataMap() и InitOptionalVariables().

FillErrorDataMap()

void FillErrorDataMap ( )

protected

Function to fill up m_ErrorDataMap, gets called in the Constructor.

Already insert the default "UNKNOWN ERROR" message for code "-1"

    {
        InsertDialogueErrorProperties(-1, "#server_browser_error_unknown");
    }

Перекрестные ссылки InsertDialogueErrorProperties().

GetClientMessage()

override string GetClientMessage ( int errorCode, string additionalInfo = "" )

protected

Fetches the Client message for the error code.

Аргументы

errorCode

int The full error code

Возвращает

string The Client message for the error

    {
        ErrorProperties properties = GetProperties(errorCode);
            
        if ( properties )
        {
            return properties.GetClientMessage(additionalInfo);
        }
        else
        {
            return additionalInfo;
        }
    }

Перекрестные ссылки GetProperties().

Используется в GetLastClientMessage().

GetLastClientMessage()

override string GetLastClientMessage ( int errorCode )

protected

Fetches the Client message for the error code, attempting to retrieve the data from the latest.

Аргументы

errorCode

int The full error code to check against

Возвращает

string The Client message for the error

    {
        if (errorCode == m_LastErrorThrown)
        {
            return GetClientMessage(errorCode, m_LastAdditionalInfo);
        }
        else
        {
            ErrorEx(string.Format("Was unable to get the information on the last error as another has already occurred. (%1 != %2)", ErrorModuleHandler.GetErrorHex(errorCode), ErrorModuleHandler.GetErrorHex(m_LastErrorThrown)));
            return GetClientMessage(errorCode);
        }
    }

Перекрестные ссылки ErrorEx, GetClientMessage(), ErrorModuleHandler::GetErrorHex(), m_LastAdditionalInfo и m_LastErrorThrown.

GetLastServerMessage()

override string GetLastServerMessage ( int errorCode )

protected

Fetches the Server message for the error code, attempting to retrieve the data from the latest.

Аргументы

errorCode

int The full error code to check against

Возвращает

string The Server message for the error

    {
        if (errorCode == m_LastErrorThrown)
        {
            return GetServerMessage(errorCode, m_LastAdditionalInfo);
        }
        else
        {
            ErrorEx(string.Format("Was unable to get the information on the last error as another has already occurred. (%1 != %2)", ErrorModuleHandler.GetErrorHex(errorCode), ErrorModuleHandler.GetErrorHex(m_LastErrorThrown)), ErrorExSeverity.WARNING);
            return GetServerMessage(errorCode);
        }
    }

Перекрестные ссылки ErrorEx, ErrorModuleHandler::GetErrorHex(), GetServerMessage(), m_LastAdditionalInfo и m_LastErrorThrown.

GetProperties()

ErrorProperties GetProperties ( int errorCode )

protected

Fetches the ErrorProperties for the error code.

Аргументы

errorCode

int The full error code

Возвращает

ErrorProperties The data and handling for the error

    {
        int error = ErrorModuleHandler.GetCodeFromError(errorCode);
        ErrorProperties properties = null;
            
        if (!m_ErrorDataMap.Find(error, properties))
        {
            Error(string.Format("[EHM] Could not find any properties for error %1(%2) in %3", errorCode, ErrorModuleHandler.GetErrorHex(errorCode), this));
        }
        
        return properties;
    }

Перекрестные ссылки Error(), ErrorModuleHandler::GetCodeFromError(), ErrorModuleHandler::GetErrorHex() и m_ErrorDataMap.

Используется в GetClientMessage(), GetServerMessage() и OnErrorThrown().

GetServerMessage()

override string GetServerMessage ( int errorCode, string additionalInfo = "" )

protected

Fetches the Server message for the error code.

Аргументы

errorCode

int The full error code

Возвращает

string The Server message for the error

    {
        ErrorProperties properties = GetProperties(errorCode);
            
        if ( properties )
        {
            return properties.GetServerMessage(additionalInfo);
        }
        else
        {
            return additionalInfo;
        }
    }

Перекрестные ссылки GetProperties().

Используется в GetLastServerMessage().

InitOptionalVariables()

void InitOptionalVariables ( )

protected

Function which gets called before FillErrorDataMap, designed to set Optional Variales before ErrorProperties are created.

    {
    }

InsertDialogueErrorProperties()

void InsertDialogueErrorProperties ( int code, string message, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling, using the Optional Variables.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2", m_Prefix, message), message, m_Header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Header, m_Prefix и m_UIHandler.

Используется в ClientKickedModule::FillErrorDataMap(), ConnectErrorClientModule::FillErrorDataMap(), FillErrorDataMap(), ConnectErrorServerModule::FillErrorDataMap() и BIOSErrorModule::InsertBIOSError().

InsertErrorProperties()

void InsertErrorProperties ( int code, string message = "" )

protected

Insert an error with no handling.

    {
        m_ErrorDataMap.Insert(code, ErrorProperties(message, message));
    }

Перекрестные ссылки m_ErrorDataMap.

Используется в BIOSErrorModule::FillErrorDataMap(), ClientKickedModule::FillErrorDataMap(), ConnectErrorClientModule::FillErrorDataMap() и BIOSErrorModule::InsertBIOSError().

InsertExtendedPrefixDialogueErrorProperties()

void InsertExtendedPrefixDialogueErrorProperties ( int code, string message, string prefix, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling with extended prefix.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2%3", m_Prefix, prefix, message), message, m_Header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Header, m_Prefix и m_UIHandler.

Используется в ClientKickedModule::FillErrorDataMap().

InsertExtendedPrefixSplitDialogueErrorProperties()

void InsertExtendedPrefixSplitDialogueErrorProperties ( int code, string message, string prefix, string serverMessage, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling with extended prefix and separate server message.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2%3", m_Prefix, prefix, message), serverMessage, m_Header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Header, m_Prefix и m_UIHandler.

Используется в ClientKickedModule::FillErrorDataMap().

InsertHeaderDialogueErrorProperties()

void InsertHeaderDialogueErrorProperties ( int code, string message, string header, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling with custom header.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2", m_Prefix, message), message, header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Prefix и m_UIHandler.

InsertPrefixDialogueErrorProperties()

void InsertPrefixDialogueErrorProperties ( int code, string message, string prefix, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling with custom prefix.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2", prefix, message), message, m_Header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Header и m_UIHandler.

Используется в ClientKickedModule::FillErrorDataMap().

InsertSplitDialogueErrorProperties()

void InsertSplitDialogueErrorProperties ( int code, string message, string serverMessage, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Insert an error with Dialogue as handling with separate server message.

    {
        m_ErrorDataMap.Insert(code, DialogueErrorProperties(string.Format("%1%2", m_Prefix, message), serverMessage, m_Header, m_UIHandler, dialogButtonType, defaultButton, dialogMeaningType, displayAdditionalInfo));
    }

Перекрестные ссылки DialogueErrorProperties(), m_ErrorDataMap, m_Header, m_Prefix и m_UIHandler.

Используется в ClientKickedModule::FillErrorDataMap().

OnErrorThrown()

override void OnErrorThrown ( int errorCode, owned string additionalInfo = "" )

protected

Event that gets triggered when an error of the owned category is thrown. Do not call directly! Call ErrorModuleHandler.ThrowError instead.

Аргументы

errorCode	int The full error code
additionalInfo	string Any additional info regarding the error, usually data

    {
        super.OnErrorThrown(errorCode, additionalInfo);
        
        m_LastErrorThrown = errorCode;
        m_LastAdditionalInfo = additionalInfo;
        
        ErrorProperties properties = GetProperties(errorCode);
            
        if ( properties )
        {
            properties.HandleError(errorCode, additionalInfo);
        }
        else
        {
            ErrorEx(string.Format("Error code %1(%2) was thrown but no ErrorProperties was found for it in category %3.", errorCode, ErrorModuleHandler.GetErrorHex(errorCode), GetCategory().ToString()));
            if (m_ErrorDataMap.Find(-1, properties))
            {
                properties.HandleError(errorCode, additionalInfo);
            }
        }
    }

Перекрестные ссылки ErrorEx, GetCategory(), ErrorModuleHandler::GetErrorHex(), GetProperties(), m_ErrorDataMap, m_LastAdditionalInfo, m_LastErrorThrown и ToString().

~ErrorHandlerModuleScript()

void ~ErrorHandlerModuleScript ( )

protected

    {
        if (m_UIHandler)
        {
            delete m_UIHandler;
        }
    }

Перекрестные ссылки m_UIHandler.

Переменные

m_ErrorDataMap

ref map<int, ref ErrorProperties> m_ErrorDataMap = new map<int, ref ErrorProperties>()

protected

Map containing the codes that exist for the ErrorHandlerModule The code links to ErrorProperties This contains at the very least the Message for the error Additionally, it can contain the way to handle the error (e.g. Throw a Dialogue with the message)

Используется в GetProperties(), InsertDialogueErrorProperties(), InsertErrorProperties(), InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertHeaderDialogueErrorProperties(), InsertPrefixDialogueErrorProperties(), InsertSplitDialogueErrorProperties() и OnErrorThrown().

m_Header

class ErrorHandlerModule m_Header = ""

This is where to input logic and extend functionality of ErrorHandlerModule.

Optional: Header (e.g. The header of a Dialogue box)

Используется в DialogueErrorProperties(), HandleError(), BIOSErrorModule::InitOptionalVariables(), ClientKickedModule::InitOptionalVariables(), ConnectErrorClientModule::InitOptionalVariables(), ConnectErrorServerModule::InitOptionalVariables(), InsertDialogueErrorProperties(), InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertPrefixDialogueErrorProperties() и InsertSplitDialogueErrorProperties().

m_LastAdditionalInfo

string m_LastAdditionalInfo = ""

protected

Holds the last additional info passed in.

Используется в GetLastClientMessage(), GetLastServerMessage() и OnErrorThrown().

m_LastErrorThrown

int m_LastErrorThrown = 0

protected

Holds the last thrown error in this module, defaults to 0.

Используется в GetLastClientMessage(), GetLastServerMessage(), OnErrorThrown(), ConnectErrorClientModule::OnEvent(), OnEvent() и ConnectErrorServerModule::OnEvent().

m_Prefix

string m_Prefix = ""

protected

Optional: Prefix (e.g. Fixed text at the start of the messages in the module)

Используется в ClientKickedModule::InitOptionalVariables(), InsertDialogueErrorProperties(), InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertHeaderDialogueErrorProperties() и InsertSplitDialogueErrorProperties().

m_UIHandler

ref UIScriptedMenu m_UIHandler = null

protected

Optional: The UI the handler might generally use

Используется в InsertDialogueErrorProperties(), InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertHeaderDialogueErrorProperties(), InsertPrefixDialogueErrorProperties(), InsertSplitDialogueErrorProperties() и ~ErrorHandlerModuleScript().