ErrorHandlerModule Class Reference

Definition and API of an ErrorHandlerModule - Do not insert any logic here! (as this class is not moddable) More...

Private Member Functions
proto native ErrorCategory	GetCategory ()
	Returns the category the module handles.
proto native void	SetCategory (ErrorCategory category)
	Set the category the module handles.
protected void	OnErrorThrown (int errorCode, owned string additionalInfo="")
	Event that gets triggered when an error of the owned category is thrown.
string	GetClientMessage (int errorCode, string additionalInfo="")
	Retrieve the message shown on Client.
string	GetLastClientMessage (int errorCode)
	Retrieve the message shown on Client.
string	GetServerMessage (int errorCode, string additionalInfo="")
	Retrieve the message shown on Server.
string	GetLastServerMessage (int errorCode)
	Retrieve the message shown on Server.
string	GetSimpleMessage (int errorCode, string additionalInfo="")
	Simple message of just code and info.
void	OnEvent (EventType eventTypeId, Param params)
	Event called by ErrorModuleHandler.

Detailed Description

Definition and API of an ErrorHandlerModule - Do not insert any logic here! (as this class is not moddable)

Member Function Documentation

GetCategory()

proto native ErrorCategory GetCategory ( )

private

Returns the category the module handles.

GetClientMessage()

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

inlineprivate

Retrieve the message shown on Client.

References GetSimpleMessage().

Referenced by GetLastClientMessage().

GetLastClientMessage()

string GetLastClientMessage ( int  errorCode )

inlineprivate

Retrieve the message shown on Client.

References GetSimpleMessage().

GetLastServerMessage()

string GetLastServerMessage ( int  errorCode )

inlineprivate

Retrieve the message shown on Server.

References GetSimpleMessage().

GetServerMessage()

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

inlineprivate

Retrieve the message shown on Server.

References GetSimpleMessage().

Referenced by GetLastServerMessage().

GetSimpleMessage()

string GetSimpleMessage ( int  errorCode, string  additionalInfo = ""  )

inlineprivate

Simple message of just code and info.

References string::Format(), and ErrorModuleHandler::GetErrorHex().

Referenced by GetClientMessage(), GetLastClientMessage(), GetLastServerMessage(), and GetServerMessage().

OnErrorThrown()

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

inlineprivate

Event that gets triggered when an error of the owned category is thrown.

References ErrorModuleHandler::GetErrorHex(), and Print().

OnEvent()

void OnEvent ( EventType  eventTypeId, Param  params  )

inlineprivate

Event called by ErrorModuleHandler.

SetCategory()

proto native void SetCategory ( ErrorCategory  category )

private

Set the category the module handles.

---

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

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