I don't need to test my programs. I have an error-correcting modem.

UE3:UILabel (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UILabel
Package: 
Engine
Implemented interfaces
UIDataStoreSubscriber, UIStringRenderer
Direct subclass:
UIToolTip
This class in other games:
UDK

A simple widget for displaying text in the UI.

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

Properties[edit]

Property group 'Data'[edit]

DataSource[edit]

Type: UIRoot.UIDataStoreBinding

Modifiers: private

the text that will be rendered by this label

Default value:

Member Value
MarkupString "Initial Label Text"

StringRenderComponent[edit]

Type: UIComp_DrawString

Modifiers: editinline, const, noclear

Renders the text displayed by this label

Default value: UIComp_DrawString'LabelStringRenderer'

Property group 'Image'[edit]

LabelBackground[edit]

Type: UIComp_DrawImage

Modifiers: editinline, const

Optional component for rendering a background image for this UILabel

Default values[edit]

Property Value
bSupportsPrimaryStyle False
Position
Member Value
ScaleType[2] EVALPOS_PixelOwner
ScaleType[3] EVALPOS_PixelOwner
Value[2] 100.0
Value[3] 40.0
PrimaryStyle
Member Value
RequiredStyleClass Class'Engine.UIStyle_Combo'

Subobjects[edit]

LabelStringRenderer[edit]

Class: Engine.UIComp_DrawString

No new values.

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

Functions[edit]

Native functions[edit]

ClearBoundDataStores[edit]

native final function ClearBoundDataStores ()

Specified by: UIDataStoreSubscriber.ClearBoundDataStores

Notifies this subscriber to unbind itself from all bound data stores

GetBoundDataStores[edit]

native final virtual function GetBoundDataStores (out array<UIDataStoreout_BoundDataStores)

Specified by: UIDataStoreSubscriber.GetBoundDataStores

Retrieves the list of data stores bound by this subscriber.

Parameters:

  • out_BoundDataStores - receives the array of data stores that subscriber is bound to.

GetDataStoreBinding[edit]

native final virtual function string GetDataStoreBinding (optional int BindingIndex) const

Specified by: UIDataStoreSubscriber.GetDataStoreBinding

Retrieves the markup string corresponding to the data store that this object is bound to.

Parameters:

  • BindingIndex - optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

Returns:

a datastore markup string which resolves to the datastore field that this object is bound to, in the format: <DataStoreTag:DataFieldTag>

NotifyDataStoreValueUpdated[edit]

native final virtual function NotifyDataStoreValueUpdated (UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex)

Specified by: UIDataStoreSubscriber.NotifyDataStoreValueUpdated

Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. notify subscribers when they should refresh their values from this data store.

Parameters:

  • SourceDataStore - the data store that generated the refresh notification; useful for subscribers with multiple data store bindings, to tell which data store sent the notification.
  • PropertyTag - the tag associated with the data field that was updated; Subscribers can use this tag to determine whether there is any need to refresh their data values.
  • SourceProvider - for data stores which contain nested providers, the provider that contains the data which changed.
  • ArrayIndex - for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array or that the entire array was updated.

RefreshSubscriberValue[edit]

native final virtual function bool RefreshSubscriberValue (optional int BindingIndex)

Specified by: UIDataStoreSubscriber.RefreshSubscriberValue

Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store.

Returns:

TRUE if this subscriber successfully resolved and applied the updated value.

SetDataStoreBinding[edit]

native final virtual function SetDataStoreBinding (string MarkupText, optional int BindingIndex)

Specified by: UIDataStoreSubscriber.SetDataStoreBinding

Sets the data store binding for this object to the text specified.

Parameters:

  • MarkupText - a markup string which resolves to data exposed by a data store. The expected format is: <DataStoreTag:DataFieldTag>
  • BindingIndex - optional parameter for indicating which data store binding is being requested for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0.

SetTextAlignment[edit]

native final virtual function SetTextAlignment (UIRoot.EUIAlignment Horizontal, UIRoot.EUIAlignment Vertical)

Specified by: UIStringRenderer.SetTextAlignment

Sets the text alignment for the string that the widget is rendering.

Parameters:

  • Horizontal - Horizontal alignment to use for text, UIALIGN_MAX means no change.
  • Vertical - Vertical alignment to use for text, UIALIGN_MAX means no change.

SetValue[edit]

native final function SetValue (string NewText)

Change the value of this label at runtime.

Parameters:

  • NewText - the new text that should be displayed in the label

Other instance functions[edit]

GetValue[edit]

function string GetValue ()

Retrieve the value of this label

IgnoreMarkup[edit]

final function IgnoreMarkup (bool bShouldIgnoreMarkup)

Changes whether this label's string should process markup

Parameters:

  • bShouldIgnoreMarkup - if TRUE, markup will not be processed by this label's string

Note: does not update any existing text contained by the label.

OnGetTextValue[edit]

function OnGetTextValue (UIAction_GetTextValue Action)

Handler for GetTextValue action.

OnSetLabelText[edit]

function OnSetLabelText (UIAction_SetLabelText Action)

Handler for SetLabelText action.

SetArrayValue[edit]

final function SetArrayValue (array<stringValueArray)

Unrealscript Example[edit]

event PostInitialize()
{
   super.PostInitialize();
//finds widgets in scene and links them to a variable
    AmmoCount = UILabel(FindChild('lblAmmo', true));
//Outputs to log widget name that was loaded to Ammocount Variable
    `log("Widget AmmoCount " $ AmmoCount);
 
if (AmmoCount !=none)
	{
//calls function with string value to be displayed in UIlabel
	DisplayAmmo("999/99");
	}
}
 
function DisplayAmmo(string NewText)
{
	local string CurrentValue;
 
	`log("SETTING DISPLAY AMMO");
//sets string value passed by function
	AmmoCount.SetValue(NewText);
//Verifies correct string was sent to UILabel
	CurrentValue = AmmoCount.GetValue();
	`log("lblAmmo Current Value " $ CurrentValue);
 
//WIP: The UIlabel doesn't yet update onscreen but the text value has been set as verified by the GetValue(); function which retrieves the UILabel's current value.
 
}