Mostly Harmless

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

Contents
Package: 
UTGame
Implemented interfaces: 
UIDataStoreSubscriber
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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.

[edit] Properties

[edit] Property group 'UTUICharacterCustomizationList'

[edit] ArrowColorMouseOver

Type: Object.Color


Default value:

Member Value
A 255
B 189
G 240
R 240

[edit] ArrowColorNormal

Type: Object.Color

Arrow state colors.

Default value:

Member Value
A 192
B 124
G 224
R 224

[edit] ArrowColorPressed

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

[edit] bLeftArrowPressed

Type: bool


[edit] bRightArrowPressed

Type: bool


[edit] LeftRightArrowHeightMultiplier

Type: float


Default value: 0.5

[edit] LeftRightArrowImage

Type: Texture2D

Left/Right Selection Arrow

Default value: Texture2D'UI_HUD.HUD.UI_HUD_BaseC'

[edit] LeftRightArrowOffset

Type: Object.Vector2D

Ratio if scroll ratio width to height.

Default value:

Member Value
X 0.05
Y 0.1

[edit] LeftRightArrowWidthRatio

Type: float

Height of the selection left/right arrow in percentage.

Default value: 1.5

[edit] PartSelectionTextColor

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

[edit] Internal variables

[edit] CurrentlySelectedPartIndex

Type: array<int>

Modifiers: transient


[edit] CurrentlySelectedPartType

Type: UTCustomChar_Data.ECharPart

Modifiers: transient


[edit] CurrentPartSelectionStr

Type: string

Modifiers: transient


[edit] CustomCharDataStore

Type: UTUIDataStore_CustomChar

Modifiers: transient

Mapping of list index's to part enums.

[edit] LeftArrowBounds

Type: float

Array size: 4

Modifiers: transient

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

[edit] ListEnumMap

Type: array<UTCustomChar_Data.ECharPart>

Modifiers: transient


[edit] PartCellTags

Type: array<name>

Modifiers: transient


[edit] PartSelectionPadding

Type: Object.Vector2D

Modifiers: transient

Text information.

[edit] RightArrowBounds

Type: float

Array size: 4

Modifiers: transient


[edit] Default values

Property Value
ScrollWidthRatio 3.0

[edit] Subobjects

[edit] WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIMenuList.WidgetEventComponent

No new values.

[edit] Functions

[edit] Events

[edit] PostInitialize

event PostInitialize ()

Overrides: UTUIMenuList.PostInitialize

Setup the input system

[edit] SelectItem

event SelectItem (int NewSelection)

Overrides: UTUIMenuList.SelectItem

Sets the currently selected list item.

[edit] Other instance functions

[edit] CheckArrowInput

function bool CheckArrowInput (const UIRoot.SubscribedInputEventParameters EventParms)

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

[edit] 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.

[edit] DrawSelectionBG

function DrawSelectionBG (float YPos)

Overrides: UTSimpleList.DrawSelectionBG

Draws the background of the currently selected list element.

[edit] 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

[edit] GetPartIndex

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

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

[edit] GetSelectedCharPartType

function UTCustomChar_Data.ECharPart GetSelectedCharPartType ()

Returns:

Returns the currently selected char part type.

[edit] OnCurrentPartChanged

function OnCurrentPartChanged (optional bool bUpdatePreviewactor)

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

[edit] ProcessInputKey

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)

Overrides: UTSimpleList.ProcessInputKey

UI Input processing handler.

[edit] SelectNextPart

function SelectNextPart ()

Selects the next part for the current part type.

[edit] SelectPrevPart

function SelectPrevPart ()

Selects the previous part for the current part type.

[edit] SetPartSelection

function SetPartSelection (UTCustomChar_Data.ECharPart PartType, string PartID)

Sets the current selection for the specified part type.

Retrieved from "http://wiki.beyondunreal.com/UE3:UTUICharacterCustomizationList_(UT3)"