errorproperties.c

Go to the documentation of this file.

class ErrorProperties
{
    const string EP_HEADER_FORMAT_STRING = "%1 (%2)"; 
    const string EP_MESSAGE_FORMAT_STRING = "%1\n(%2)"; 
    
    protected string m_Message; 
    protected string m_ServerMessage; 
    
    void ErrorProperties(string message, string serverMessage)
    {
        m_Message = message;
        m_ServerMessage = serverMessage;
    }
        
    void HandleError(int errorCode, string additionalInfo = "") {}
    
    string GetClientMessage(string additionalInfo = "")
    {
        if ( additionalInfo != "" )
            return string.Format(EP_MESSAGE_FORMAT_STRING, m_Message, additionalInfo);
        else
            return m_Message;
    }
    
    string GetServerMessage(string additionalInfo = "")
    {
        if ( additionalInfo != "" )
            return string.Format(EP_MESSAGE_FORMAT_STRING, m_ServerMessage, additionalInfo);
        else
            return m_ServerMessage;
    }
}
 
class DialogueErrorProperties : ErrorProperties
{
    protected string m_Header;
    protected int m_DialogButtonType;
    protected int m_DefaultButton;
    protected int m_DialogMeaningType;
    protected UIScriptedMenu m_Handler;
    protected bool m_DisplayAdditionalInfo;
    
    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)
    {
        m_Header = header;
        m_DialogButtonType = dialogButtonType;
        m_DefaultButton = defaultButton;
        m_DialogMeaningType = dialogMeaningType;
        m_Handler = handler;
        m_DisplayAdditionalInfo = displayAdditionalInfo;
    }
    
    override void HandleError(int errorCode, string additionalInfo = "")
    {
#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
    }
    
    string GetHeader() { return m_Message; }
    int GetDialogButtonType() { return m_DialogButtonType; }
    int GetDefaultButton() { return m_DefaultButton; }
    int GetDialogMeaningType() { return m_DialogMeaningType; }
    UIScriptedMenu GetHandler() { return m_Handler; }
}