UTGame.UTUIScene_MessageBox

Extends

UTUIScene

Modifiers

native ( UI )

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved. Generic Message Box Scene for UT3

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIScene_MessageBox

Direct Known Subclasses:

UTUIScene_ConnectionStatus, UTUIScene_InputBox

Delegates Summary
		OnClosed ()
	bool	OnMBInputKey (const out InputEventParameters EventParms)
		OnSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Functions Summary
		BeginHide ()
		BeginShow ()
		Close (optional bool bSimulateCancel, optional int PlayerIndex=GetBestPlayerIndex() ))
		Display (string Message, optional string Title="", optional delegate<OnSelection> InSelectionDelegate, optional int InDefaultOptionIdx=INDEX_NONE))
		DisplayAcceptBox (string Message, optional string Title="", optional delegate<OnSelection> InSelectionDelegate))
		DisplayAcceptCancelBox (string Message, optional string Title="", optional delegate<OnSelection> InSelectionDelegate))
		DisplayCancelBox (string Message, optional string Title="", optional delegate<OnSelection> InSelectionDelegate))
		DisplayModalBox (string Message, optional string Title="", optional float InMinDisplayTime=2.0f))
	int	FindCancelButtonIndex (optional string CancelButtonMarkupString ))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
		Initialized ()))
		OnHideComplete ()))
	bool	OnOptionButton_Clicked (UIScreenObject EventObject, int PlayerIndex))
		OnShowComplete ()))
		OptionSelected (int OptionIdx, int PlayerIndex))
		PostInitialize ()))
		SetMessage (string NewMessage))
		SetPotentialOptionKeyMappings (array<PotentialOptionKeys> InPotentialOptionKeyMappings))
		SetPotentialOptions (array<string> InPotentialOptions, optional array<PotentialOptionKeys> InPotentialOptionKeyMappings))
		SetSelectionDelegate (delegate InSelectionDelegate ))
		SetTitle (string NewTitle))
		SetupButtonBar ()))

CANCEL_BUTTON_MARKUP_STRING Source code

MESSAGEBOX_MAX_POSSIBLE_OPTIONS Source code

BackgroundImage Source code

Reference to the owning widget that has all of the content of the message box scene.

bFullyVisible Source code

Whether or not the message box is fully visible.

bHideOnNextTick Source code

Flag that lets the dialog know it should hide itself.

ButtonBar Source code

References to the scene's buttonbar.

DefaultOptionIdx Source code

Index of the option that is selected by default, valid for PC only.

DisplayTime Source code

The time the message box was fully displayed.

FadeDirection Source code

Direction we are currently fading, positive is fade in, negative is fade out, 0 is not fading.

FadeDuration Source code

How long to take to display/hide the message box.

FadeStartTime Source code

Time fading started.

MessageLabel Source code

Message box message.

MinimumDisplayTime Source code

The minimum amount of time to display modal message boxes for.

PotentialOptionKeyMappings Source code

PotentialOptions Source code

Array of potential options markup.

PreviouslySelectedOption Source code

Stores which option the user selected.

ScrollWindow Source code

Reference to the scroll window that holds the message label.

SelectingPlayer Source code

Index of the player that selected the option.

TitleLabel Source code

Message box title markup.

UTUIScene_MessageBox

bRepositionMessageToCenter Source code

Whether you want the message box's dialog and title to position itself to the center of the screen or not.

PotentialOptionKeys Source code

Arrays of key's that trigger each potential option.

OnClosed Source code

Delegate called after the message box has been competely closed.

OnMBInputKey Source code

Delegate to trap any input to the message box.

OnSelection Source code

The user has made a selection of the choices available to them.

BeginHide Source code

Starts hiding the message box.

BeginShow Source code

Starts showing the message box.

Close Source code

Closes the message box, used for modal message boxes.
@param bSimulateCancel specify TRUE to generate a cancel button press event; otherwise, whichever button is in the last slot (e.g. PotentialOptions[0]) will appear to have been pressed).
@param PlayerIndex the index of the player that generated the close event.

Display Source code

Displays the message box.
@param Message Message for the message box. Should be datastore markup.
@param Title Title for the message box. Should be datastore markup.
@param InSelectionDelegate Delegate to call when the user dismisses the message box.

DisplayAcceptBox Source code

Displays a message box that has the default button layout; useful when you may be reusing the same scene instance
@param Message Message for the message box. Should be datastore markup.
@param Title Title for the message box. Should be datastore markup.
@param InSelectionDelegate Delegate to call when the user dismisses the message box.

DisplayAcceptCancelBox Source code

Displays a message box that has an accept and cancel button.
@param Message Message for the message box. Should be datastore markup.
@param Title Title for the message box. Should be datastore markup.
@param InSelectionDelegate Delegate to call when the user dismisses the message box.

DisplayCancelBox Source code

Displays a message box that has a cancel button only.
@param Message Message for the message box. Should be datastore markup.
@param Title Title for the message box. Should be datastore markup.
@param InSelectionDelegate Delegate to call when the user dismisses the message box.

DisplayModalBox Source code

Displays a message box that has no buttons and must be closed by the scene that opened it.

FindCancelButtonIndex Source code

Determines the index of the button corresponding to the cancel button.
@param CancelButtonMarkupString if a custom markup string was used for the cancel button, it can be specified here; otherwise the default markup string for the cancel button is used.
@return the index of the button used to cancel this dialog, or INDEX_NONE if a cancel button wasn't found.

HandleInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

Initialized Source code

OnHideComplete Source code

Called when the dialog is finished hiding itself.

OnOptionButton_Clicked Source code

Callback for the OnClicked event.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.
@return return TRUE to prevent the kismet OnClick event from firing.

OnShowComplete Source code

Called when the dialog has finished showing itself.

OptionSelected Source code

Called when a user has chosen one of the possible options available to them. Begins hiding the dialog and calls the On
@param OptionIdx Index of the selection option.
@param PlayerIndex Index of the player that selected the option.

PostInitialize Source code

Sets delegates for the scene.

SetMessage Source code

Sets the current message for this messagebox.
@param NewMessage New message for the messagebox.

SetPotentialOptionKeyMappings Source code

Sets the potential option key mappings for a message box, usually this can be left to defaults.
@param InPotentialOptions Potential options the user has to choose from.
@param InPotentialOptionsKeyMappings Button keys that map to the options specified, usually this can be left to defaults.

SetPotentialOptions Source code

Sets the potential options for a message box.
@param InPotentialOptions Potential options the user has to choose from.
@param InPotentialOptionsKeyMappings Button keys that map to the options specified, usually this can be left to defaults.

SetSelectionDelegate Source code

Wrapper for setting the OnSelection delegate.

SetTitle Source code

Changes the title for this messagebox.
@param NewTitle the new title for the message box

SetupButtonBar Source code

Sets up the buttons that should be visible in the bar across the bottom of the scene.

defaultproperties
{
   bRepositionMessageToCenter=True
   bRenderParentScenes=True
   bPauseGameWhileActive=False
   SceneRenderMode=SPLITRENDER_Fullscreen
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIComp_Event'
      DisabledEventAliases(0)="CloseScene"
      Name="WidgetEventComponent"
      ObjectArchetype=UIComp_Event'Engine.Default__UIComp_Event'
   End Object
   EventProvider=WidgetEventComponent
   __OnRawInputKey__Delegate=Default__UTUIScene_MessageBox.HandleInputKey
   Name="Default__UTUIScene_MessageBox"
   ObjectArchetype=UTUIScene'UTGame.Default__UTUIScene'
}