Difference between revisions of "UE3:UIComp DrawString native functions (UDK)"

Revision as of 06:12, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 05:48, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 5))
(No difference)

---

Latest revision as of 05:48, 17 January 2010

UIComp_DrawString native functions 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.

Native functions[edit]

DisableCustomAlignment[edit]

Disables text alignment customization allowing the string to use the values from the applied style.

DisableCustomAttributes[edit]

Disables text attribute customization allowing the string to use the values from the applied style.

DisableCustomAutoScaling[edit]

Disables text autoscale mode customization, allowing the string to use the values from the applied style.

DisableCustomClipAlignment[edit]

Disables clip alignment customization allowing the string to use the values from the applied style.

DisableCustomClipMode[edit]

Disables text clip mode customization allowing the string to use the values from the applied style.

DisableCustomColor[edit]

Disables font color customization allowing the string to use the values from the applied style.

DisableCustomFont[edit]

Disables font customization allowing the string to use the values from the applied style.

DisableCustomOpacity[edit]

Disables the custom opacity level for this comp

DisableCustomPadding[edit]

Disables the custom padding for this component.

DisableCustomScale[edit]

Disables text scale customization allowing the string to use the values from the applied style.

DisableCustomSpacingAdjust[edit]

Disables customization of spacing adjustment between characters and lines of text from the applied style.

EnableSubregion[edit]

Changes the value of bSubregionEnabled for the specified orientation.

Parameters:

• Orientation - the orientation to enable/disable
• bShouldEnable - whether specifying a subregion should be allowed

GetAppliedStringStyle[edit]

Returns the combo style data being used by this string rendering component. If the component's StringStyle is not set, the style data will be pulled from the owning widget's PrimaryStyle, if possible.

Parameters:

• DesiredMenuState - the menu state for the style data to retrieve; if not specified, uses the owning widget's current menu state.

Returns:

the combo style data used to render this component's string for the specified menu state.

Note: noexport because we the native version is also handles optionally resolving the string style data from the active skin, so it takes a few more parameters.

GetFinalStringStyle[edit]

Gets the style data that will be used when rendering this component's string, including all style overrides or customizations enabled for this instance.

Parameters:

• FinalStyleData - will be filled in with the style and formatting values that will be applied to this component's string

Returns:

TRUE if the input value was filled in; FALSE if the component's style is still invalid or couldn't set the output value for any reason.

GetStyleResolverTag[edit]

Specified by: UIStyleResolver.GetStyleResolverTag

Returns the tag assigned to this UIStyleResolver by the owning widget

GetSubregionAlignment[edit]

Returns the alignment of the clamped subregion for a single orientation.

Parameters:

• Orientation - the orientation to retrieve the subregion alignment for

Returns:

the alignment of the clamp subregion for the specified orientation.

GetSubregionOffset[edit]

Returns the offset of the clamped subregion for a single orientation.

Parameters:

• Orientation - the orientation to retrieve the subregion offset for
• OutputType - indicates how the result should be formatted.

Returns:

the offset of the clamp subregion for the specified orientation, relative to the widget's bounding region and formatted according to the value of OutputType.

GetSubregionSize[edit]

Returns the size of the clamped subregion for a single orientation.

Parameters:

• Orientation - the orientation to retrieve the subregion size for
• OutputType - indicates how the result should be formatted.

Returns:

the size of the clamp subregion for the specified orientation, formatted according to the value of OutputType.

GetValue[edit]

Retrieve the value of the string.

Parameters:

• bReturnProcessedText - Determines whether the processed or raw version of the value string is returned. The raw value will contain any markup; the processed string will be text only. Any image tokens are converted to their text counterpart.

Returns:

the complete text value contained by the UIString, in either the processed or unprocessed state.

GetWrapMode[edit]

Wrapper for quickly grabbing the current wrap mode for this component.

IsSubregionEnabled[edit]

Returns TRUE if a subregion clamp is enabled for the specified orientation.

Parameters:

• Orientation - the orientation to check

Returns:

TRUE if a subregion is enabled for the specified orientation

NotifyResolveStyle[edit]

Specified by: UIStyleResolver.NotifyResolveStyle

Resolves the combo style for this string rendering component.

Parameters:

• ActiveSkin - the skin the use for resolving the style reference.
• bClearExistingValue - if TRUE, style references will be invalidated first.
• CurrentMenuState - the menu state to use for resolving the style data; if not specified, uses the current menu state of the owning widget.
• StyleProperty - if specified, only the style reference corresponding to the specified property will be resolved; otherwise, all style references will be resolved.

RefreshValue[edit]

Clears and regenerates all nodes in the string by reparsing the source string.

SetAlignment[edit]

Enables text alignment customization and sets the component's custom alignment value to the value specified.

Parameters:

• Orientation - indicates which orientation to modify
• NewAlignment - the new alignment to use for rendering this component's text

SetAttributes[edit]

Enables text attribute customization and changes the component's override attributes to the value specified.

Parameters:

• NewAttributes - the attributes to use for rendering this component's text

SetAutoScaling[edit]

Enables autoscale customization and changes the component's override autoscalemode to the value specified.

Parameters:

• NewAutoScaleMode - the autoscale mode to use for formatting this component's text
• NewMinScaleValue - the minimum scaling value to apply to the text. if not specified (or a negative value is specified), the min scaling value will not be changed.

SetAutoSizeExtent[edit]

Changes the minimum and maximum auto-size values for this string.

Parameters:

• Orientation - the orientation to enable/disable
• MinValue - the minimum size that auto-sizing should resize to (specify 0 to disable)
• MaxValue - the maximum size that auto-sizing should resize to (specify 0 to disable)
• MinScaleType - the scale type for the minimum value
• MaxScaleType - the scale type for the maximum value

SetClipAlignment[edit]

Enables clip alignment customization and sets the component's custom clip alignment value to the value specified.

Parameters:

• NewClipAlignment - the new clip alignment to use mode for this string.

SetColor[edit]

Enables font color customization and changes the component's override color to the value specified.

Parameters:

• NewColor - the color to use for rendering this component's string

SetFont[edit]

Enables font customization and changes the component's override font to the value specified.

Parameters:

• NewFont - the font to use for rendering this component's text

SetOpacity[edit]

Enables a custom opacity and changes the component's override opacity to the value specified.

Parameters:

• NewOpacity - the alpha to use for rendering this component's string

SetPadding[edit]

Enables custom padding and changes the component's override padding to the value specified.

Parameters:

• HorizontalPadding - new vertical padding value to use (assuming a screen height of DEFAULT_SIZE_Y); will be scaled based on actual resolution. Specify -1 to indicate that VerticalPadding should not be changed (useful when changing only the horizontal padding)

SetScale[edit]

Enables text scale customization and sets the component's custom scale value to the value specified.

Parameters:

• Orientation - indicates which orientation to modify
• NewScale - the new scale to use for rendering this component's text

SetSpacingAdjust[edit]

Enables customization of the spacing adjustment between characters and lines of text

Parameters:

• Orientation - indicates which orientation to modify
• NewSpacingAdjust - the new spacing adjust (in pixels) for rendering this component's text

SetStyleResolverTag[edit]

Specified by: UIStyleResolver.SetStyleResolverTag

Changes the tag assigned to the UIStyleResolver to the specified value.

Returns:

TRUE if the name was changed successfully; FALSE otherwise.

SetSubregionAlignment[edit]

Changes the alignment of the clamped subregion for the specified orientation.

Parameters:

• Orientation - the orientation to update
• NewValue - the new alignment to use

SetSubregionOffset[edit]

Changes the offset of the clamped subregion for the specified orientation.

Parameters:

• Orientation - the orientation to update
• NewValue - the new offset to use
• EvalType - indicates how NewValue should be intepreted

SetSubregionSize[edit]

Changes the size of the clamped subregion for the specified orientation.

Parameters:

• Orientation - the orientation to update
• NewValue - the new size for the subregion.
• EvalType - indicates how NewValue should be intepreted

SetValue[edit]

Changes the value of the text at runtime.

Parameters:

• NewText - the new text that should be displayed

SetWrapMode[edit]

Enables clip mode customization and sets the component's custom clip mode value to the value specified.

Parameters:

• NewClipMode - the new wrapping mode for this string.