Engine.UIScene

Extends

UIScreenObject

Modifiers

native ( UIPrivate )

Outermost container for a group of widgets. The relationship between UIScenes and widgets is very similar to the relationship between maps and the actors placed in a map, in that all UIObjects must be contained by a UIScene. Widgets cannot be rendered directly. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene

Direct Known Subclasses:

UIPrefabScene, UIScriptConsoleScene, UTUIScene

Delegates Summary
	EScreenInputMode	GetSceneInputMode ()))
		OnSceneActivated (UIScene ActivatedScene, bool bInitialActivation)
		OnSceneDeactivated (UIScene DeactivatedScene)
		OnTopSceneChanged (UIScene NewTopScene)
	bool	ShouldModulateBackgroundAlpha (out float AlphaModulationPercent)

Functions Summary
		AnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)
		CalculateInputMask ()))
	bool	CloseScene (UIScene SceneToClose, optional bool bSkipKismetNotify, optional bool bSkipAnimation ))
		ForceImmediateSceneUpdate ()
	UIContextMenu	GetActiveContextMenu () con)
	UIToolTip	GetActiveToolTip () con)
	UIContextMenu	GetDefaultContextMenu ()
	UIToolTip	GetDefaultToolTip ()
	UIScene	GetPreviousScene (bool bRequireMatchingPlayerOwner=true)
	SceneDataStore	GetSceneDataStore ()
	WorldInfo	GetWorldInfo ()
	bool	IsSceneActive (optional bool bTopmostScene ) con)
		LoadSceneDataValues ()
		LogCurrentState (int Indent ))
		LogDockingStack ()))
		LogRenderBounds (int Indent ))
		NotifyGameSessionEnded ()))
		NotifyLinkStatusChanged (bool bConnected ))
		NotifyOnlineServiceStatusChanged (EOnlineServerConnectionStatus NewConnectionStatus ))
	UIScene	OpenScene (UIScene SceneToOpen, optional bool bSkipAnimation=false, optional delegate<OnSceneActivated> SceneDelegate=None))
		RebuildDockingStack ()
		ResetMouseBounds ()
	UIDataStore	ResolveDataStore (Name DataStoreTag, optional LocalPlayer InPlayerOwner)
		ResolveScenePositions ()
		SaveSceneDataValues (optional bool bUnbindSubscribers)
		SceneActivated (bool bInitialActivation ))
		SceneCreated (UIScene CreatedScene)
		SceneDeactivated ()))
	bool	SetActiveContextMenu (UIContextMenu NewContextMenu, int PlayerIndex)
	bool	SetActiveToolTip (UIToolTip NewToolTip)
		SetInputMask (byte NewInputMask, optional bool bRecurse=true ))
		SetMouseBounds (EUIWidgetFace Face, optional float Value, optional bool bPixelValue, optional UIObject BoundaryObject)
		SetSceneInputMode (EScreenInputMode NewInputMode)
		SetVisibility (bool bIsVisible ))
		UnbindSubscribers ()

ActiveContextMenu Source code

The context menu currently being displayed or pending display.

ActiveToolTip Source code

The tool tip currently being displayed or pending display.

bIssuedPreRenderCallback Source code

This flag is used to detect whether or not we are updating the scene for the first time, if it is FALSE and update scene is called, then we issue the PreRenderCallback for the scene so widgets have a chance to 'initialize' their positions if desired.

bMouseBoundsSet Source code

Used to determine whether or not the mouse boundaries have been set

bRefreshStringFormatting Source code

Indicates that all strings contained in this scene should be reformatted.

bRefreshWidgetStyles Source code

Indicates that the Widgets displayed need to be redrawn. Once this is set to true, RefreshWidgets() will be called on the next Tick()

bResolvingScenePositions Source code

Indicates that the scene is currently resolving positions for widgets in this scene

bUpdateDockingStack Source code

Indicates that the docking stack should be rebuilt on the next Tick()

bUpdateNavigationLinks Source code

Indicates that the navigation links between the widgets owned by this scene are no longer up to date. Once this is set to true, RebuildNavigationLinks() will be called on the next Tick()

bUpdatePrimitiveUsage Source code

Indicates that the value of bUsesPrimitives is potentially out of date. Normally set when a child is added or removed from the scene. When TRUE, UpdatePrimitiveUsage will be called during the next tick.

bUpdateScenePositions Source code

Indicates that the widgets owned by this scene should re-evaluate their screen positions into absolute pixels on the next Tick().

bUsesPrimitives Source code

Indicates that one or more widgets in this scene are using 3D primitives. Set to TRUE in Activate() if any children of this scene have true for UIScreenObject.bSupports3DPrimitives

CurrentViewportSize Source code

The current aspect ratio for this scene's viewport. For scenes modified in the UI editor, this will be set according to the value of the resolution drop-down control. In game, this will be updated anytime the resolution is changed.

DockingStack Source code

Tracks the docking relationships between widgets owned by this scene. Determines the order in which the UIObject.Position values for each widget in the sceen are evaluated into UIObject.RenderBounds @note: this variable is not serialized (even by GC) as the widget stored in this array will be serialized through the Children array.

InputSubscriptions Source code

Tracks the widgets owned by this scene which are currently eligible to process input. Maps the input keyname to the list of widgets that can process that event. @note: this variable is not serialized (even by GC) as the widgets stored in this map will be serialized through the Children array

LastPlayerIndex Source code

The index for the player that this scene last received input from.

PlayerOwner Source code

The LocalPlayer which owns this scene. NULL if this scene is global (i.e. not owned by a player)

RenderStack Source code

Tracks the order in which widgets were rendered, for purposes of hit detection.

SceneClient Source code

the client for this scene - provides all global state information the scene requires for operation

SceneData Source code

The data store that provides access to this scene's temporary data

SceneLayerRoot Source code

The root of the layer hierarchy for this scene; only loaded in the editor. @todo ronp - temporarily marked this transient until I can address the bugs in layer browser which are holding references to deleted objects (also commented out the creation of the layer browser).

ScenePreview Source code

Preview thumbnail for the generic browser.

StandardContextMenu Source code

This context menu will be used as the context menu for widgets which do not provide their own

StandardToolTip Source code

This tooltip widget will be used to display tooltips for widgets which do not provide custom tool-tip widgets.

Flags

bAlwaysRenderScene Source code

Overrides the setting of bRenderParentScenes for any scenes higher in the stack

bCloseOnLevelChange Source code

Indicates whether the the scene should close itself when the level changes. This is useful for when you have a main menu and want to make certain it is closed when ever you switch to a new level.

bDisableWorldRendering Source code

TRUE to disable world rendering while this scene is active

bDisplayCursor Source code

Controls whether the cursor is shown while this scene is active. Interactive scenes such as menus will generally want this enabled, while non-interactive scenes, such as the HUD generally want it disabled. @todo - this bool may be unnecessary, since we can establish whether a scene should process mouse input by looking at the input events for the widgets of this scene; if any process any of the mouse keys (MouseX, MouseY, RMB, LMB, MMB, etc.) or if the scene can be a drop target, then this scene needs to process mouse input, and should probably display a cursor.... hmmm need to think about this assumption a bit more before implementing this

bEnableSceneDepthTesting Source code

Controls whether depth testing is enabled for this scene. If TRUE then the 2d ui items are depth tested against the 3d ui scene

bEnableScenePostProcessing Source code

Controls whether post-processing is enabled for this scene.

bExemptFromAutoClose Source code

If true this scene is exempted from Auto closuer when a scene above it closes

bFlushPlayerInput Source code

TRUE to flush all player input when this scene is opened.

bMenuLevelRestoresScene Source code

TRUE indicates that this scene can be automatically reopened when the user returns to the main front-end menu.

bPauseGameWhileActive Source code

Indicates whether the game should be paused while this scene is active.

bRenderParentScenes Source code

Controls whether the scenes underneath this scene are rendered.

bRequiresNetwork Source code

TRUE to indicate that this scene requires a valid network connection in order to be opened. If no network connection is available, the scene will be closed.

bRequiresOnlineService Source code

Set to TRUE to indicate that the user must be signed into an online service (for example, Windows live) in order to view this scene. If the user is not signed into an online service, the scene will be closed.

bSaveSceneValuesOnClose Source code

Indicates whether the scene should have its widgets save their values to the datastore on close.

Overlays

DefaultContextMenuClass Source code

The UIContextMenu class to use for the StandardContextMenu

DefaultToolTipClass Source code

The UIToolTip class to use for the StandardToolTip

Sound

SceneClosedCue Source code

this sound is played when this scene is deactivated

SceneOpenedCue Source code

this sound is played when this scene is activated

Splitscreen

SceneInputMode Source code

Controls how this scene responds to input from multiple players.

SceneRenderMode Source code

Controls how this scene will be rendered when split-screen is active.

UIScene

MouseBounds Source code

The boundaries with which to restrict mouse movement in this scene

SceneTag Source code

Semi-unique non-localized name for this scene which is used to reference the scene from unrealscript. For scenes which are gametype specific, each scene may wish to use the same SceneName (for example, if each game had a single scene which represented the HUD for that gametype, all of the HUD scenes might use "HUDScene" as their SceneName, so that the current game's HUD scene can be referenced using "HUDScene" regardless of which type of hud it is)

GetSceneInputMode Source code

Returns the screen input mode configured for this scene

OnSceneActivated Source code

Allows others to be notified when this scene becomes the active scene. Called after other activation methods have been called and after focus has been set on the scene
@param ActivatedScene the scene that was activated
@param bInitialActivation TRUE if this is the first time this scene is being activated; FALSE if this scene has become active as a result of closing another scene or manually moving this scene in the stack.

OnSceneDeactivated Source code

Allows others to be notified when this scene is closed. Called after the SceneDeactivated event, after the scene has published its data to the data stores bound by the widgets of this scene.
@param DeactivatedScene the scene that was deactivated

OnTopSceneChanged Source code

This notification is sent to the topmost scene when a different scene is about to become the topmost scene. Provides scenes with a single location to perform any cleanup for its children.
@note: this delegate is called while this scene is still the top-most scene.
@param NewTopScene the scene that is about to become the topmost scene.

ShouldModulateBackgroundAlpha Source code

Provides scenes with a way to alter the amount of transparency to use when rendering parent scenes.
@param AlphaModulationPercent the value that will be used for modulating the alpha when rendering the scene below this one.
@return TRUE if alpha modulation should be applied when rendering the scene below this one.

AnimEnd Source code

CalculateInputMask Source code

Determines the appropriate PlayerInput mask for this scene, based on the scene's input mode.

CloseScene Source code

Closes the specified scene.
@param SceneToClose Scene that we want to close.
@param bSkipKismetNotify Whether or not to close the kismet notify for the scene.
@param bSkipAnimation Whether or not to skip the close animation for this scene.

ForceImmediateSceneUpdate Source code

Triggers an immediate full scene update (rebuilds docking stacks if necessary, resolves scene positions if necessary, etc.); scene updates normally occur at the beginning of each scene's Tick() so this function should only be called if you must change the positions and/or formatting of a widget in the scene after the scene has been ticked, but before it's been rendered. @note: noexport because this simply calls through to the C++ UpdateScene().

GetActiveContextMenu Source code

Returns the scene's currently active context menu, if there is one.

GetActiveToolTip Source code

Returns the scene's currently active tool-tip, if there is one.

GetDefaultContextMenu Source code

Returns the scene's default context menu widget, creating one if necessary.

GetDefaultToolTip Source code

Returns the scene's default tooltip widget, creating one if necessary.

GetPreviousScene Source code

Returns the scene that is below this one in the scene client's stack of active scenes.
@param bRequireMatchingPlayerOwner TRUE indicates that only a scene that has the same value for PlayerOwner as this scene may be considered the "previous" scene to this one

GetSceneDataStore Source code

Gets the data store for this scene, creating one if necessary.

GetWorldInfo Source code

Returns the current WorldInfo

IsSceneActive Source code

Wrapper for easily determining whether this scene is in the scene client's list of active scenes.
@param bTopmostScene specify TRUE to check whether the scene is also the scene client's topmost scene.

LoadSceneDataValues Source code

Notifies all children that are bound to readable data stores to retrieve their initial value from those data stores.

LogCurrentState Source code

LogDockingStack Source code

LogRenderBounds Source code

NotifyGameSessionEnded Source code

Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.

NotifyLinkStatusChanged Source code

Called when the status of the platform's network connection changes.

NotifyOnlineServiceStatusChanged Source code

Notification that the player's connection to the platform's online service is changed.

OpenScene Source code

Opens a UI Scene given a reference to a scene to open.
@param SceneToOpen Scene that we want to open.
@param bSkipAnimation specify TRUE to indicate that opening animations should be bypassed.
@param SceneDelegate if specified, will be called when the scene has finished opening.

RebuildDockingStack Source code

Clears and rebuilds the complete DockingStack. It is not necessary to manually rebuild the DockingStack when simply adding or removing widgets from the scene, since those types of actions automatically updates the DockingStack.

ResetMouseBounds Source code

Reset the 'MouseBounds' struct to its default values

ResolveDataStore Source code

Find the data store that has the specified tag. If the data store's tag is SCENE_DATASTORE_TAG, the scene's data store is returned, otherwise searches through the global data stores for a data store with a Tag matching the specified name.
@param DataStoreTag A name corresponding to the 'Tag' property of a data store
@param InPlayerOwner The player owner to use for resolving the datastore. If NULL, the scene's playerowner will be used instead.
@return a pointer to the data store that has a Tag corresponding to DataStoreTag, or NULL if no data were found with that tag.

ResolveScenePositions Source code

Iterates through the scene's DockingStack, and evaluates the Position values for each widget owned by this scene into actual pixel values, then stores that result in the widget's RenderBounds field.

SaveSceneDataValues Source code

Notifies all children of this scene that are bound to writable data stores to publish their values to those data stores.
@param bUnbindSubscribers if TRUE, all data stores bound by widgets and strings in this scene will be unbound.

SceneActivated Source code

Called just after the scene is added to the ActiveScenes array, or when this scene has become the active scene as a result of closing another scene.
@param bInitialActivation TRUE if this is the first time this scene is being activated; FALSE if this scene has become active as a result of closing another scene or manually moving this scene in the stack.

SceneCreated Source code

Default handler for the OnCreateScene delegate

SceneDeactivated Source code

Called just after this scene is removed from the active scenes array

SetActiveContextMenu Source code

Changes the scene's ActiveContextMenu to the one specified.
@param NewContextMenu the new context menu to activate, or NULL to clear any active context menus.
@param PlayerIndex the index of the player to display the context menu for.
@return TRUE if the scene's ActiveContextMenu was successfully changed to the new value.

SetActiveToolTip Source code

Changes the scene's ActiveToolTip to the one specified.

SetInputMask Source code

Changes the player input mask for this control, which controls which players this control will accept input from.
@param NewInputMask the new mask that should be assigned to this control
@param bRecurse if TRUE, calls SetInputMask on all child controls as well.

SetMouseBounds Source code

Modifies the scenes mouse boundaries during runtime.
@param Face the side of the scene which the boundary will be applied to
@param Value the value (in either pixels or percentage) of the current boundary
@param bPixelValue if true, 'Value' will be interpreted as a raw pixel value
@param BoundaryObject if set, Value/bPixelValue will be ignored and the mouse boundaries will be set based upon the input object

SetSceneInputMode Source code

Changes the screen input mode for this scene.

SetVisibility Source code

Changes whether this widget is visible or not. Should be overridden in child classes to perform additional logic or abort the visibility change.
@param bIsVisible TRUE if the widget should be visible; false if not.

UnbindSubscribers Source code

Makes all the widgets in this scene unsubscribe from their bound datastores.

defaultproperties
{
   MouseBounds=(bFullscreenOnly=True,Value[2]=1.000000,Value[3]=1.000000)
   bDisplayCursor=True
   bPauseGameWhileActive=True
   bCloseOnLevelChange=True
   bSaveSceneValuesOnClose=True
   bFlushPlayerInput=True
   DefaultToolTipClass=Class'Engine.UIToolTip'
   DefaultContextMenuClass=Class'Engine.UIContextMenu'
   SceneInputMode=INPUTMODE_Locked
   SceneRenderMode=SPLITRENDER_PlayerOwner
   CurrentViewportSize=(X=1024.000000,Y=768.000000)
   SceneOpenedCue="SceneOpened"
   SceneClosedCue="SceneClosed"
   DefaultStates(2)=Class'Engine.UIState_Focused'
   DefaultStates(3)=Class'Engine.UIState_Active'
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'Engine.Default__UIComp_Event'
      DefaultEvents(0)=(EventTemplate=UIEvent_Initialized'Engine.Default__UIScene:SceneInitializedEvent')
      DefaultEvents(1)=(EventTemplate=UIEvent_SceneActivated'Engine.Default__UIScene:SceneActivatedEvent')
      DefaultEvents(2)=(EventTemplate=UIEvent_SceneDeactivated'Engine.Default__UIScene:SceneDeactivatedEvent')
      DefaultEvents(3)=(EventTemplate=UIEvent_OnEnterState'Engine.Default__UIScene:EnteredStateEvent')
      DefaultEvents(4)=(EventTemplate=UIEvent_OnLeaveState'Engine.Default__UIScene:LeftStateEvent')
      Name="SceneEventComponent"
      ObjectArchetype=UIComp_Event'Engine.Default__UIComp_Event'
   End Object
   EventProvider=SceneEventComponent
   Name="Default__UIScene"
   ObjectArchetype=UIScreenObject'Engine.Default__UIScreenObject'
}