I love the smell of UnrealEd crashing in the morning. – tarquin
Difference between revisions of "UE3:UIRoot (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 6)) |
(No difference)
|
Latest revision as of 06:51, 17 January 2010
Object >> UIRoot |
Contents
- 1 Constants
- 1.1 TEMP_SPLITSCREEN_INDEX
- 1.2 DEFAULT_SCENE_PRIORITY
- 1.3 PRIVATE_NotEditorSelectable
- 1.4 PRIVATE_TreeHidden
- 1.5 PRIVATE_NotFocusable
- 1.6 PRIVATE_NotDockable
- 1.7 PRIVATE_NotRotatable
- 1.8 PRIVATE_ManagedStyle
- 1.9 PRIVATE_TreeHiddenRecursive
- 1.10 PRIVATE_EditorNoDelete
- 1.11 PRIVATE_EditorNoRename
- 1.12 PRIVATE_EditorNoReparent
- 1.13 PRIVATE_PropagateState
- 1.14 PRIVATE_KeepFocusedState
- 1.15 PRIVATE_Protected
- 1.16 DEFAULT_SIZE_X
- 1.17 DEFAULT_SIZE_Y
- 1.18 SCENE_DATASTORE_TAG
- 1.19 MAX_SUPPORTED_GAMEPADS
- 2 Enums
- 3 Structs
- 4 Functions
- Package:
- Engine
- Direct subclasses:
- DataStoreClient, Interaction, UIAnimation, UIDataProvider, UIEditorOptions, UIInputConfiguration, UILayerBase, UISceneClient, UIScreenObject, UIState, UIString, UIStyle, UIStyle_Data, UITexture, UITickableObjectProxy
- This class in other games:
- UT3
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Base class for all classes that handle interacting with the user.
Constants[edit]
TEMP_SPLITSCREEN_INDEX[edit]
Value: 0
DEFAULT_SCENE_PRIORITY[edit]
Value: 10
the default priority for all UIScenes
PRIVATE_NotEditorSelectable[edit]
Value: 0x001
Controls what types of interactions are allowed for a widget. Ideally this would be an enum, but the values are used as a bitmask (for UIObject.PrivateFlags) and unrealscript enums cannot be assigned values.
PRIVATE_TreeHidden[edit]
Value: 0x002
Not selectable in the scene editor.
PRIVATE_NotFocusable[edit]
Value: 0x004
Not viewable in the scene tree or layer tree, but children are.
PRIVATE_NotDockable[edit]
Value: 0x008
Not eligible to receive focus; affects both editor and game
PRIVATE_NotRotatable[edit]
Value: 0x010
Not able to be docked to another widget.
PRIVATE_ManagedStyle[edit]
Value: 0x020
Not able to be rotated.
Todo: not yet implemented.
PRIVATE_TreeHiddenRecursive[edit]
Value: 0x042
Indicates that this widget's styles are managed by its owner widgets - any style references set for this widget will not be saved.
PRIVATE_EditorNoDelete[edit]
Value: 0x080
Not visible in the scene tree or layer tree, including children
PRIVATE_EditorNoRename[edit]
Value: 0x100
This widget is not deletable in the editor
PRIVATE_EditorNoReparent[edit]
Value: 0x200
This widget is not renamable in the editor
PRIVATE_PropagateState[edit]
Value: 0x400
This widget can not be reparented in the editor
PRIVATE_KeepFocusedState[edit]
Value: 0x800
This widget will propagate certain states to its children, such as enabled and disabled
PRIVATE_Protected[edit]
Value: 0x380
Combination flags
DEFAULT_SIZE_X[edit]
Value: 1024
DEFAULT_SIZE_Y[edit]
Value: 768
SCENE_DATASTORE_TAG[edit]
Value: 'SceneData'
MAX_SUPPORTED_GAMEPADS[edit]
Value: 4
Enums[edit]
See UIRoot enums.
Structs[edit]
See UIRoot structs.
Functions[edit]
Static native functions[edit]
GetCurrentUIController[edit]
Returns the UIInteraction instance currently controlling the UI system, which is valid in game.
Returns:
- a pointer to the UIInteraction object currently controlling the UI system.
GetCursorPosition[edit]
Returns the current position of the mouse or joystick cursor.
Parameters:
- CursorX - receives the X position of the cursor
- CursorY - receives the Y position of the cursor
- Scene - if specified, provides access to an FViewport through the scene's SceneClient that can be used for retrieving the mouse position when not in the game.
Returns:
- TRUE if the cursor position was retrieved correctly.
GetCursorSize[edit]
Returns the current position of the mouse or joystick cursor.
Parameters:
- CursorXL - receives the width of the cursor
- CursorYL - receives the height of the cursor
Returns:
- TRUE if the cursor size was retrieved correctly.
GetDataStoreFieldValue[edit]
Gets the field value struct of the datastore entry specified.
Parameters:
- InDataStoreMarkup - Markup to find the field we want to retrieve the value of.
- OutFieldValue - Variable to store the result field value in.
- OwnerScene - Owner scene for the datastore, used when dealing with scene specific datastores.
- OwnerPlayer - Owner player for the datastore, used when dealing with player datastores.
Returns:
- TRUE if the value was retrieved, FALSE otherwise.
GetFaceOrientation[edit]
Wrapper for returns the orientation associated with the specified face.
Note: noexport because the C++ version is static too.
GetInputPlatformType[edit]
Returns the platform type for the current input device. This is not necessarily the platform the game is actually running on; for example, if the game is running on a PC, but the player is using an Xbox controller, the current InputPlatformType would be IPT_360.
Parameters:
- OwningPlayer - if specified, the returned InputPlatformType will reflect the actual input device the player is using. Otherwise, the returned InputPlatformType is always the platform the game is running on.
Returns:
- the platform type for the current input device (if a player is specified) or the host platform.
Note: noexport because the C++ version is static too.
GetPrimitiveTransform[edit]
Returns a matrix which includes the translation, rotation and scale necessary to transform a point from origin to the the specified widget's position onscreen. This matrix can then be passed to ConditionalUpdateTransform() for primitives in use by the UI.
Parameters:
- Widget - the widget to generate the matrix for
- bIncludeAnchorPosition - specify TRUE to include translation to the widget's anchor; if FALSE, the translation will move the point to the widget's upper left corner (in local space)
- bIncludeRotation - specify FALSE to remove the widget's rotation from the resulting matrix
- bIncludeScale - specify FALSE to remove the viewport's scale from the resulting matrix
Returns:
- a matrix which can be used to translate from origin (0,0) to the widget's position, including rotation and viewport scale.
Note: noexport because we want this method to be static in C++ as well.
GetSceneClient[edit]
Returns the game's scene client.
Returns:
- a pointer to the UGameUISceneClient instance currently managing the scenes for the UI System.
SetDataStoreFieldValue[edit]
Sets the string value of the datastore entry specified.
Parameters:
- InDataStoreMarkup - Markup to find the field we want to set the value of.
- InFieldValue - Value to set the datafield's value to.
- OwnerScene - Owner scene for the datastore, used when dealing with scene specific datastores.
- OwnerPlayer - Owner player for the datastore, used when dealing with player datastores.
Returns:
- TRUE if the value was set, FALSE otherwise.
SetMouseCaptureOverride[edit]
Changes the value of GameViewportClient.bUIMouseCaptureOverride to the specified value. Used by widgets that process dragging to ensure that the widget receives the mouse button release event.
Parameters:
- bCaptureMouse - whether to capture all mouse input.
Other static functions[edit]
ConvertWidgetIDToString[edit]
Generates a unique tag that can be used in the scene's data store as the data field name for a widget's context menu items.
Parameters:
- SourceWidget - the widget to generate the unique tag for
Returns:
- a string guaranteed to be unique which represents the source widget.
GetDataStoreStringValue[edit]
Gets the string value of the datastore entry specified.
Parameters:
- InDataStoreMarkup - Markup to find the field we want to retrieve the value of.
- OutStringValue - Variable to store the result string in.
- OwnerScene - Owner scene for the datastore, used when dealing with scene specific datastores.
- OwnerPlayer - Owner player for the datastore, used when dealing with player datastores.
Returns:
- TRUE if the value was retrieved, FALSE otherwise.
GetOnlineGameInterface[edit]
Wrapper for getting a reference to the online subsystem's game interface.
GetOnlinePlayerInterface[edit]
Wrapper for getting a reference to the online subsystem's player interface.
GetOnlinePlayerInterfaceEx[edit]
Wrapper for getting a reference to the extended online player interface
IsConsole[edit]
Returns:
- Returns the current platform the game is running on.
IsEditor[edit]
Returns:
- TRUE if we're in the editor.
SetDataStoreStringValue[edit]
Sets the string value of the datastore entry specified.
Parameters:
- InDataStoreMarkup - Markup to find the field we want to set the value of.
- InStringValue - Value to set the datafield's string value to.
- OwnerScene - Owner scene for the datastore, used when dealing with scene specific datastores.
- OwnerPlayer - Owner player for the datastore, used when dealing with player datastores.
Returns:
- TRUE if the value was set, FALSE otherwise.