I'm a doctor, not a mechanic

UE3:UIStyle (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UIStyle
Package: 
Engine
Within class: 
UISkin
This class in other games:
UT3

Contains a mapping of UIStyle_Data to the UIState each style is associated with.

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

Properties[edit]

Property group 'UIStyle'[edit]

StyleName[edit]

Type: string

Modifiers: localized

Friendly name for this style.

Default value: "Default Style"

Internal variables[edit]

StateDataMap[edit]

Type: Map{class UUIState*,class UUIStyle_Data*}

Modifiers: const, native, transient

map of UIStates to style data associated with that state.

StyleDataClass[edit]

Type: class<UIStyle_Data>

Modifiers: const

the style data class associated with this UIStyle

StyleGroupName[edit]

Type: string

Modifiers: const

Group this style is assigned to.

StyleID[edit]

Type: UIRoot.STYLE_ID

Unique identifier for this style.

StyleTag[edit]

Type: name

Unique non-localized name for this style which is used to reference the style without needing to know its GUID

Functions[edit]

Native functions[edit]

GetStyleForState[edit]

native final function UIStyle_Data GetStyleForState (UIState StateObject) const

Returns the style data associated with the archetype for the UIState specified by StateObject. If this style does not contain any style data for the specified state, this style's archetype is searched, recursively.

Parameters:

  • StateObject - the UIState to search for style data for. StateData is stored by archetype, so the StateDataMap is searched for each object in StateObject's archetype chain until a match is found or we arrive at the class default object for the state.

Returns:

a pointer to style data associated with the UIState specified, or NULL if there is no style data for the specified state in this style or this style's archetypes

GetStyleForStateByClass[edit]

native final function UIStyle_Data GetStyleForStateByClass (class<UIStateStateClass) const

Returns the first style data object associated with an object of the class specified. This function is not reliable in that it can return different style data objects if there are multiple states of the same class in the map (i.e. two archetypes of the same class)

Parameters:

  • StateClass - the class to search for style data for

Returns:

a pointer to style data associated with the UIState specified, or NULL if there is no style data for the specified state in this style or this style's archetypes

Events[edit]

GetDefaultStyle[edit]

final event UIStyle_Data GetDefaultStyle ()