ErrorProperties.c File Reference

Go to the source code of this file.

Classes
class	ErrorProperties
	Class which holds the properties and handling of an error. More...

Functions
void	DialogueErrorProperties (string message, string serverMessage, string header, UIScriptedMenu handler=null, int dialogButtonType=DBT_OK, int defaultButton=DBB_OK, int dialogMeaningType=DMT_EXCLAMATION, bool displayAdditionalInfo=true)
override void	HandleError (int errorCode, string additionalInfo="")
string	GetHeader ()
int	GetDialogButtonType ()
int	GetDefaultButton ()
int	GetDialogMeaningType ()
UIScriptedMenu	GetHandler ()

Variables
class ErrorProperties	m_Header
	Error which shows a generic Dialogue UI.
int	m_DialogButtonType
int	m_DefaultButton
int	m_DialogMeaningType
UIScriptedMenu	m_Handler
bool	m_DisplayAdditionalInfo

Function Documentation

DialogueErrorProperties()

void DialogueErrorProperties ( string message, string serverMessage, string header, UIScriptedMenu handler = null, int dialogButtonType = DBT_OK, int defaultButton = DBB_OK, int dialogMeaningType = DMT_EXCLAMATION, bool displayAdditionalInfo = true )

protected

Definition at line 45 of file ErrorProperties.c.

  {
    m_Header = header;
    m_DialogButtonType = dialogButtonType;
    m_DefaultButton = defaultButton;
    m_DialogMeaningType = dialogMeaningType;
    m_Handler = handler;
    m_DisplayAdditionalInfo = displayAdditionalInfo;
  }

References m_DefaultButton, m_DialogButtonType, m_DialogMeaningType, m_DisplayAdditionalInfo, m_Handler, and m_Header.

Referenced by InsertDialogueErrorProperties(), InsertExtendedPrefixDialogueErrorProperties(), InsertExtendedPrefixSplitDialogueErrorProperties(), InsertHeaderDialogueErrorProperties(), InsertPrefixDialogueErrorProperties(), and InsertSplitDialogueErrorProperties().

GetDefaultButton()

int GetDefaultButton ( )

protected

Definition at line 78 of file ErrorProperties.c.

{ return m_DefaultButton; }

References m_DefaultButton.

GetDialogButtonType()

int GetDialogButtonType ( )

protected

Definition at line 77 of file ErrorProperties.c.

{ return m_DialogButtonType; }

References m_DialogButtonType.

GetDialogMeaningType()

int GetDialogMeaningType ( )

protected

Definition at line 79 of file ErrorProperties.c.

{ return m_DialogMeaningType; }

References m_DialogMeaningType.

GetHandler()

UIScriptedMenu GetHandler ( )

protected

Definition at line 80 of file ErrorProperties.c.

{ return m_Handler; }

References m_Handler.

GetHeader()

string GetHeader ( )

protected

Definition at line 76 of file ErrorProperties.c.

{ return m_Message; }

References ErrorProperties::m_Message.

Referenced by AttachmentCategoriesRow::Init().

HandleError()

override void HandleError ( int errorCode, string additionalInfo = "" )

protected

Definition at line 55 of file ErrorProperties.c.

  {
#ifdef NO_GUI
    return; //do not display error if GUI is disabled
#endif
 
#ifdef SERVER
    return;
#else
    string message;
    if (m_DisplayAdditionalInfo && additionalInfo != "")
      message = string.Format(EP_MESSAGE_FORMAT_STRING, m_Message, additionalInfo);
    else
      message = m_Message;
 
    GetGame().GetUIManager().ShowDialog(
      string.Format(EP_HEADER_FORMAT_STRING, m_Header, ErrorModuleHandler.GetErrorHex(errorCode)),
      message, errorCode, m_DialogButtonType, m_DefaultButton, m_DialogMeaningType, m_Handler);
#endif
  }

References ErrorModuleHandler::GetErrorHex(), GetGame(), m_DefaultButton, m_DialogButtonType, m_DialogMeaningType, m_DisplayAdditionalInfo, m_Handler, m_Header, and ErrorProperties::m_Message.

Variable Documentation

m_DefaultButton

int m_DefaultButton

protected

Definition at line 40 of file ErrorProperties.c.

Referenced by DialogueErrorProperties(), GetDefaultButton(), and HandleError().

m_DialogButtonType

int m_DialogButtonType

protected

Definition at line 39 of file ErrorProperties.c.

Referenced by DialogueErrorProperties(), GetDialogButtonType(), and HandleError().

m_DialogMeaningType

int m_DialogMeaningType

protected

Definition at line 41 of file ErrorProperties.c.

Referenced by DialogueErrorProperties(), GetDialogMeaningType(), and HandleError().

m_DisplayAdditionalInfo

bool m_DisplayAdditionalInfo

protected

Definition at line 43 of file ErrorProperties.c.

Referenced by DialogueErrorProperties(), and HandleError().

m_Handler

UIScriptedMenu m_Handler

protected

Definition at line 42 of file ErrorProperties.c.

Referenced by DialogueErrorProperties(), GetHandler(), and HandleError().

m_Header

class ErrorProperties m_Header

Error which shows a generic Dialogue UI.