UE3:UTSimpleImageList (UT3)

Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTSimpleImageList

Package: 

UTGame

This class in other games:

UDK

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

- This is a simple Horz. List that uses graphics.

Properties

Property group 'UTSimpleImageList'

BubbleRadius

Type: int

Size of the selection bubble, used to calculate alpha for items around the selected item.

Default value: 2

DefaultCellHeight

Type: float

Default value: 128.0

DefaultCellWidth

Type: float

Default value: 96.0

ImageList

Type: array<Texture2D>

Modifiers: editinlineuse

Padding

Type: float

Internal variables

bInvalidated

Type: bool

Modifiers: transient

If true, the positions have been invalidated so recalculate the sizes/etc.

bTransitioning

Type: bool

Modifiers: transient

ItemCount

Type: int

Modifiers: transient

LastMouseUpdate

Type: float

Modifiers: transient

LastRenderTime

Type: float

Modifiers: transient

List

Type: array<SimpleImageListData>

Modifiers: transient

ListWidthInPixel

Type: float

Modifiers: transient

ListWidthInPixels

Type: float

Modifiers: transient

OldSelection

Type: int

Modifiers: transient

PaddingThisFrame

Type: float

Modifiers: transient

ResScale

Type: float

Modifiers: transient

Selection

Type: int

Modifiers: transient

SelectionAlpha

Type: float

Modifiers: transient

SelectionModifier

Type: float

Modifiers: transient

StartSelectionTime

Type: float

Modifiers: transient

TransitionTime

Type: float

Modifiers: transient

WindowLeft

Type: float

Modifiers: transient

WindowScaling

Type: float

Modifiers: transient

WindowWidth

Type: float

Modifiers: transient

Default values

Property	Value
DefaultStates[3]	Class'Engine.UIState_Active'

Subobjects

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTDrawPanel.WidgetEventComponent

No new values.

Structs

SimpleImageListData

Modifiers: native

name Tag 

int Count 

int ImageIndex 

UIRoot.TextureCoordinates UVs 

float CurMultiplier 

float Multipliers[2]  

float TransitionTime 

float TransitionAlpha 

float Bounds[4]  

bool bWasRendered 

Default values:

Property	Value
bWasRendered	False
CurMultiplier	1.0
Multipliers[0]	1.0
Multipliers[1]	1.0
TransitionAlpha	1.0
TransitionTime	0.0

Delegates

OnDrawItem

delegate bool OnDrawItem (UTSimpleImageList SimpleList, int ItemIndex, float XPos, out float YPos)

This delegate allows anyone to alter the drawing code of the list.

Returns:

true to skip the default drawing

OnItemChosen

delegate OnItemChosen (UTSimpleImageList SourceList, int SelectedIndex, int PlayerIndex)

This delegate is called when an item in the list is chosen.

OnSelectionChange

delegate OnSelectionChange (UTSimpleImageList SourceList, int NewSelectedIndex)

This delegate is called when the selection index changes

Functions

Native functions

UpdateAnimation

native function UpdateAnimation (float DeltaTime)

Events

AddItem

event AddItem (name NewTag, int Count, int NewImageIndex, UIRoot.TextureCoordinates NewUVs)

DrawPanel

event DrawPanel ()

Overrides: UTDrawPanel.DrawPanel

Render the list. At this point each cell should be sized, etc.

Empty

event Empty ()

Empties the list

GetItemScale

event float GetItemScale (int ItemIdx, float SelectionPos)

Returns:

Returns an item's height given the current position of the selection bar.

GetSupportedUIActionKeyNames

event GetSupportedUIActionKeyNames (out array<name> out_KeyNames)

Overrides: UIScreenObject.GetSupportedUIActionKeyNames

Allow Script to add UI Actions

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Setup the input system

RemoveItem

event RemoveItem (int IndexToRemove)

Removes an item from the list

SelectItem

event SelectItem (int NewSelection)

Selects an item

SizeList

event SizeList ()

SizeList is called directly before rendering anything in the list.

Other instance functions

CursorCheck

function bool CursorCheck (float X1, float Y1, float X2, float Y2)

All are in pixels

Parameters:

• X1 - Left
• Y1 - Top
• X2 - Right
• Y2 - Bottom

Returns:

true if the mouse is within the bounds given

DrawItem

function DrawItem (int ItemIndex, float XPos, out float YPos)

Draws an item to the screen.

GetItemWidthInPixels

function float GetItemWidthInPixels (float ItemScale)

Returns:

Converts an item's scale width to pixels.

GetMousePosition

function Object.Vector GetMousePosition ()

Returns:

the mouse position in widget space

GetSelectedTag

function name GetSelectedTag ()

ItemChosen

function ItemChosen (int PlayerIndex)

MouseInBounds

function bool MouseInBounds ()

ProcessInputKey

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)

SelectUnderCursor

function SelectUnderCursor ()

Select whichever widget happens to be under the cursor

SetTransition

function SetTransition (int ItemIndex, float NewDestinationTransition)

Starts an item down the road to transition