class ErrorModuleHandlerSource

The error handler itself, for managing and distributing errors to modules Manages the ErrorHandlerModule instances inserted in Init. API comes with several functions to Create, Throw and extract data from error codes. The format used is an int which is made up of two shorts, one that holds the category and one that holds the code. Therefore when looking at an error code, it is much easier to identify when looking at the hex value.

Methods 23

static proto int ThrowError(ErrorCategory category, int code, string additionalInfo = "")

Creates and throws the error code, sending it to the handler of the category.

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]
additionalInfo: string Any additional info regarding the error, usually data

Returns: int The full error code

int errorCode = ErrorModuleHandler.ThrowError( ErrorCategory.ConnectErrorClient, -1 );
Print( errorCode );

>> errorCode = 196607

Referenced by DayZGame.TryConnect()

static proto int ThrowErrorCode(int errorCode, string additionalInfo = "")

Throws the error code and sends it to the handler of the category.

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

Returns: int The full error code

int errorCode = ErrorModuleHandler.ThrowErrorCode( 0x0002FFFF );
Print( errorCode );

>> errorCode = 196607

static proto int CreateError(ErrorCategory category, int code)

Creates full error code.

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]

Returns: int The full error code

int errorCode = ErrorModuleHandler.CreateError( ErrorCategory.ConnectErrorClient, -1 );
Print( errorCode );

>> errorCode = 196607

static proto ErrorCategory GetCategoryFromError(int errorCode)

Returns the category the error was thrown from.

errorCode: int The full error code

Returns: ErrorCategory The ErrorCategory the error was thrown from

ErrorCategory category = ErrorModuleHandler.GetCategoryFromError( 0x0002FFFF );
Print( category );

>> category = 2

static proto int GetCodeFromError(int errorCode)

Returns the code of the error.

errorCode: int The full error code

Returns: int The code of the error

int code = ErrorModuleHandler.GetCodeFromError( 0x0002FFFF );
Print( code );

>> code = -1

Referenced by ConnectErrorScriptModuleUI.OnModalResult(), and ErrorHandlerModuleScript.GetProperties()

static proto string GetErrorHex(int errorCode)

Returns a formatted string of the error code.

errorCode: int The full error code

Returns: string A formatted string of the error code

string formattedCode = ErrorModuleHandler.GetErrorHex( 196607 );
Print( formattedCode );

>> formattedCode = '0x0002FFFF'

Referenced by DialogueErrorProperties.HandleError(), ErrorHandlerModule.GetSimpleMessage(), ErrorHandlerModule.OnErrorThrown()

Show 4 more

, ErrorHandlerModuleScript.GetLastClientMessage(), ErrorHandlerModuleScript.GetLastServerMessage(), ErrorHandlerModuleScript.GetProperties(), and ErrorHandlerModuleScript.OnErrorThrown()

static proto bool AddModule(ErrorCategory category, notnull ErrorHandlerModule errorModule)

Adds a module handler to the ErrorModuleHandler.

category: ErrorCategory Category the module is for
errorModule: ErrorHandlerModule The class containing the information and codes for the category.

Returns: bool Whether the adding of the module was successful or not

Referenced by SafeAddModule()

static proto bool RemoveModule(ErrorCategory category)

Removes a module handler from the ErrorModuleHandler.

category: ErrorCategory Category the module is for

Returns: bool Whether the removing of the module was successful or not

Referenced by SafeRemoveModule()

static proto string GetClientMessage(ErrorCategory category, int code, string additionalInfo = "")

Gets the Client Message for specified error

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]
additionalInfo: string Any additional info regarding the error, usually data

Returns: string The message which would appear on Client

Referenced by OnlineServices.ErrorCaught(), ServerBrowserTabConsole.OnLoadServersAsyncConsole(), and ServerBrowserTabConsolePages.OnLoadServersAsyncConsole()

static proto string GetClientMessageByCode(int errorCode, string additionalInfo = "")

Gets the Client Message for specified error

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

Returns: string The message which would appear on Client

static proto string GetLastClientMessage(ErrorCategory category, int code)

Gets the Client Message for specified error, while attempting to restore information on the most recent error

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]

Returns: string The message which would appear on Client

static proto string GetLastClientMessageByCode(int errorCode)

Gets the Client Message for specified error, while attempting to restore information on the most recent error

errorCode: int The full error code

Returns: string The message which would appear on Client

static proto string GetServerMessage(ErrorCategory category, int code, string additionalInfo = "")

Gets the Server Message for specified error

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]
additionalInfo: string Any additional info regarding the error, usually data

Returns: string The message which would appear on Server

static proto string GetServerMessageByCode(int errorCode, string additionalInfo = "")

Gets the Server Message for specified error

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

Returns: string The message which would appear on Server

static proto string GetLastServerMessage(ErrorCategory category, int code)

Gets the Server Message for specified error, while attempting to restore information on the most recent error

category: ErrorCategory Category the error is thrown from
code: int The code that the error belongs to inside the category between [-32768, 32767]

Returns: string The message which would appear on Server

static proto string GetLastServerMessageByCode(int errorCode)

Gets the Server Message for specified error, while attempting to restore information on the most recent error