There is no spoon

UE3:UIComp_DrawString (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 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:
UDK

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).

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

Properties

Property group 'Data'

bIgnoreMarkup

Type: bool

whether the UIString should process markup

Property group 'Debug'

bRefreshString

Type: bool

Modifiers: transient

Used for debugging strings - causes RefreshValue to be called

Property group 'Presentation'

AutoSizeParameters

Type: UIRoot.AutoSizeData

Array size: 2 (EUIOrientation.UIORIENT_MAX)

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

ClampRegion

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

Property group 'StyleOverride'

TextStyleCustomization

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

Internal variables

bReapplyFormatting

Type: bool

Modifiers: transient

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

StringClass

Type: class<UIString>

Modifiers: const, transient

the class to use for creating the ValueString

StringStyle

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

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

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

Type: UIString

Modifiers: private, transient

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

Functions

Native functions

See UIComp_DrawString native functions.

Events

EnableAutoSizing

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

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


Other instance functions

IsAutoSizeEnabled

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