There is no spoon

UE3:UTUICharacterCustomizationList (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTSimpleList >> UTUIMenuList >> UTUICharacterCustomizationList
Package: 
UTGame
Implemented interfaces
UIDataStoreSubscriber

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

Specific version of the menu list that draws a number of the currently selected character part.

Properties

Property group 'UTUICharacterCustomizationList'

ArrowColorMouseOver

Type: Object.Color


Default value:

Member Value
A 255
B 189
G 240
R 240

ArrowColorNormal

Type: Object.Color

Arrow state colors.

Default value:

Member Value
A 192
B 124
G 224
R 224

ArrowColorPressed

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

bLeftArrowPressed

Type: bool


bRightArrowPressed

Type: bool


LeftRightArrowHeightMultiplier

Type: float


Default value: 0.5

LeftRightArrowImage

Type: Texture2D

Left/Right Selection Arrow

Default value: Texture2D'UI_HUD.HUD.UI_HUD_BaseC'

LeftRightArrowOffset

Type: Object.Vector2D

Ratio if scroll ratio width to height.

Default value:

Member Value
X 0.05
Y 0.1

LeftRightArrowWidthRatio

Type: float

Height of the selection left/right arrow in percentage.

Default value: 1.5

PartSelectionTextColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

Internal variables

CurrentlySelectedPartIndex

Type: array<int>

Modifiers: transient


CurrentlySelectedPartType

Type: UTCustomChar_Data.ECharPart

Modifiers: transient


CurrentPartSelectionStr

Type: string

Modifiers: transient


CustomCharDataStore

Type: UTUIDataStore_CustomChar

Modifiers: transient

Mapping of list index's to part enums.

LeftArrowBounds

Type: float

Array size: 4

Modifiers: transient

We cache the rendering bounds of the Left/Right arrows for quick mouse look up.

ListEnumMap

Type: array<UTCustomChar_Data.ECharPart>

Modifiers: transient


PartCellTags

Type: array<name>

Modifiers: transient


PartSelectionPadding

Type: Object.Vector2D

Modifiers: transient

Text information.

RightArrowBounds

Type: float

Array size: 4

Modifiers: transient


Default values

Property Value
ScrollWidthRatio 3.0

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIMenuList.WidgetEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIMenuList.PostInitialize

Setup the input system

SelectItem

event SelectItem (int NewSelection)

Overrides: UTUIMenuList.SelectItem

Sets the currently selected list item.

Other instance functions

CheckArrowInput

function bool CheckArrowInput (const UIRoot.SubscribedInputEventParameters EventParms)

Checks to see if the user has clicked on the scroll arrows.

DrawSelectionArrow

function DrawSelectionArrow (float DrawX, float DrawY, float DrawW, float DrawH, float TexU, float TexV, float TexUL, float TexVL, bool bOver, bool bPressed)

Draws one of the left/right selection arrows.

DrawSelectionBG

function DrawSelectionBG (float YPos)

Overrides: UTSimpleList.DrawSelectionBG

Draws the background of the currently selected list element.

GetPartID

function bool GetPartID (UTCustomChar_Data.ECharPart PartType, int PartIndex, out string OutValue)

Returns:

Returns whether or not OutValue contains the partID for the given part type and part index

GetPartIndex

function int GetPartIndex (UTCustomChar_Data.ECharPart PartType, string PartID)

Returns a part index given a part type and part ID.

GetSelectedCharPartType

function UTCustomChar_Data.ECharPart GetSelectedCharPartType ()

Returns:

Returns the currently selected char part type.

OnCurrentPartChanged

function OnCurrentPartChanged (optional bool bUpdatePreviewactor)

Notification for when the current part for the current part type has changed.

ProcessInputKey

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)

Overrides: UTSimpleList.ProcessInputKey

UI Input processing handler.

SelectNextPart

function SelectNextPart ()

Selects the next part for the current part type.

SelectPrevPart

function SelectPrevPart ()

Selects the previous part for the current part type.

SetPartSelection

function SetPartSelection (UTCustomChar_Data.ECharPart PartType, string PartID)

Sets the current selection for the specified part type.