Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
KSP.UI.Screens.MessageSystem.Message Class Reference

Public Member Functions

override bool Equals (System.Object obj)
 
bool Equals (Message m)
 
override int GetHashCode ()
 
string GetRichTextMessageTitle (string messageTitle, bool IsRead=false)
 Adds color and bold rich text formatting to a message string. More...
 
void Instantiate ()
 Will Instantiate the UI elements for the message if they haven't been already. More...
 
 Message (string messageTitle, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
 Will create a new Message Item and Instantiate it's UI elements if the SMS App is ready. If the App is not ready will add the message to the queue to display it when the App is ready. More...
 

Public Attributes

UIListItem advancedListItem
 
TMPro.TextMeshProUGUI advancedListItemText
 
MessageSystemButton button
 
MessageSystemButton.MessageButtonColor color
 
MessageSystemButton.ButtonIcons icon
 
bool IsRead
 
string message
 
string messageTitle
 

Properties

bool instantiated [get, set]
 

Constructor & Destructor Documentation

KSP.UI.Screens.MessageSystem.Message.Message ( string  messageTitle,
string  message,
MessageSystemButton.MessageButtonColor  color,
MessageSystemButton.ButtonIcons  icon 
)
inline

Will create a new Message Item and Instantiate it's UI elements if the SMS App is ready. If the App is not ready will add the message to the queue to display it when the App is ready.

Parameters
messageTitleThe Title of the message
messageThe content of the message
colorThe color of the Message Icon
iconThe Icon to use

Member Function Documentation

override bool KSP.UI.Screens.MessageSystem.Message.Equals ( System.Object  obj)
inline

< Return true if the fields match:

bool KSP.UI.Screens.MessageSystem.Message.Equals ( Message  m)
inline

< Return true if the fields match:

override int KSP.UI.Screens.MessageSystem.Message.GetHashCode ( )
inline
string KSP.UI.Screens.MessageSystem.Message.GetRichTextMessageTitle ( string  messageTitle,
bool  IsRead = false 
)
inline

Adds color and bold rich text formatting to a message string.

Parameters
messageTitleThe message string to format
IsReadIf true, Bold highlighting will be added to the string
Returns
void KSP.UI.Screens.MessageSystem.Message.Instantiate ( )
inline

Will Instantiate the UI elements for the message if they haven't been already.

Member Data Documentation

UIListItem KSP.UI.Screens.MessageSystem.Message.advancedListItem
TMPro.TextMeshProUGUI KSP.UI.Screens.MessageSystem.Message.advancedListItemText
MessageSystemButton KSP.UI.Screens.MessageSystem.Message.button
MessageSystemButton.MessageButtonColor KSP.UI.Screens.MessageSystem.Message.color
MessageSystemButton.ButtonIcons KSP.UI.Screens.MessageSystem.Message.icon
bool KSP.UI.Screens.MessageSystem.Message.IsRead
string KSP.UI.Screens.MessageSystem.Message.message
string KSP.UI.Screens.MessageSystem.Message.messageTitle

Property Documentation

bool KSP.UI.Screens.MessageSystem.Message.instantiated
getset

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