MessageWindow Class

A pre-made Window for showing general game messages.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Kit.UIWindow
            Kit.UI.MessageMessageWindow

Namespace: Kit.UI.Message
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0

Syntax

Copy

public class MessageWindow : Window

Request Example View Source

The MessageWindow type exposes the following members.

Properties

	Name	Description
	Data	(Overrides WindowData.)
	MessageInfo	Set or return the display data for this message.

Top

Methods

	Name	Description
	Refresh	(Overrides WindowRefresh.)
	Show(String, String, String, MessageType, MessageButtons, String, Action, Action, Action, Action)	Show a message window.
	Show(MessageWindow, String, String, MessageType, MessageButtons, String, Action, Action, Action, Action)	Show a message window.

Top

Fields

	Name	Description
	AlertSprite	The icon to use for alerts.
	Buttons	References to three Buttons to use for message options.
	ButtonTexts	References to three Texts to that go with the buttons.
	CloseButton	Reference to the Button that closes the message window.
	IconImage	The Image to use for showing the icon.
	InfoSprite	The icon to use for info-boxes.
	MessageText	The Text to use for showing the message.
	QuestionSprite	The icon to use for questions.
	SubtitleSeparator	The object associated with sub-title (optional). Gets hidden if there isn't a subtitle in the message.
	SubtitleText	The Text to use for showing sub-title (optional).
	TitleText	The Text to use for showing title.

Top

Extension Methods

	Name	Description
	Destroy	Destroy the object. (Defined by UnityObjectExtensions.)
	Disable	Set the enabled property to . (Defined by BehaviourExtensions.)
	Enable	Set the enabled property to . (Defined by BehaviourExtensions.)
	GetBounds	Returns the bounds of the Component. (Defined by ComponentExtensions.)
	IsPrefab	Returns whether the Component is a part of a prefab. (Defined by ComponentExtensions.)

Top

Examples

Copy

MessageWindow.Show(windowPrefab,
        "Quit?", "Are you sure you want to quit the game?",
        MessageType.Question, MessageButtons.YesNo,
        yesAction: Application.Quit);

Reference

Kit.UI.Message Namespace