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. More...

Private Member Functions
void	SafeAddModule (notnull ErrorHandlerModule errorModule)
	Wrapper for AddModule to give feedback whether it succeeded or not.

void	SafeRemoveModule (notnull ErrorHandlerModule errorModule)
	Wrapper for RemoveModule to give feedback whether it succeeded or not.

void	SafeRemoveModule (ErrorCategory category)
	Wrapper for RemoveModule to give feedback whether it succeeded or not.

private void	Init ()
	Gets called shortly after creation of ErrorModuleHandler.

void	OnEvent (EventType eventTypeId, Param params)
	is called by DayZGame to pass Events.

Static Private Member Functions
static proto int	ThrowError (ErrorCategory category, int code, string additionalInfo="")
	Creates and throws the error code, sending it to the handler of the category.

static proto int	ThrowErrorCode (int errorCode, string additionalInfo="")
	Throws the error code and sends it to the handler of the category.

static proto int	CreateError (ErrorCategory category, int code)
	Creates full error code.

static proto ErrorCategory	GetCategoryFromError (int errorCode)
	Returns the category the error was thrown from.

static proto int	GetCodeFromError (int errorCode)
	Returns the code of the error.

static proto owned string	GetErrorHex (int errorCode)
	Returns a formatted string of the error code.

static proto bool	AddModule (ErrorCategory category, notnull ErrorHandlerModule errorModule)
	Adds a module handler to the ErrorModuleHandler.

static proto bool	RemoveModule (ErrorCategory category)
	Removes a module handler from the ErrorModuleHandler.

static proto string	GetClientMessage (ErrorCategory category, int code, string additionalInfo="")
	Gets the Client Message for specified error.

static proto string	GetClientMessageByCode (int errorCode, string additionalInfo="")
	Gets the Client Message for specified error.

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.

static proto string	GetLastClientMessageByCode (int errorCode)
	Gets the Client Message for specified error, while attempting to restore information on the most recent error.

static proto string	GetServerMessage (ErrorCategory category, int code, string additionalInfo="")
	Gets the Server Message for specified error.

static proto string	GetServerMessageByCode (int errorCode, string additionalInfo="")
	Gets the Server Message for specified error.

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.

static proto string	GetLastServerMessageByCode (int errorCode)
	Gets the Server Message for specified error, while attempting to restore information on the most recent error.

static proto native ErrorModuleHandler	GetInstance ()
	Gets the EMH Instance.

static proto void	GetErrorModules (notnull out array< ErrorHandlerModule > errorModules)

Detailed Description

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.

Member Function Documentation

◆ AddModule()

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

staticprivate

Adds a module handler to the ErrorModuleHandler.

Parameters

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().

◆ CreateError()

static proto int CreateError	(	ErrorCategory	category,
		int	code
	)

staticprivate

Creates full error code.

Parameters

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

ErrorCategory
ErrorCategory
ErrorCategory - To decide what ErrorHandlerModule needs to be called and easily identify where it cam...
Definition ErrorModuleHandler.c:5

ErrorModuleHandler
The error handler itself, for managing and distributing errors to modules Manages the ErrorHandlerMod...
Definition ErrorModuleHandler.c:29

ErrorModuleHandler::CreateError
static proto int CreateError(ErrorCategory category, int code)
Creates full error code.

Print
proto void Print(void var)
Prints content of variable to console/log.

◆ GetCategoryFromError()

static proto ErrorCategory GetCategoryFromError ( int errorCode )

staticprivate

Returns the category the error was thrown from.

Parameters

errorCode int The full error code

Returns: ErrorCategory The ErrorCategory the error was thrown from
ErrorCategory category = ErrorModuleHandler.GetCategoryFromError( 0x0002FFFF );

Print( category );

>> category = 2

ErrorModuleHandler::GetCategoryFromError
static proto ErrorCategory GetCategoryFromError(int errorCode)
Returns the category the error was thrown from.

◆ GetClientMessage()

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

staticprivate

Gets the Client Message for specified error.

Parameters

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(), and ServerBrowserTab::OnLoadServersAsyncConsole().

◆ GetClientMessageByCode()

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

staticprivate

Gets the Client Message for specified error.

Parameters

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

◆ GetCodeFromError()

static proto int GetCodeFromError ( int errorCode )

staticprivate

Returns the code of the error.

Parameters

errorCode int The full error code

Returns: int The code of the error
int code = ErrorModuleHandler.GetCodeFromError( 0x0002FFFF );

Print( code );

>> code = -1

ErrorModuleHandler::GetCodeFromError
static proto int GetCodeFromError(int errorCode)
Returns the code of the error.

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

◆ GetErrorHex()

static proto owned string GetErrorHex ( int errorCode )

staticprivate

Returns a formatted string of the error code.

Parameters

errorCode int The full error code

Returns: string A formatted string of the error code
string formattedCode = ErrorModuleHandler.GetErrorHex( 196607 );

Print( formattedCode );

>> formattedCode = '0x0002FFFF'

ErrorModuleHandler::GetErrorHex
static proto owned string GetErrorHex(int errorCode)
Returns a formatted string of the error code.

Referenced by GetLastClientMessage(), GetLastServerMessage(), GetProperties(), ErrorHandlerModule::GetSimpleMessage(), HandleError(), ErrorHandlerModule::OnErrorThrown(), and OnErrorThrown().

◆ GetErrorModules()

static proto void GetErrorModules ( notnull out array< ErrorHandlerModule > errorModules )

staticprivate

Referenced by OnEvent().

◆ GetInstance()

static proto native ErrorModuleHandler GetInstance ( )

staticprivate

Gets the EMH Instance.

Returns: ErrorModuleHandler The ErrorModuleHandler Instance

Referenced by CGame::OnEvent(), and EnProfilerTests::TestFuncCountData().

◆ GetLastClientMessage()

static proto string GetLastClientMessage	(	ErrorCategory	category,
		int	code
	)

staticprivate

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

Parameters

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

◆ GetLastClientMessageByCode()

static proto string GetLastClientMessageByCode ( int errorCode )

staticprivate

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

Parameters

errorCode int The full error code

Returns: string The message which would appear on Client

◆ GetLastServerMessage()

static proto string GetLastServerMessage	(	ErrorCategory	category,
		int	code
	)

staticprivate

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

Parameters

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

◆ GetLastServerMessageByCode()

static proto string GetLastServerMessageByCode ( int errorCode )

staticprivate

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

Parameters

errorCode int The full error code

Returns: string The message which would appear on Server

◆ GetServerMessage()

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

staticprivate

Gets the Server Message for specified error.

Parameters

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

◆ GetServerMessageByCode()

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

staticprivate

Gets the Server Message for specified error.

Parameters

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

◆ Init()

private void Init ( )

inlineprivate

Gets called shortly after creation of ErrorModuleHandler.

References ConnectErrorScriptModule(), g_Game, and SafeAddModule().

◆ OnEvent()

void OnEvent	(	EventType	eventTypeId,
		Param	params
	)

inlineprivate

is called by DayZGame to pass Events.

References GetErrorModules().

Referenced by CGame::OnEvent().

◆ RemoveModule()

static proto bool RemoveModule ( ErrorCategory category )

staticprivate

Removes a module handler from the ErrorModuleHandler.

Parameters

category ErrorCategory Category the module is for

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

Referenced by SafeRemoveModule(), and SafeRemoveModule().

◆ SafeAddModule()

void SafeAddModule ( notnull ErrorHandlerModule errorModule )

inlineprivate

Wrapper for AddModule to give feedback whether it succeeded or not.

Parameters

errorModule ErrorHandlerModule The ErrorHandlerModule to add

References AddModule(), and Error().

Referenced by Init().

◆ SafeRemoveModule() [1/2]

void SafeRemoveModule ( ErrorCategory category )

inlineprivate

Wrapper for RemoveModule to give feedback whether it succeeded or not.

Parameters

category ErrorCategory Category to remove

References Error(), and RemoveModule().

◆ SafeRemoveModule() [2/2]

void SafeRemoveModule ( notnull ErrorHandlerModule errorModule )

inlineprivate

Wrapper for RemoveModule to give feedback whether it succeeded or not.

Parameters

errorModule ErrorHandlerModule The ErrorHandlerModule to add

References Error(), and RemoveModule().

◆ ThrowError()

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

staticprivate

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

Parameters

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

ErrorModuleHandler::ThrowError
static proto int ThrowError(ErrorCategory category, int code, string additionalInfo="")
Creates and throws the error code, sending it to the handler of the category.

Referenced by CGame::TryConnect().

◆ ThrowErrorCode()

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

staticprivate

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

Parameters

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

ErrorModuleHandler::ThrowErrorCode
static proto int ThrowErrorCode(int errorCode, string additionalInfo="")
Throws the error code and sends it to the handler of the category.

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

P:/scripts/3_Game/Global/ErrorModuleHandler/ErrorModuleHandler.c

DayZ Scripts PC Stable Documentation

Private Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ AddModule()

◆ CreateError()

◆ GetCategoryFromError()

◆ GetClientMessage()

◆ GetClientMessageByCode()

◆ GetCodeFromError()

◆ GetErrorHex()

◆ GetErrorModules()

◆ GetInstance()

◆ GetLastClientMessage()

◆ GetLastClientMessageByCode()

◆ GetLastServerMessage()

◆ GetLastServerMessageByCode()

◆ GetServerMessage()

◆ GetServerMessageByCode()

◆ Init()

◆ OnEvent()

◆ RemoveModule()

◆ SafeAddModule()

◆ SafeRemoveModule() [1/2]

◆ SafeRemoveModule() [2/2]

◆ ThrowError()

◆ ThrowErrorCode()