Engine.UIRoot

Extends

Object

Modifiers

native ( UserInterface ) HideCategories ( Object , UIRoot ) abstract

Base class for all classes that handle interacting with the user. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot

Direct Known Subclasses:

DataStoreClient, Interaction, UIAnimation, UIDataProvider, UIEditorOptions, UIInputConfiguration, UILayerBase, UISceneClient, UIScreenObject, UIState, UIString, UIStyle, UIStyle_Data, UITexture

Functions Summary
	<>	< (FArchive& Ar, FUIStringNode& StringNode)
	=	= (const FUIInputAliasValue& Other ) con)
	!	= (const FUIInputAliasValue& Other ) con)
	=	= (const FRawInputKeyEventData& Other ) con)
	!	= (const FRawInputKeyEventData& Other ) con)
	string	ConvertWidgetIDToString (UIObject SourceWidget ))
	UIInteraction	GetCurrentUIController ()
	bool	GetCursorPosition (out int CursorX, out int CursorY, const optional UIScene Scene)
	bool	GetCursorSize (out float CursorXL, out float CursorYL)
	bool	GetDataStoreFieldValue (string InDataStoreMarkup, out UIProviderFieldValue OutFieldValue, optional UIScene OwnerScene, optional LocalPlayer OwnerPlayer)
	bool	GetDataStoreStringValue (string InDataStoreMarkup, out string OutStringValue, optional UIScene OwnerScene=none, optional LocalPlayer OwnerPlayer=none))
	EUIOrientation	GetFaceOrientation (EUIWidgetFace Face)
	Matrix	GetPrimitiveTransform (UIObject Widget, optional bool bIncludeAnchorPosition, optional bool bIncudeRotation=true, optional bool bIncludeScale=true ) con)
	GameUISceneClient	GetSceneClient ()
	bool	IsConsole (optional EConsoleType ConsoleType=CONSOLE_Any ))
	bool	SetDataStoreFieldValue (string InDataStoreMarkup, const out UIProviderFieldValue InFieldValue, optional UIScene OwnerScene, optional LocalPlayer OwnerPlayer)
	bool	SetDataStoreStringValue (string InDataStoreMarkup, string InStringValue, optional UIScene OwnerScene, optional LocalPlayer OwnerPlayer))
		SetMouseCaptureOverride (bool bCaptureMouse)

ASPECTRATIO_Monitor Source code

ASPECTRATIO_Normal Source code

Aspect ratios

ASPECTRATIO_Widescreen Source code

DEFAULT_SIZE_X Source code

Changes the AssignedStyleID for this style reference
@param NewStyleID the STYLE_ID for the UIStyle to link this style reference to
@return TRUE if the AssignedStyleId was changed. FALSE if NewStyleID matched the value of AssignedStyleID.

DEFAULT_SIZE_Y Source code

MAX_SUPPORTED_GAMEPADS Source code

PRIVATE_EditorNoDelete Source code

Not visible in the scene tree or layer tree, including children

PRIVATE_EditorNoRename Source code

This widget is not deletable in the editor

PRIVATE_EditorNoReparent Source code

This widget is not renamable in the editor

PRIVATE_KeepFocusedState Source code

This widget will propagate certain states to its children, such as enabled and disabled

PRIVATE_ManagedStyle Source code

Not able to be rotated. @todo - not yet implemented.

PRIVATE_NotDockable Source code

Not eligible to receive focus; affects both editor and game

PRIVATE_NotEditorSelectable Source code

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_NotFocusable Source code

Not viewable in the scene tree or layer tree, but children are.

PRIVATE_NotRotatable Source code

Not able to be docked to another widget.

PRIVATE_PropagateState Source code

This widget can not be reparented in the editor

PRIVATE_Protected Source code

Combination flags

PRIVATE_TreeHidden Source code

Not selectable in the scene editor.

PRIVATE_TreeHiddenRecursive Source code

Indicates that this widget's styles are managed by its owner widgets - any style references set for this widget will not be saved.

SCENE_DATASTORE_TAG Source code

TEMP_SPLITSCREEN_INDEX Source code

CurrentMenuState Source code

The current menu state of the widget that owns the source UIString.

ModifierStack Source code

EColumnHeaderState Source code

The different states for a list column header

EMaterialAdjustmentType Source code

The type of adjustment to apply to a material.

ENavigationLinkType Source code

Types of navigation targets

EPositionEvalType Source code

method to use for resolving a UIScreenValue

ERotationAnchor Source code

Different presets to use for the rotation anchor's position

EScreenInputMode Source code

The types of split-screen input modes that are supported for UI scenes. These control what a UIScene does when it receives input from multiple gamepads at once. @note: the order of the values in this enum should not be changed.

ESplitscreenRenderMode Source code

Types of split-screen rendering layouts that scenes can use.

ETextAutoScaleMode Source code

Different types of autoscaling supported

ETextClipMode Source code

Determines how text should be handled when the text overflows its bounds

EUIAlignment Source code

used for specifying alignment for UIObjects and operations

EUIAspectRatioConstraint Source code

The types of aspect ratio constraint adjustments supported

EUIAutoSizeConstraintType Source code

the different types of auto-size extent values

EUIDataProviderFieldType Source code

Data field categorizations.

EUIDefaultPenColor Source code

The types of default textures the UI can use

EUIDockPaddingEvalType Source code

method to use for resolving dock padding values

EUIExtentEvalType Source code

method to use for resolving a UIAutoSizeRegion's values

EUIListElementState Source code

Represents the state of an item in a UIList.

EUIOrientation Source code

general orientation for UIObjects

EUIWidgetFace Source code

The faces a widget may contain.

AutoSizeData Source code

Defines parameters for auto-sizing a widget
bAutoSizeEnabled:

whether auto-sizing is enabled for this dimension

Extent:

specifies the minimum and maximum values that the region can be auto-sized to

Padding:

the internal padding to apply to the region

AutoSizePadding Source code

Data structure for representing the padding to apply to an auto-size region

DefaultEventSpecification Source code

Represents a UIEvent that should be automatically added to all instances of a particular widget.
EventState:

Optionally specify the state in which this event should be active. The event will be added to the corresponding UIState instance's list of events, rather than the widget's list of events

EventTemplate:

the UIEvent template to use when adding the event instance to a widget's EventProvider

InputEventSubscription Source code

Represents a mapping of input key to widgets which contain EventComponents that respond to the associated input key.
KeyName:

The name of the key represented by this InputEventSubscription (i.e. KEY_XboxTypeS_LeftTrigger, etc.)

Subscribers:

a list of widgets which are eligible to process this input key event

InputKeyAction Source code

Associates a UIAction with input key name.
ActionsToExecute:

The actions to execute

InputKeyName:

the input key name that will activate the action

InputKeyState:

the state (pressed, released, etc.) that will activate the action

PlayerInteractionData Source code

Tracks widgets which are currently in special states.
FocusedControl:

The widget/scene that currently has focus

LastFocusedControl:

The widget/scene that last had focus

RenderParameters Source code

General purpose data structure for grouping all parameters needed when rendering or sizing a string/image
DrawCoords:

the coordinates to use to render images

DrawFont:

the font to use for rendering/sizing the string

DrawX:

a pixel value representing the horizontal screen location to begin rendering the string

DrawXL:

a pixel value representing the width of the area available for rendering the string

DrawY:

a pixel value representing the vertical screen location to begin rendering the string

DrawYL:

a pixel value representing the height of the area available for rendering the string

ImageExtent:

Only used when rendering string nodes that contain images. Represents the size to use for rendering the image

Scaling:

A value between 0.0 and 1.0, which represents how much the width/height should be scaled, where 1.0 represents 100% scaling.

SpacingAdjust:

Horizontal spacing adjustment between characters and vertical spacing adjustment between wrapped lines

TextAlignment[EUIOrientation.UIORIENT_MAX]:

The alignment for the string we are drawing.

ViewportHeight:

the current height of the viewport; needed to support multifont

ScreenPositionRange Source code

Data structure for mapping a region on the screen. Rather than representing an X,Y coordinate, this struct represents the beginning and end of a dimension (X1, X2)

StateInputKeyAction Source code

Specialized version of InputKeyAction used for constraining the input action to a particular UIState.
Scope:

Allows an input action to be tied to a specific UIState. If NULL, the action will be active in all states that support UIEvent_ProcessInput. If non-NULL, the input key will only be accepted when the widget is in the specified state.

StyleReferenceId Source code

Container used for identifying UIStyleReference properties from multiple UIStyleResolvers of the same class
StyleProperty:

the actual UIStyleReference property

StyleReferenceTag:

The tag to use for this UIStyleResolver's properties

STYLE_ID Source code

A unique ID number for a resource located in a UI skin package. Used to lookup materials in skin files.

TextAutoScaleValue Source code

Container for text autoscaling values.
AutoScaleMode:

Allows text to be scaled to fit within the bounding region

MinScale:

the minimum and maximum amount of scaling that can be applied to the text; these values must be set in order for auto-scaling to be used in conjunction with any type of string formatting (i.e. wrapping, clipping, etc.). Negative values will be ignored and a value of 0 indicates that MinScale is not enabled.

TextureCoordinates Source code

Coordinates for mapping a piece of a texture atlas

UIAnchorPosition Source code

Data structure for describing the location of a widget's rotation pivot. Defines a 2D point within a widget's bounds, either in pixels or percentage, along with a z-depth value (in pixels)

UICombinedStyleData Source code

Container for all data contained by UI styles. Used for applying inline modifications to UIString nodes, such as changing the font, draw color, or attributes @todo - support for embedded markup, such as blah blahblah blah
AdjustmentType[EUIOrientation.UIORIENT_MAX]:

Information about how to modify the way the image is rendered.

AtlasCoords:

the coordinates to use if FallbackImage is a texture atlas

bInitialized:

indicates whether this style data container has been initialized

DrawFont:

the font to use when rendering text

FallbackImage:

the material to use when rendering images if the image material cannot be loaded or isn't set

ImageColor:

color to use for rendering images

ImagePadding[EUIOrientation.UIORIENT_MAX]:

padding to use for rendering images

TextAlignment[EUIOrientation.UIORIENT_MAX]:

text alignment within the bounding region

TextAttributes:

attributes to apply to this style's font

TextAutoScaling:

Allows text to be scaled to fit within the bounding region

TextClipAlignment:

Determines how the nodes of this string are ordered when the string is being clipped

TextClipMode:

determines how strings that overrun the bounding region are handled

TextColor:

color to use for rendering text

TextPadding[EUIOrientation.UIORIENT_MAX]:

padding to use for rendering text

TextScale:

text scale to use when rendering text

TextSpacingAdjust:

Horizontal spacing adjustment between characters and vertical spacing between wrapped lines of text

UIDataStoreBinding Source code

Contains information about a UI data store binding, including the markup text used to reference the data store and the resolved value of the markup text. @NOTE: if you move this struct declaration to another class, make sure to update UUIObject::GetDataBindingProperties()
BindingIndex:

Used to differentiate multiple data store properties in a single class.

DataStoreField:

the name of the field resolved from MarkupString; must be a field supported by ResolvedDataStore

DataStoreName:

the name of the data store resolved from MarkupString

MarkupString:

A datastore markup string which resolves to a property/data type exposed by a UI data store. @note: cannot be editconst until we have full editor support for manipulating markup strings (e.g. inserting embedded markup, etc.)

RequiredFieldType:

Indicates which type of data fields can be used in this data store binding

ResolvedDataStore:

a pointer to the data store resolved from MarkupString

Subscriber:

The UIDataStoreSubscriber that contains this UIDataStoreBinding

UIDockingNode Source code

A widget/face pair. Used by the docking system to track the order in which widget face positions should be evaluated
Face:

the face on the Widget that should be updated when this docking node is processed

Widget:

the widget that this docking node is associated with

UIDockingSet Source code

Defines the desired docking behavior for all faces of a single widget
bLinking[EUIWidgetFace.UIFACE_MAX]:

set to 1 when this node is in the process of being added to the scene's docking stack; used to easily track down circular relationships between docking sets

bLockHeightWhenDocked:

Controls whether the height of this widget should remain constant when adjusting the position of the top or bottom face as a result of docking. Only relevant when either the top or bottom faces are docked.

bLockWidthWhenDocked:

Controls whether the width of this widget should remain constant when adjusting the position of the left or right face as a result of docking. Only relevant when either the left or right faces are docked.

bResolved[EUIWidgetFace.UIFACE_MAX]:

tracks whether each face has been resolved (via UpdateDockingSet). Reset whenever ResolveScenePositions is called

DockPadding:

The amount of padding to use for docking each face. Positive values are considered "inside" padding, while negative values are considered "outside" padding.

OwnerWidget:

The widget that is associated with this docking set. Set by InitializeDockingSet().

TargetFace[EUIWidgetFace.UIFACE_MAX]:

The face on the TargetWidget that this docking set applies to.

TargetWidget[EUIWidgetFace.UIFACE_MAX]:

The widget that will be docked against. If this value is NULL, it means that docking isn't enabled for this face If this value points to OwnerWidget, it means that the face is docked to the owner scene.

UIFocusPropagationData Source code

Contains information about how to propagate focus between parent and child widgets.
bPendingReceiveFocus:

Indicates that this widget is currently becoming the focused control. Used for preventing KillFocus from clobbering this pending focus change if one of this widget's children is the currently focused control (since killing focus on a child of this widget would normally cause this widget to lose focus as well

FirstFocusTarget:

Specifies the child widget that should automatically receive focus when this widget receives focus. Set automatically when RebuildNavigationLinks() is called on the owning widget.

LastFocusTarget:

Specifies the child widget which will automatically receive focus when this widget receives focus and the user is navigating backwards through the scene (i.e. Shift+Tab). Set automatically when RebuildNavigationLinks() is called on the owning widget.

NextFocusTarget:

Specifies the sibling widget that is next in the tab navigation system for this widget's parent. Set automatically when RebuildNavigationLinks() is called on the owning widget.

PrevFocusTarget:

Specifies the sibling widget that is previous in the tab navigation system for this widget's parent. Set automatically when RebuildNavigationLinks() is called on the owning widget.

UIImageAdjustmentData Source code

Describes the parameters for adjusting a material to match the dimensions of a target region.
AdjustmentType:

the type of adjustment to perform to the image for each orientation

Alignment:

alignment within the region

ProtectedRegion:

size of buffer zone for constraining the image adjustment

UIImageStyleOverride Source code

Contains data for overriding the corresponding data in an image style.
>:

Information about how to modify the way the image is rendered.

bOverrideCoordinates:

indicates whether the coordinates have been customized

bOverrideFormatting:

indicates whether the formatting has been customized

Coordinates:

if DefaultImage points to a texture atlas, represents the coordinates to use for rendering this image

UIInputAliasClassMap Source code

Defines the UIInputActionAliases that are supported by a particular widget class for each state. @todo ronp - add support for specifying "input alias => raw input key" mappings for widget archetypes
StateLookupTable:

Runtime lookup map to find a input alias map. Maps a UIState class <=> (map of input key name (KEY_Left) + modifier keys <=> input key alias (UIKEY_Clicked)). Used for quickly unregistering input keys when a state goes out of scope.

StateReverseLookupTable:

Runtime lookup map to find a state input struct. Maps a UIState class => (map of input key alias (UIKEY_Clicked) => input key name (KEY_Left)) Used for quickly registering input keys when a state enters scope - since multiple input keys can be mapped to a single input key alias, and each input key alias name must be checked against the list of disabled input aliases, storing this reverse lookup table allows us to check only once for each input alias.

WidgetClass:

the widget class that this UIInputAliasMap contains input aliases for

WidgetClassName:

the name of the widget class to load

WidgetStates:

the states that this widget class supports

UIInputAliasMap Source code

A TMultiMap wrapper which maps input key names (i.e. KEY_Left) to a list of input action alias data.
InputAliasLookupTable:

A mapping from input key data (name + modifier key) <==> input alias triggered by that input key event Used to retrieve the input action alias for a given input key when input events are received.

UIInputAliasStateMap Source code

Defines the list of key mappings supported in a paticular widget state.
State:

The widget state that this map contains input aliases for.

StateClassName:

the path name for the state class to load

StateInputAliases:

the input action aliases that this widget state supports

UIMouseBounds Source code

Used by UIScene's for setting the boundaries which the mouse pointer can move within
bFullscreenOnly:

If true, the mouse bounds are only applied when in fullscreen mode (default)

BoundaryObject[EUIWidgetFace.UIFACE_MAX]:

If set, the specified objects position and extent are used to automatically determine the scene boundaries (overrides Value and bPixelValue) Set this using the UIEditor context menu

bPixelValue[EUIWidgetFace.UIFACE_MAX]:

Determines how 'Value' is interpreted; when false, Value is interpreted as a percentage

Value[EUIWidgetFace.UIFACE_MAX]:

The value for each boundary face (setup much like UIScreenValue_Bounds, above)

UINavigationData Source code

Defines the navigation links for a widget.
bNullOverride[EUIWidgetFace.UIFACE_MAX]:

By default, a NULL value for the forced nav taget indicates that the nav target for that face should be automatically calculated. bNullOverride indicates that a value of NULL *is* the designer specified nav target.

ForcedNavigationTarget[EUIWidgetFace.UIFACE_MAX]:

Allows the designer to override the auto-generated focus target for each face. If a value is set for NavigationTarget, that widget will always be set as the value for CurrentNavTarget for that face.

NavigationTarget[EUIWidgetFace.UIFACE_MAX]:

The widgets that will receive focus when the user presses the corresonding direction. For keyboard navigation, pressing "tab" will set focus to the widget in the UIFACE_Right slot, pressing "shift+tab" will set focus to the widget in the UIFACE_Left slot. Filled in at runtime when RebuildNavigationLinks is called.

UIProviderFieldValue Source code

This extension of UIProviderScriptFieldValue is used when resolving values for markup text found in UIStrings. This struct allows data stores to provide the UIStringNode that should be used when rendering the value for the data field represented this struct.
CustomStringNode:

Only used by native code; allows the data store to create and initialize string nodes manually, rather than allowing the calling code to create a UIStringNode based on the value of StringValue or ImageValue

UIProviderScriptFieldValue Source code

Contains the value for a property, as either text or an image. Used for allowing script-only data provider classes to resolve data fields parsed from UIStrings.
ArrayValue:

If PropertyTag corresponds to data that should be represented as a list of untyped data, contains the value of the selected elements

ImageValue:

If PropertyTag correspondsd to data that should be represented as an image, contains the value for this resource

PropertyTag:

the name of this resource; set natively after the list of available tags are retrieved from script

PropertyType:

the type of field this tag corresponds to

RangeValue:

If PropertyTag corresponds to data that should be represented as value within a specific range, contains the value for this resource

StringValue:

If PropertyTag corresponds to data that should be represented as text, contains the value for this resource

UIRangeData Source code

Contains information about a data value that must be within a specific range.
bIntRange:

Indicates whether the values in this UIRange should be treated as ints.

CurrentValue:

the current value of this UIRange

MaxValue:

The maximum value for this UIRange. The value of this UIRange must be less than or equal to this value.

MinValue:

The minimum value for this UIRange. The value of this UIRange must be greater than or equal to this value.

NudgeValue:

Controls the amount to increment or decrement this UIRange's value when used by widgets that support "nudging". If NudgeValue is zero, reported NudgeValue will be 1% of MaxValue - MinValue.

UIRenderingSubregion Source code

Represents a sub-region within another render bounding region.
bSubregionEnabled:

Must be true to specify a subregion

ClampRegionAlignment:

the alignment for the sub-region; to enable "Subregion Position", this must be set to "Inherit/Other"

ClampRegionOffset:

Only relevant if ClampRegionAlignment is "Inherit/Other". The offset for the sub-region, relative to the beginning of the bounding region.

ClampRegionSize:

the size of the subregion; will be clamped to the size of the bounding region

UIRotation Source code

Data structure for representation the rotation of a UI Widget.
AnchorPosition:

point used for the origin in rotation animations

AnchorType:

defines whether the AnchorPosition is used or one of the presets

Rotation:

the UE representation of the rotation of the widget

TransformMatrix:

Transform matrix to use for rendering the widget.

UIScreenValue Source code

Represents a screen position, either as number of pixels or percentage. Used for single dimension (point) values.
Orientation:

the orientation associated with this UIScreenValue. Used for evaluating relative or percentage scaling types

ScaleType:

how this UIScreenValue should be evaluated

Value:

the value, in either pixels or percentage

UIScreenValue_AutoSizeRegion Source code

Represents the constraint region for auto-sizing text.

UIScreenValue_Bounds Source code

Represents a widget's position onscreen, either as number of pixels or percentage. Used for four dimension (bounds) values.
AspectRatioMode:

Specifies whether this position's values should be adjusted to constrain to the current aspect ratio. @fixme ronp - can't make editconst until we've exposed this to the position panel, context menu, and/or widget drag tools

bInvalidated[EUIWidgetFace.UIFACE_MAX]:

Indicates whether the position for each face has been modified since it was last resolved into screen pixels and applied to the owning widget's RenderBounds. If this value is FALSE, it indicates that the RenderBounds for the corresponding face in the owning widget matches the position Value. A value of TRUE indicates that the position Value for that face has been changed since it was last converted into RenderBounds.

ScaleType[EUIWidgetFace.UIFACE_MAX]:

Specifies how the value for each face should be intepreted.

Value[EUIWidgetFace.UIFACE_MAX]:

The value for each face. Can be a pixel or percentage value.

UIScreenValue_DockPadding Source code

Comparison
PaddingScaleType[EUIWidgetFace.UIFACE_MAX]:

Specifies how the Value for each face should be intepreted.

PaddingValue[EUIWidgetFace.UIFACE_MAX]:

The value for each face. Can be in pixels or a percentage of the owning widget's bounding region, depending on the ScaleType for each face.

UIScreenValue_Extent Source code

Very similar to UIScreenValue (which represents a point within a widget), this data structure is used for representing a sub-region of the screen, in a single dimension
Orientation:

the orientation associated with this extent. Used for evaluating percentage scaling types

ScaleType:

how this extent value should be evaluated

Value:

the value, in either pixels or percentage

UIScreenValue_Position Source code

Represents a screen position, either as number of pixels or percentage. Used for double dimension (orientation) values.

UIStringCaretParameters Source code

Error tolerant comparison operator
bDisplayCaret:

Controls whether a caret is displayed at all

CaretMaterial:

For carets that use parametized materials, the MaterialInterface that was created for this caret

CaretPosition:

The current position of the caret in the string

CaretStyle:

the tag of the style to use for displaying this caret

CaretType:

Determines which color pen (from GameUISceneClient's DefaultUITextures) is used to render the caret

CaretWidth:

Specifies the width of the caret, in pixels

UIStringNodeModifier Source code

This struct contains data about the current modifications that are being applied to a string as it is being parsed, such as any inline styles, fonts, or attributes.
BaseStyleData:

Optional style data that this UIStringNodeModifier was initialized from. If BaseStyleData is not valid, there must be at least one UIStyle in the ModifierStack.

CustomStyleData:

The current style data to apply to each new string node that is created @note: when data stores need to access additional fields of this member, add accessors to this struct rather than removing the private access specifier

InlineFontStack:

The fonts that have been resolved from inline font markup while this style was the current style.

Style:

the style for this data block. Refers to either the UIString's DefaultStringStyle, or a style resolved from an inline style markup reference (i.e. Styles:SomeStyle)

UIStyleOverride Source code

This struct contains properties which override values in a style.
>:

The amount of padding to apply for each orientation, in pixels. Padding will be scaled against the value of the DEFAULT_SIZE_Y const (currently 1024).

bOverrideDrawColor:

indicates whether the draw color has been customized

bOverrideOpacity:

Allow us to override the final alpha

bOverridePadding:

Indicates whether the padding has been customized

DrawColor:

Color to use for rendering the string or image. Values for each color range from 0.0 to 1.0, where 0.0 means "none of this color" and 1.0 means "full-color". Use values higher than 1.0 to create a "bloom" effect behind the text. Give DrawColor.A a value higher than 1.0 in order to bloom all colors uniformly. (requires UI post processing to be enabled - UISceneClient.bEnablePostProcess and the owning scene's bEnableScenePostProcessing properties must both be set to TRUE).

Opacity:

Provides a simple way for overriding the opacity of the text regardless of the DrawColor's Alpha value A value of 0.0 means "completely transparent"; a value of 1.0 means "completely opaque". Use values greater than 1.0 to bloom the DrawColor uniformly. (requires UI post processing to be enabled - UISceneClient.bEnablePostProcess and the owning scene's bEnableScenePostProcessing properties must both be set to TRUE).

UIStyleReference Source code

Encapsulates a reference to a UIStyle. UIStyleReference supports the following features: - when a UIStyleReference does not have a valid STYLE_ID, the default style for this style reference (as determined by DefaultStyleTag + RequiredStyleClass) is assigned as the value for ResolvedStyle, but the value of AssignedStyleID is not modified. - when a UIStyleReference has a valid STYLE_ID for the value of AssignedStyleID, but there is no style with that STYLE_ID in the current skin, ResolvedStyle falls back to using the default style for this style reference, but the value of AssignedStyleID is not modified. - once a UIStyleReference has successfully resolved a style and assigned it to ResolvedStyle, it will not re-resolve the style until the style reference has been invalidated (by calling Invalidate); attempting to change the ResolvedStyle of this style reference to a style not contained in the currently active skin invalidates the ResolvedStyle.
AssignedStyleID:

The STYLE_ID for the style assigned to this style reference in the game's default skin. This value is assigned when the designer changes the style for a style reference in the UI editor. This value can be overridden by UICustomSkins.

DefaultStyleTag:

Specifies the name of the style to use if this style reference doesn't have a valid STYLE_ID (which indicates that the designer hasn't specified a style for this style reference

RequiredStyleClass:

if non-null, limits the type of style that can be assigned to this style reference

ResolvedStyle:

the style data object that was associated with AssignedStyleID in the currently active skin

UIStyleSubscriberReference Source code

Pairs a unique name with a UIStyleResolver reference. not currently used.
Subscriber:

the reference to the UIStyleResolver object

SubscriberId:

A unique name for identifying this StyleResolver - usually the name of the property referencing this style resolver Used for differentiating styles from multiple UIStyleResolvers of the same class.

UITextAttributes Source code

Defines a group of attributes that can be applied to text, such as bold, italic, underline, shadow, etc.

UITextStyleOverride Source code

This struct is used to override values from a text style.
>:

Text alignment within the bounding region

>:

Sets the horizontal spacing adjustment between characters (in pixels), as well as the vertical spacing adjustment between lines of wrapped text (in pixels).

>:

Scale for rendering text

AutoScaling:

Allows text to be scaled to fit within the bounding region

bOverrideAlignment:

indicates whether the formatting has been customized

bOverrideAttributes:

indicates whether the coordinates have been customized

bOverrideAutoScale:

indicates whether the autoscale mode has been customized

bOverrideClipAlignment:

indicates whether the clip alignment has been customized

bOverrideClipMode:

indicates whether the clipping mode has been customized

bOverrideDrawFont:

indicates whether the draw font has been customized

bOverrideScale:

indicates whether the scale factor has been customized

bOverrideSpacingAdjust:

indicates whether the spacing adjust has been customized

ClipAlignment:

Determines how the nodes of this string are ordered when the string is being clipped

ClipMode:

Determines what happens when the text doesn't fit into the bounding region.

DrawFont:

The font to use for rendering text

TextAttributes:

Attributes to apply to the text, such as bold, italic, etc.

WIDGET_ID Source code

A unique identifier assigned to a widget.

< Source code

Serializers

= Source code

Comparison operators

= Source code

= Source code

Comparison operators

= Source code

ConvertWidgetIDToString Source code

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.
@param SourceWidget the widget to generate the unique tag for
@return a string guaranteed to be unique which represents the source widget.

GetCurrentUIController Source code

Returns the UIInteraction instance currently controlling the UI system, which is valid in game.
@return a pointer to the UIInteraction object currently controlling the UI system.

GetCursorPosition Source code

Returns the current position of the mouse or joystick cursor.
@param CursorX receives the X position of the cursor
@param CursorY receives the Y position of the cursor
@param 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.
@return TRUE if the cursor position was retrieved correctly.

GetCursorSize Source code

Returns the current position of the mouse or joystick cursor.
@param CursorXL receives the width of the cursor
@param CursorYL receives the height of the cursor
@return TRUE if the cursor size was retrieved correctly.

GetDataStoreFieldValue Source code

Gets the field value struct of the datastore entry specified.
@param InDataStoreMarkup Markup to find the field we want to retrieve the value of.
@param OutFieldValue Variable to store the result field value in.
@param OwnerScene Owner scene for the datastore, used when dealing with scene specific datastores.
@param OwnerPlayer Owner player for the datastore, used when dealing with player datastores.
@return TRUE if the value was retrieved, FALSE otherwise.

GetDataStoreStringValue Source code

Gets the string value of the datastore entry specified.
@param InDataStoreMarkup Markup to find the field we want to retrieve the value of.
@param OutStringValue Variable to store the result string in.
@param OwnerScene Owner scene for the datastore, used when dealing with scene specific datastores.
@param OwnerPlayer Owner player for the datastore, used when dealing with player datastores.
@return TRUE if the value was retrieved, FALSE otherwise.

GetFaceOrientation Source code

Wrapper for returns the orientation associated with the specified face. @note: noexport because the C++ version is static too.

GetPrimitiveTransform Source code

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.
@param Widget the widget to generate the matrix for
@param 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)
@param bIncludeRotation specify FALSE to remove the widget's rotation from the resulting matrix
@param bIncludeScale specify FALSE to remove the viewport's scale from the resulting matrix
@return 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 Source code

Returns the game's scene client.
@return a pointer to the UGameUISceneClient instance currently managing the scenes for the UI System.

IsConsole Source code

@return Returns the current platform the game is running on.

SetDataStoreFieldValue Source code

Sets the string value of the datastore entry specified.
@param InDataStoreMarkup Markup to find the field we want to set the value of.
@param InFieldValue Value to set the datafield's value to.
@param OwnerScene Owner scene for the datastore, used when dealing with scene specific datastores.
@param OwnerPlayer Owner player for the datastore, used when dealing with player datastores.
@return TRUE if the value was set, FALSE otherwise.

SetDataStoreStringValue Source code

Sets the string value of the datastore entry specified.
@param InDataStoreMarkup Markup to find the field we want to set the value of.
@param InStringValue Value to set the datafield's string value to.
@param OwnerScene Owner scene for the datastore, used when dealing with scene specific datastores.
@param OwnerPlayer Owner player for the datastore, used when dealing with player datastores.
@return TRUE if the value was set, FALSE otherwise.

SetMouseCaptureOverride Source code

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.
@param bCaptureMouse whether to capture all mouse input.

defaultproperties
{
   Name="Default__UIRoot"
   ObjectArchetype=Object'Core.Default__Object'
}