UE3:UISceneManager (UT3)

Object >> UISceneManager

Package: 

UnrealEd

This class in other games:

UDK

This class manages the UI editor windows. It's responsible for initializing scenes when they are loaded/created and managing the root scene client for all ui editors. Created by the UIScene generic browser type and stored in the BrowserManager.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved

Properties

ActiveSkin

Type: UISkin

Modifiers: transient

The UISkin currently providing styles to the scenes in the editor. Only one UISkin can be active at a time.

DataStoreManager

Type: DataStoreClient

Modifiers: const, transient

Manages all persistent global data stores. Created when the UISceneManager is initialized.

DlgUIDataStoreBrowser

Type: pointer{class WxDlgUIDataStoreBrowser}

Modifiers: transient, native, const, private

A pointer to the instance of WxDlgUIDataStoreBrowser

SceneClients

Type: array<EditorUISceneClient>

Modifiers: const, transient

Holds an array of scene clients, which correspond to each scene that's been opened or created during this editing session. Scene clients are not removed or deleted when their scene is closed

TitleRegions

Type: UITitleRegions

Modifiers: const, config

Variable that stores the max/recommended safe regions for the screen.

Default value:

Member	Value
MaxPercentage	0.9
RecommendedPercentage	0.85

UIStateResourceInfoMap

Type: Map{UClass*, FUIStateResourceInfo*}

Modifiers: const, transient

Quick lookup for friendly names for UIState resources. Built when UISceneManager is initialized.

UIStateResources

Type: array<UIStateResourceInfo>

Modifiers: const, transient, private

the list of useable UIState resources. Build when UISceneManager is initialized.

UIStyleResources

Type: array<UIStyleResourceInfo>

Modifiers: const, transient

the list of useable UIStyle resources. Built when UISceneManager is initialized.

UIWidgetResources

Type: array<UIObjectResourceInfo>

Modifiers: const, transient

The list of placeable widgets types. Used to fill the various "add new widget" menus. Built when the UISceneManager is initialized.

UIWidgetToolbarMaps

Type: array<UIObjectToolbarMapping>

Modifiers: const, config

A list of mappings from widgets to information needed by the editor to display toolbar buttons corresponding to widgets.

Default value, index 0:

Member	Value
HelpText	"UIEditor_HelpText_Button"
IconName	"UI_MODE_BUTTON"
Tooltip	"UIEditor_Widget_Button"
WidgetClassName	"Engine.UIButton"

Default value, index 1:

Member	Value
HelpText	"UIEditor_HelpText_Editbox"
IconName	"UI_MODE_EDITBOX"
Tooltip	"UIEditor_Widget_Editbox"
WidgetClassName	"Engine.UIEditBox"

Default value, index 2:

Member	Value
HelpText	"UIEditor_HelpText_Image"
IconName	"UI_MODE_IMAGE"
Tooltip	"UIEditor_Widget_Image"
WidgetClassName	"Engine.UIImage"

Default value, index 3:

Member	Value
HelpText	"UIEditor_HelpText_Label"
IconName	"UI_MODE_LABEL"
Tooltip	"UIEditor_Widget_Label"
WidgetClassName	"Engine.UILabel"

Default value, index 4:

Member	Value
HelpText	"UIEditor_HelpText_LabelButton"
IconName	"UI_MODE_LABELBUTTON"
Tooltip	"UIEditor_Widget_LabelButton"
WidgetClassName	"Engine.UILabelButton"

Default value, index 5:

Member	Value
HelpText	"UIEditor_HelpText_ToggleButton"
IconName	"UI_MODE_TOGGLEBUTTON"
Tooltip	"UIEditor_Widget_ToggleButton"
WidgetClassName	"Engine.UIToggleButton"

Default value, index 6:

Member	Value
HelpText	"UIEditor_HelpText_CheckBox"
IconName	"UI_MODE_CHECKBOX"
Tooltip	"UIEditor_Widget_CheckBox"
WidgetClassName	"Engine.UICheckbox"

Default value, index 7:

Member	Value
HelpText	"UIEditor_HelpText_List"
IconName	"UI_MODE_LIST"
Tooltip	"UIEditor_Widget_List"
WidgetClassName	"Engine.UIList"

Default value, index 8:

Member	Value
HelpText	"UIEditor_HelpText_Panel"
IconName	"UI_MODE_PANEL"
Tooltip	"UIEditor_Widget_Panel"
WidgetClassName	"Engine.UIPanel"

Default value, index 9:

Member	Value
HelpText	"UIEditor_HelpText_Slider"
IconName	"UI_MODE_SLIDER"
Tooltip	"UIEditor_Widget_Slider"
WidgetClassName	"Engine.UISlider"

Structs

UIObjectResourceInfo

Extends: UIResourceInfo

Modifiers: native, transient

(No new member variables.)

UIObjectToolbarMapping

Modifiers: native

string WidgetClassName 

Name of the widget class to represent

string IconName 

Icon for the toolbar button

string Tooltip 

Tooltip for the toolbar button (Should be a localizable lookup)

string HelpText 

Status bar text for the toolbar button (Should be a localizable lookup)

UIResourceInfo

Modifiers: native, transient

Object UIResource 

pointer to an archetype for a UI resource, such as a widget, style, or state

string FriendlyName 

the text that will be displayed in all menus and dialogs for this resource

UIStateResourceInfo

Extends: UIResourceInfo

Modifiers: native, transient

(No new member variables.)

UIStyleResourceInfo

Extends: UIResourceInfo

Modifiers: native, transient

(No new member variables.)

UITitleRegions

Modifiers: native

float RecommendedPercentage 

float MaxPercentage 

Native functions

GetSupportedUIStates

native final function GetSupportedUIStates (out array<UIStateResourceInfo> out_SupportedStates, optional class<UIScreenObject> WidgetClass) const

Retrieves the list of UIStates which are supported by the specified widget.

Parameters:

• out_SupportedStates - the list of UIStates supported by the specified widget class.
• WidgetClass - if specified, only those states supported by this class will be returned. If not specified, all states will be returned.