Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Static Public Member Functions | Public Attributes | List of all members
Expansions.Missions.Runtime.MessageNodeDialog Class Reference
Inheritance diagram for Expansions.Missions.Runtime.MessageNodeDialog:

Static Public Member Functions

static MessageNodeDialog Spawn (string headerText, string nodeText, string instructorPrefabName, string continueBtnText, Callback continueCallback=null, int textAreaSize=135, ActionDialogMessage.DialogMessageArea msgArea=ActionDialogMessage.DialogMessageArea.Center, bool autoClose=false, int autoCloseTimeout=20, bool autoGrowDialogHeight=false, string instructorName="")
 Spawn a MessageNodeDialog More...
 

Public Attributes

bool modal = false
 If true dialog is modal. More...
 

Member Function Documentation

static MessageNodeDialog Expansions.Missions.Runtime.MessageNodeDialog.Spawn ( string  headerText,
string  nodeText,
string  instructorPrefabName,
string  continueBtnText,
Callback  continueCallback = null,
int  textAreaSize = 135,
ActionDialogMessage.DialogMessageArea  msgArea = ActionDialogMessage.DialogMessageArea.Center,
bool  autoClose = false,
int  autoCloseTimeout = 20,
bool  autoGrowDialogHeight = false,
string  instructorName = "" 
)
inlinestatic

Spawn a MessageNodeDialog

Parameters
headerTextThe text that appears at the top of the dialog
nodeTextThe text that appears in the scroll box view of the dialog (the message for the player)
instructorPrefabNameThe Instructor prefab name to show in the left side of the dialog
continueBtnTextThe text to appear on the button at the bottom of the dialog
continueCallbackA callback when the button on the dialog is pressed
msgAreaThe area the dialog is to be displayed on screen
autoCloseSet to true to automatically close the dialog after the autoclose time period
autoCloseTimeoutThe time in seconds before automatically closing the dialog, if autoClose is true
autoGrowDialogHeightIf set to true will set the dialog height to the preferred size for the nodeText, but won't exceed the screen height.
instructorNameThe name of the Instructor - If blank will use the name set in the prefab that is passed in. If set to not empty/null will override the name set in the prefab.
Returns
The Spawned MessageNodeDialog object

Member Data Documentation

bool Expansions.Missions.Runtime.MessageNodeDialog.modal = false

If true dialog is modal.


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