DIFF

class ErrorHandlerModuleScriptSource

ErrorHandlerModuleScript › ErrorHandlerModule

Derived classes
BIOSErrorModuleClientKickedModuleConnectErrorClientModuleConnectErrorScriptModule
View all 5 descendants

All members, including inherited

Constructors 2

void ErrorHandlerModuleScript()

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

References FillErrorDataMap(), and InitOptionalVariables()
void ~ErrorHandlerModuleScript()
References m_UIHandler

Members 6

protected int m_LastErrorThrown = 0

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

Referenced by ConnectErrorClientModule.OnEvent(), ConnectErrorScriptModule.OnEvent(), ConnectErrorServerModule.OnEvent()
Show 3 more, GetLastClientMessage(), GetLastServerMessage(), and OnErrorThrown()
protected string m_LastAdditionalInfo = ""

Holds the last additional info passed in

Referenced by GetLastClientMessage(), GetLastServerMessage(), and OnErrorThrown()
protected 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)

Referenced by GetProperties(), InsertDialogueErrorProperties(), InsertErrorProperties()
Show 6 more, InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertHeaderDialogueErrorProperties(), InsertPrefixDialogueErrorProperties(), InsertSplitDialogueErrorProperties(), and OnErrorThrown()

Methods 15

void InitOptionalVariables()

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

Referenced by BIOSErrorModule.InitOptionalVariables(), ClientKickedModule.InitOptionalVariables(), ConnectErrorClientModule.InitOptionalVariables()
Show 3 more, ConnectErrorScriptModule.InitOptionalVariables(), ConnectErrorServerModule.InitOptionalVariables(), and ErrorHandlerModuleScript()
ErrorProperties GetProperties(int errorCode)

Fetches the ErrorProperties for the error code.

errorCode
int The full error code

Returns: ErrorProperties The data and handling for the error

References Error(), map.Find(), string.Format()
Show 3 more, ErrorModuleHandler.GetCodeFromError(), ErrorModuleHandler.GetErrorHex(), and m_ErrorDataMap
Referenced by GetClientMessage(), GetServerMessage(), and OnErrorThrown()
override string GetClientMessage(int errorCode, string additionalInfo = "")

Fetches the Client message for the error code.

errorCode
int The full error code

Returns: string The Client message for the error

References ErrorProperties.GetClientMessage(), and GetProperties()
Referenced by GetLastClientMessage()
override string GetLastClientMessage(int errorCode)

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

Returns: string The Client message for the error

References ErrorEx(), string.Format(), GetClientMessage()
Show 3 more, ErrorModuleHandler.GetErrorHex(), m_LastAdditionalInfo, and m_LastErrorThrown
override string GetServerMessage(int errorCode, string additionalInfo = "")

Fetches the Server message for the error code.

errorCode
int The full error code

Returns: string The Server message for the error

References GetProperties(), and ErrorProperties.GetServerMessage()
Referenced by GetLastServerMessage()
override string GetLastServerMessage(int errorCode)

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

Returns: string The Server message for the error

References ErrorEx(), string.Format(), ErrorModuleHandler.GetErrorHex()
Show 3 more, GetServerMessage(), m_LastAdditionalInfo, and m_LastErrorThrown
protected 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

errorCode
int The full error code
additionalInfo
string Any additional info regarding the error, usually data
References ErrorEx(), map.Find(), string.Format()
Show 9 more, ErrorHandlerModule.GetCategory(), ErrorModuleHandler.GetErrorHex(), GetProperties(), ErrorProperties.HandleError(), ErrorHandlerModule.OnErrorThrown(), ToString(), m_ErrorDataMap, m_LastAdditionalInfo, and m_LastErrorThrown
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 4 more, m_ErrorDataMap, m_Header, m_Prefix, and m_UIHandler
Referenced by BIOSErrorModule.InsertBIOSError(), ClientKickedModule.FillErrorDataMap(), ConnectErrorClientModule.FillErrorDataMap()
Show 3 more, ConnectErrorScriptModule.FillErrorDataMap(), ConnectErrorServerModule.FillErrorDataMap(), and FillErrorDataMap()
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 3 more, m_ErrorDataMap, m_Prefix, and m_UIHandler
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 3 more, m_ErrorDataMap, m_Header, and m_UIHandler
Referenced by ClientKickedModule.FillErrorDataMap()
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 4 more, m_ErrorDataMap, m_Header, m_Prefix, and m_UIHandler
Referenced by ClientKickedModule.FillErrorDataMap()
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 4 more, m_ErrorDataMap, m_Header, m_Prefix, and m_UIHandler
Referenced by ClientKickedModule.FillErrorDataMap()
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

References DialogueErrorProperties.DialogueErrorProperties(), string.Format(), map.Insert()
Show 4 more, m_ErrorDataMap, m_Header, m_Prefix, and m_UIHandler
Referenced by ClientKickedModule.FillErrorDataMap()