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

Classes

class  Message
 

Public Member Functions

void AddMessage (Message message, bool animate=true)
 
override void Awake ()
 
void DiscardMessage (MessageSystemButton btn)
 
void DiscardSelected ()
 
List< MessageFindMessages (Func< Message, bool > where)
 
void LoadMessages (Game game)
 
void LoadMessages (ConfigNode gameNode)
 
void OnClick (MessageSystemButton button)
 
void OnRightClick (MessageSystemButton button)
 
void Resize ()
 Resizes the app to fit messages. More...
 
void UpdateLauncherButtonCount ()
 
void UpdateLauncherButtonPlayAnim ()
 
void UpdateLauncherButtonStopAnim ()
 
- Public Member Functions inherited from KSP.UI.Screens.UIApp
void ForceAddToAppLauncher ()
 

Public Attributes

RectTransform anchor
 
MessageSystemButton buttonPrefab
 
TMPro.TextMeshProUGUI counterText
 
UIList listResizer
 
int maxShowingMessages = 5
 
MessageSystemPopup popupPrefab
 
- Public Attributes inherited from KSP.UI.Screens.UIApp
Animator appLauncherAnim
 
Texture appLauncherIcon
 

Protected Member Functions

override void DisplayApp ()
 
override
ApplicationLauncher.AppScenes 
GetAppScenes ()
 
override Vector3 GetAppScreenPos (Vector3 defaultAnchorPos)
 
override void HideApp ()
 
override bool OnAppAboutToStart ()
 
override void OnAppDestroy ()
 
override void OnAppInitialized ()
 
override void Reposition ()
 
- Protected Member Functions inherited from KSP.UI.Screens.UIApp
void MouseInput_PointerEnter (PointerEventData eventData)
 
void MouseInput_PointerExit (PointerEventData eventData)
 
virtual void OnAppStarted ()
 

Properties

static MessageSystem Instance [get, set]
 
static bool Ready [get, set]
 
- Properties inherited from KSP.UI.Screens.UIApp
bool appIsLive [get, set]
 
ApplicationLauncherButton appLauncherButton [get, set]
 
bool hover [get, set]
 
bool IsShowing [get]
 Is the App window visible on the screen More...
 
bool pinned [get, set]
 

Additional Inherited Members

- Protected Attributes inherited from KSP.UI.Screens.UIApp
int AppStartFrameDelay = 5
 The amount of frames to delay OnAppAboutToStart after the applauncher reports to be ready. Defaults to 5, should be enough to ensure all flight and scenario modules are loaded. Increase if necessary. More...
 
Callback defaultCallback = delegate { }
 
bool enableMutuallyExclusive = true
 
bool enableOnHover = true
 

Member Function Documentation

void KSP.UI.Screens.MessageSystem.AddMessage ( Message  message,
bool  animate = true 
)
inline
override void KSP.UI.Screens.MessageSystem.Awake ( )
inlinevirtual

Reimplemented from KSP.UI.Screens.UIApp.

void KSP.UI.Screens.MessageSystem.DiscardMessage ( MessageSystemButton  btn)
inline
void KSP.UI.Screens.MessageSystem.DiscardSelected ( )
inline
override void KSP.UI.Screens.MessageSystem.DisplayApp ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

List<Message> KSP.UI.Screens.MessageSystem.FindMessages ( Func< Message, bool >  where)
inline

< This will search for messages matching a particular string, allows things to modify them.

override ApplicationLauncher.AppScenes KSP.UI.Screens.MessageSystem.GetAppScenes ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

override Vector3 KSP.UI.Screens.MessageSystem.GetAppScreenPos ( Vector3  defaultAnchorPos)
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

override void KSP.UI.Screens.MessageSystem.HideApp ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

void KSP.UI.Screens.MessageSystem.LoadMessages ( Game  game)
inline
void KSP.UI.Screens.MessageSystem.LoadMessages ( ConfigNode  gameNode)
inline
override bool KSP.UI.Screens.MessageSystem.OnAppAboutToStart ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

override void KSP.UI.Screens.MessageSystem.OnAppDestroy ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

override void KSP.UI.Screens.MessageSystem.OnAppInitialized ( )
inlineprotectedvirtual

Implements KSP.UI.Screens.UIApp.

void KSP.UI.Screens.MessageSystem.OnClick ( MessageSystemButton  button)
inline
void KSP.UI.Screens.MessageSystem.OnRightClick ( MessageSystemButton  button)
inline
override void KSP.UI.Screens.MessageSystem.Reposition ( )
inlineprotectedvirtual

Reimplemented from KSP.UI.Screens.UIApp.

void KSP.UI.Screens.MessageSystem.Resize ( )
inline

Resizes the app to fit messages.

void KSP.UI.Screens.MessageSystem.UpdateLauncherButtonCount ( )
inline
void KSP.UI.Screens.MessageSystem.UpdateLauncherButtonPlayAnim ( )
inline
void KSP.UI.Screens.MessageSystem.UpdateLauncherButtonStopAnim ( )
inline

Member Data Documentation

RectTransform KSP.UI.Screens.MessageSystem.anchor
MessageSystemButton KSP.UI.Screens.MessageSystem.buttonPrefab
TMPro.TextMeshProUGUI KSP.UI.Screens.MessageSystem.counterText
UIList KSP.UI.Screens.MessageSystem.listResizer
int KSP.UI.Screens.MessageSystem.maxShowingMessages = 5
MessageSystemPopup KSP.UI.Screens.MessageSystem.popupPrefab

Property Documentation

MessageSystem KSP.UI.Screens.MessageSystem.Instance
staticgetset
bool KSP.UI.Screens.MessageSystem.Ready
staticgetset

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