Mostly Harmless

UE3:UTSimpleImageList (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTSimpleImageList
Package: 
UTGame
This class 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.

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

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

Properties[edit]

Property group 'UTSimpleImageList'[edit]

BubbleRadius[edit]

Type: int

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

Default value: 2

DefaultCellHeight[edit]

Type: float


Default value: 128.0

DefaultCellWidth[edit]

Type: float


Default value: 96.0

ImageList[edit]

Type: array<Texture2D>

Modifiers: editinlineuse


Padding[edit]

Type: float


Internal variables[edit]

bInvalidated[edit]

Type: bool

Modifiers: transient

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

bTransitioning[edit]

Type: bool

Modifiers: transient


ItemCount[edit]

Type: int

Modifiers: transient


LastMouseUpdate[edit]

Type: float

Modifiers: transient


LastRenderTime[edit]

Type: float

Modifiers: transient


List[edit]

Type: array<SimpleImageListData>

Modifiers: transient


ListWidthInPixel[edit]

Type: float

Modifiers: transient


ListWidthInPixels[edit]

Type: float

Modifiers: transient


OldSelection[edit]

Type: int

Modifiers: transient


PaddingThisFrame[edit]

Type: float

Modifiers: transient


ResScale[edit]

Type: float

Modifiers: transient


Selection[edit]

Type: int

Modifiers: transient


SelectionAlpha[edit]

Type: float

Modifiers: transient


SelectionModifier[edit]

Type: float

Modifiers: transient


StartSelectionTime[edit]

Type: float

Modifiers: transient


TransitionTime[edit]

Type: float

Modifiers: transient


WindowLeft[edit]

Type: float

Modifiers: transient


WindowScaling[edit]

Type: float

Modifiers: transient


WindowWidth[edit]

Type: float

Modifiers: transient


Default values[edit]

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

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTDrawPanel.WidgetEventComponent

No new values.

Structs[edit]

SimpleImageListData[edit]

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

OnDrawItem[edit]

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

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

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

OnSelectionChange[edit]

delegate OnSelectionChange (UTSimpleImageList SourceList, int NewSelectedIndex)

This delegate is called when the selection index changes

Functions[edit]

Native functions[edit]

UpdateAnimation[edit]

native function UpdateAnimation (float DeltaTime)


Events[edit]

AddItem[edit]

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


DrawPanel[edit]

event DrawPanel ()

Overrides: UTDrawPanel.DrawPanel

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

Empty[edit]

event Empty ()

Empties the list

GetItemScale[edit]

event float GetItemScale (int ItemIdx, float SelectionPos)

Returns:

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

GetSupportedUIActionKeyNames[edit]

event GetSupportedUIActionKeyNames (out array<name> out_KeyNames)

Overrides: UIScreenObject.GetSupportedUIActionKeyNames

Allow Script to add UI Actions

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Setup the input system

RemoveItem[edit]

event RemoveItem (int IndexToRemove)

Removes an item from the list

SelectItem[edit]

event SelectItem (int NewSelection)

Selects an item

SizeList[edit]

event SizeList ()

SizeList is called directly before rendering anything in the list.

Other instance functions[edit]

CursorCheck[edit]

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

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

Draws an item to the screen.

GetItemWidthInPixels[edit]

function float GetItemWidthInPixels (float ItemScale)

Returns:

Converts an item's scale width to pixels.

GetMousePosition[edit]

function Object.Vector GetMousePosition ()

Returns:

the mouse position in widget space

GetSelectedTag[edit]

function name GetSelectedTag ()


ItemChosen[edit]

function ItemChosen (int PlayerIndex)


MouseInBounds[edit]

function bool MouseInBounds ()


ProcessInputKey[edit]

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)


SelectUnderCursor[edit]

function SelectUnderCursor ()

Select whichever widget happens to be under the cursor

SetTransition[edit]

function SetTransition (int ItemIndex, float NewDestinationTransition)

Starts an item down the road to transition

Retrieved from "https://wiki.beyondunreal.com/UE3:UTSimpleImageList_(UDK)?oldid=39461"