ScreenMessages Class Reference

Inheritance diagram for ScreenMessages:

Static Public Member Functions
static ScreenMessage	PostScreenMessage (string message, float duration, ScreenMessageStyle style, bool persist)
	Posts a Screen Message to the screen. More...
static ScreenMessage	PostScreenMessage (string message, float duration, ScreenMessageStyle style, Color color)
	Posts a Screen Message to the screen. More...
static ScreenMessage	PostScreenMessage (string message, float duration, ScreenMessageStyle style)
	Posts a Screen Message to the screen. More...
static ScreenMessage	PostScreenMessage (string message, float duration, ScreenMessageStyle style, ScreenMessage msg)
	Posts a Screen Message to the screen. More...
static ScreenMessage	PostScreenMessage (string message, float duration, bool persist)
	Posts a Screen Message to the screen. The message will appear in the upper center area of the screen. More...
static ScreenMessage	PostScreenMessage (string message, float duration)
	Posts a Screen Message to the screen. The message will appear in the upper center area of the screen. More...
static ScreenMessage	PostScreenMessage (string message, bool persist)
	Posts a Screen Message to the screen. The message will appear in the upper center area of the screen for 3 seconds. More...
static ScreenMessage	PostScreenMessage (string message)
	Posts a Screen Message to the screen. The message will appear in the upper center area of the screen for 3 seconds. More...
static ScreenMessage	PostScreenMessage (string message, ScreenMessage msg)
	Posts a Screen Message to the screen. Can be used to update an existing message. Or will create a new one if the existing message is not found. More...
static ScreenMessage	PostScreenMessage (ScreenMessage msg)
	Posts a Screen Message to the screen. Can be used to re-post a previous message. Or will create a new one if the existing message is not found. More...
static void	RemoveMessage (ScreenMessage msg)
	Remove a ScreenMessage from the screen. More...

Public Attributes
Color	defaultColor = Color.white
RectTransform	kerbalEva
Gradient	lifetimeGradient
RectTransform	lowerCenter
ScreenMessagesText	textPrefab
RectTransform	upperCenter
RectTransform	upperLeft
RectTransform	upperRight
bool	useLifetimeGradient = false

Static Protected Member Functions
static void	SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
	Sends user a text message via messaging system More...

Properties
List< ScreenMessage >	ActiveMessages [get, set]
static ScreenMessages	Instance [get, set]

Member Function Documentation

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration, ScreenMessageStyle  style, bool  persist  )

inlinestatic

Posts a Screen Message to the screen.

Parameters

message	The message text
duration	How long to show the message on the screen
style	The ScreenMessageStyle which indicates which area of the screen the message will appear in
persist	If true will also post the message to the SMS App

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration, ScreenMessageStyle  style, Color  color  )

inlinestatic

Posts a Screen Message to the screen.

Parameters

message	The message text
duration	How long to show the message on the screen
style	The ScreenMessageStyle which indicates which area of the screen the message will appear in
color	The color this screenmessage text will be

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration, ScreenMessageStyle  style  )

inlinestatic

Posts a Screen Message to the screen.

Parameters

message	The message text
duration	How long to show the message on the screen
style	The ScreenMessageStyle which indicates which area of the screen the message will appear in

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration, ScreenMessageStyle  style, ScreenMessage  msg  )

inlinestatic

Posts a Screen Message to the screen.

Parameters

message	The message text
duration	How long to show the message on the screen
style	The ScreenMessageStyle which indicates which area of the screen the message will appear in
msg	The ScreenMessage to update if found

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration, bool  persist  )

inlinestatic

Posts a Screen Message to the screen. The message will appear in the upper center area of the screen.

Parameters

message	The message text
duration	How long to show the message on the screen
persist	If true will also post the message to the SMS App

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, float  duration  )

inlinestatic

Posts a Screen Message to the screen. The message will appear in the upper center area of the screen.

Parameters

message	The message text
duration	How long to show the message on the screen

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, bool  persist  )

inlinestatic

Posts a Screen Message to the screen. The message will appear in the upper center area of the screen for 3 seconds.

Parameters

message

The message text

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message )

inlinestatic

Posts a Screen Message to the screen. The message will appear in the upper center area of the screen for 3 seconds.

Parameters

message

The message text

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( string  message, ScreenMessage  msg  )

inlinestatic

Posts a Screen Message to the screen. Can be used to update an existing message. Or will create a new one if the existing message is not found.

Parameters

message	The message text
msg	The ScreenMessage to update if found

Returns

The generated ScreenMessage

static ScreenMessage ScreenMessages.PostScreenMessage ( ScreenMessage  msg )

inlinestatic

Posts a Screen Message to the screen. Can be used to re-post a previous message. Or will create a new one if the existing message is not found.

Parameters

msg	The ScreenMessage to re-post if not found

Returns

The generated ScreenMessage

static void ScreenMessages.RemoveMessage ( ScreenMessage  msg )

inlinestatic

Remove a ScreenMessage from the screen.

Parameters

msg	the ScreenMessage to remove

static void ScreenMessages.SendStateMessage ( string  title, string  message, MessageSystemButton.MessageButtonColor  color, MessageSystemButton.ButtonIcons  icon  )

inlinestaticprotected

Sends user a text message via messaging system

Member Data Documentation

Color ScreenMessages.defaultColor = Color.white

RectTransform ScreenMessages.kerbalEva

Gradient ScreenMessages.lifetimeGradient

RectTransform ScreenMessages.lowerCenter

ScreenMessagesText ScreenMessages.textPrefab

RectTransform ScreenMessages.upperCenter

RectTransform ScreenMessages.upperLeft

RectTransform ScreenMessages.upperRight

bool ScreenMessages.useLifetimeGradient = false

Property Documentation

List<ScreenMessage> ScreenMessages.ActiveMessages

getset

ScreenMessages ScreenMessages.Instance

staticgetset

---

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

• KSP/Assets/_UI5/Generic/Scripts/ScreenMessages.cs