Always snap to grid

UE3:UIComp_DrawString (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Component >> UIComponent >> UIComp_DrawComponents >> UIComp_DrawString
Package: 
Engine
Within class: 
UIObject
Implemented interfaces
UIStyleResolver
Direct subclasses:
UIComp_DrawCaption, UIComp_DrawStringEditbox, UIComp_DrawStringSlider, UIComp_UTGlowString
This class in other games:
UT3

This component handles rendering UIStrings for widgets. It is responsible for managing any formatting data that is specific to each widget instance (thus inappropriate for storage in UIStyles).

Properties[edit]

Property group 'Appearance'[edit]

AutoSizeParameters[edit]

Type: UIRoot.AutoSizeData

Array size: 2 (EUIOrientation.UIORIENT_MAX)

Controls whether the owning widget will be automatically resized to display this string's value.

bAllowBoundsAdjustment[edit]

Type: bool

Modifiers: private

Displayed as: Affects Widget Bounds

Controls whether docking is taken into account when determining the boundaries of the string, and whether the widget's position and size could potentially be modified by this component. If the widget only has one string component which takes up the entire widget (such as a label

Default value: True

bDropShadow[edit]

Type: bool

true to draw an automatic dropshadow under the text

ClampRegion[edit]

Type: UIRoot.UIRenderingSubregion

Array size: 2 (EUIOrientation.UIORIENT_MAX)

Modifiers: private

Specifies how much of the available bounding region should be available for rendering the string in.

Default value, index 0:

Member Value
ClampRegionAlignment UIALIGN_Default
ClampRegionOffset
Member Value
ScaleType UIEXTENTEVAL_PercentSelf
ClampRegionSize
Member Value
ScaleType UIEXTENTEVAL_PercentSelf
Value 1.0

Default value, index 1:

Member Value
ClampRegionAlignment UIALIGN_Default
ClampRegionOffset
Member Value
Orientation UIORIENT_Vertical
ScaleType UIEXTENTEVAL_PercentSelf
ClampRegionSize
Member Value
Orientation UIORIENT_Vertical
ScaleType UIEXTENTEVAL_PercentSelf
Value 1.0

DropShadowColor[edit]

Type: Object.LinearColor

Color of the dropshadow

Default value:

Member Value
A 1.0
B 0.0
G 0.0
R 0.0

DropShadowOffset[edit]

Type: Object.Vector2D

Offset to draw the dropshadow

Default value:

Member Value
X 2.0
Y 2.0

Property group 'Data'[edit]

bIgnoreMarkup[edit]

Type: bool

whether the UIString should process markup

Property group 'StyleOverride'[edit]

TextStyleCustomization[edit]

Type: UIRoot.UITextStyleOverride

Contains values for customizing and overriding rendering and formatting values designated by this component's style.

Default value:

Member Value
AutoScaling
Member Value
MinScale 0.6
DrawColor
Member Value
A 1.0
B 1.0
G 1.0
R 1.0
DrawScale[0] 1.0
DrawScale[1] 1.0
Opacity 1.0

Property group 'ZDebug'[edit]

bRefreshString[edit]

Type: bool

Modifiers: transient

Used for debugging strings - causes RefreshValue to be called

Internal variables[edit]

bReapplyFormatting[edit]

Type: bool

Modifiers: transient

set to indicate that this label needs to recalculate the extents for its string

StringClass[edit]

Type: class<UIString>

Modifiers: const, transient

the class to use for creating the ValueString

StringStyle[edit]

Type: UIRoot.UIStyleReference

Modifiers: private

The style to use for rendering this component's string. If the style is invalid, the component will use the owning widget's PrimaryStyle, if possible.

Default value:

Member Value
DefaultStyleTag 'DefaultComboStyle'
RequiredStyleClass Class'Engine.UIStyle_Combo'

StyleResolverTag[edit]

Type: name

The tag used to fulfill the UIStyleResolver interface's GetStyleResolverTag method. Value should be set by the owning widget.

Default value: 'String Style'

SubscriberOwner[edit]

Type: UIDataStoreSubscriber

Modifiers: transient

The subscriber that owns this component. If set, will be added to the refresh delegates for any data stores resolved in the string contained by this component.

ValueString[edit]

Type: UIString

Modifiers: private, transient

The UIString that will render the text. Created at runtime when this component is initialized.

Functions[edit]

Native functions[edit]

See UIComp_DrawString native functions.

Events[edit]

EnableAutoSizing[edit]

final event EnableAutoSizing (UIRoot.EUIOrientation Orientation, bool bShouldEnable)

Changes the value of bAutoSizeEnabled for the specified orientation.

Parameters:

  • Orientation - the orientation to enable/disable
  • bShouldEnable - whether autosizing should be enabled

SetAutoSizePadding[edit]

final event SetAutoSizePadding (UIRoot.EUIOrientation Orientation, float NearValue, float FarValue, UIRoot.EUIExtentEvalType NearScaleType, UIRoot.EUIExtentEvalType FarScaleType)


Other instance functions[edit]

IsAutoSizeEnabled[edit]

final function bool IsAutoSizeEnabled (UIRoot.EUIOrientation Orientation)

Returns TRUE if autosizing is enabled for the specified orientation.

Parameters:

  • Orientation - the orientation to check

Returns:

TRUE if auto-sizing is enabled for the specified orientation