I love the smell of UnrealEd crashing in the morning. – tarquin

Difference between revisions of "UE3:UTSimpleList (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
m (1 revision: class descriptions for UDK January update (part 8))
 
(No difference)

Latest revision as of 06:02, 17 January 2010

UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTDrawPanel >> UTSimpleList

Contents

Package: 
UTGame
Direct subclasses:
UTSimpleMenu, UTUIMenuList
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-2008 Epic Games, Inc. All Rights Reserved.

Properties[edit]

Property group 'UTSimpleList'[edit]

AboveBelowCellHeightMultiplier[edit]

Type: float

How mucbh to multiply the above and below cells by

Default value: 1.5

AboveBelowColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 32
G 32
R 128

ArrowColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 1
G 0
R 128

ArrowImage[edit]

Type: Texture2D


Default value: Texture2D'UI_HUD.HUD.UI_HUD_BaseC'

bHideScrollArrows[edit]

Type: bool


Default value: True

bHorizontalList[edit]

Type: bool

Whether we are a vertical or horizontal list.

bHotTracking[edit]

Type: bool

Whether or not to hot track the current item mouse cursor.

BubbleRadius[edit]

Type: int

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

Default value: 2

bWrapList[edit]

Type: bool

Whether or not the list should wrap.

Default value: True

DefaultCellHeight[edit]

Type: float

This is how big the normal cell of text is at 1024x768.

Default value: 23.0

List[edit]

Type: array<SimpleListData>

Modifiers: editinline

The list itself.

NormalColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 64
G 64
R 192

NormalTextOffset[edit]

Type: Object.Vector2D


NormalTextPadding[edit]

Type: Object.Vector2D

Padding and offset percentage for a normal list item's text.

ScrollWidthRatio[edit]

Type: float

This is the ratio of Height to widget for the selection widget's box. It will be used to size the list

Default value: 1.29347

SelectedColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 255
G 255
R 255

SelectedTextOffset[edit]

Type: Object.Vector2D


Default value:

Member Value
X 0.0
Y 0.05

SelectedTextPadding[edit]

Type: Object.Vector2D

Padding and offset percentage for a selected list item's text.

Default value:

Member Value
X 0.0
Y 0.2

Selection[edit]

Type: int

Modifiers: transient

Index of the currently selected widget

Default value: -1

SelectionBarColor[edit]

Type: Object.Color


Default value:

Member Value
A 225
B 1
G 0
R 64

SelectionCellHeightMultiplier[edit]

Type: float

How much to multiply the selected cell by

Default value: 3.25

SelectionImage[edit]

Type: Texture2D

Selection Image texture.

Default value: Texture2D'UI_HUD.HUD.UI_HUD_BaseD'

SelectionImageBarU[edit]

Type: float

Selection bar image UVs.

Default value: 340.0

SelectionImageBarUL[edit]

Type: float


Default value: 361.0

SelectionImageBarV[edit]

Type: float


SelectionImageBarVL[edit]

Type: float


Default value: 76.0

SelectionImageIconBGU[edit]

Type: float

Selection bar icon bg UVs.

Default value: 260.0

SelectionImageIconBGUL[edit]

Type: float


Default value: 80.0

SelectionImageIconBGV[edit]

Type: float


SelectionImageIconBGVL[edit]

Type: float


Default value: 76.0

ShadowColor[edit]

Type: Object.Color

Color of text drop shadow.

Default value:

Member Value
A 255
B 0
G 0
R 0

ShadowDist[edit]

Type: float

Distance of the text drop shadow.

Default value: 1.0

TextFont[edit]

Type: Font

The font to use for rendering

Default value: MultiFont'UI_Fonts_Final.Menus.Fonts_Positec'

TransitionTime[edit]

Type: float

How fast should we transition between objects

Internal variables[edit]

BarPosition[edit]

Type: float

Modifiers: transient


bDownArrowPressed[edit]

Type: bool

Modifiers: transient

Whether or not the down arrow is currently pressed.

bDragging[edit]

Type: bool

Modifiers: transient


bInvalidated[edit]

Type: bool

Modifiers: transient

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

bIsMouseOverMenu[edit]

Type: bool

Modifiers: transient

True if the mouse cursor is currently over the menu

bIsUsingMouseNavigation[edit]

Type: bool

Modifiers: transient

True if we're currently using the mouse to navigate the menu

bTransitioning[edit]

Type: bool

Modifiers: transient


bUpArrowPressed[edit]

Type: bool

Modifiers: transient

Whether or not the up arrow is currently pressed.

DownArrowBounds[edit]

Type: float

Array size: 4

Modifiers: transient


DragAdjustment[edit]

Type: float

Modifiers: transient


LastMouseUpdate[edit]

Type: float


LastRenderTime[edit]

Type: float

Modifiers: transient

Last time this scene was rendered

ListHeightInPixel[edit]

Type: float

Modifiers: transient

How big is the list in pixels

OldBarPosition[edit]

Type: float

Modifiers: transient


OldSelection[edit]

Type: float

Modifiers: transient

Index of the previously selected widget.

ResScaling[edit]

Type: Object.Vector2D

Modifiers: transient

This is calculated once each frame and cached. It holds the resolution scaling factor that is forced to a 4:3 aspect ratio.

SelectionAlpha[edit]

Type: float

Modifiers: transient


SelectionPos[edit]

Type: float

Modifiers: transient

Floating point selection position (0 .. (List.length - 1))

StartSelectionTime[edit]

Type: float

Modifiers: transient

Used to animate the transition from one selection to another.

TargetWindowTop[edit]

Type: float

Modifiers: transient

Used to animate the scroll. These hold the target top position and the current transition timer

Top[edit]

Type: int

Modifiers: transient

Index of the current top widget

UpArrowBounds[edit]

Type: float

Array size: 4

Modifiers: transient

We cache the rendering bounds of the Up/Down arrows for quick mouse look up.

WindowHeight[edit]

Type: float

Modifiers: transient

How big is the rendering window

WindowTop[edit]

Type: float

Modifiers: transient

Defines the top of the window in to the overall list to begin rendering

WindowTopTransitionTime[edit]

Type: float

Modifiers: transient


Default values[edit]

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

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTDrawPanel.WidgetEventComponent

No new values.

Structs[edit]

SimpleListData[edit]

Modifiers: native

string Text 
int Tag 
float CurHeightMultiplier 
float TransitionAlpha 
Alpha to use to transition this item.
bool bWasRendered 

Default values:

Property Value
CurHeightMultiplier 1.0
TransitionAlpha 1.0

Delegates[edit]

OnDrawItem[edit]

delegate bool OnDrawItem (UTSimpleList 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

OnDrawSelectionBar[edit]

delegate bool OnDrawSelectionBar (UTSimpleList SimpleList, float YPos)


OnItemChosen[edit]

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

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

OnPostDrawSelectionBar[edit]

delegate bool OnPostDrawSelectionBar (UTSimpleList SimpleList, float YPos, float Width, float Height)


OnSelectionChange[edit]

delegate OnSelectionChange (UTSimpleList SourceList, int NewSelectedIndex)

This delegate is called when the selection index changes

Functions[edit]

Native functions[edit]

Find[edit]

native function int Find (string SearchText)

Returns:

the index of the first entry matching SearchText

FindTag[edit]

native function int FindTag (int SearchTag)

Returns:

the index of the first entry with a tag that matches SearchTag

SortList[edit]

native function SortList ()

Sorts the list

UpdateAnimation[edit]

native function UpdateAnimation (float DeltaTime)


Events[edit]

AddItem[edit]

event AddItem (string Text, optional int Tag)

Adds an item to the list

Parameters:

  • Text - String caption of what to add
  • Tag - A generic tag that can be assoicated with this list

ToDo: Add support for resolving markup on assignment.

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 SelectionPosValue, optional out float Alpha)

Calculates the scaling of the item as a value between 1.0f and SelectionCellHeightMultiplier given the item's index and the current selection position.

Parameters:

  • ItemIdx - Index of the item to calculate scale for.
  • SelectionPos - Current position of the selection bar.
  • Alpha - Out variable, between 0.0 - 1.0 of what the widget's transition alpha should be.

Returns:

Returns an item's scale 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

ImportStringList[edit]

event ImportStringList (array<string> StringList)

Imports a string list and fills the array

Parameters:

  • StringList - The Stringlist to import

InsertItem[edit]

event InsertItem (int Index, string Text, optional int Tag)

Inserts a string somewhere in the stack

Parameters:

  • Text - String caption of what to add
  • Tag - A generic tag that can be assoicated with this list

ToDo: Add support for resolving markup on assignment.

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Setup the input system

RefreshBarPosition[edit]

event RefreshBarPosition ()

Refreshes the selection bar's position. Should be used when selection has changed or screen res has changed.

RemoveItem[edit]

event RemoveItem (int IndexToRemove)

Removes an item from the list

RemoveString[edit]

event RemoveString (string TextToRemove)

Attempts to find a string then remove it from the list

Parameters:

  • TextToRemove - The String to remove

SelectItem[edit]

event SelectItem (int NewSelection)

Selects an item

SetItemSelectionIndex[edit]

event SetItemSelectionIndex (float SelectionIndex)

Sets the selection index for all items. This is used to calculate item scaling as the bar moves around.

Parameters:

  • SelectionIndex - New selection index for the items, the item's distance from this value in the List array determines how much they scale.

SizeList[edit]

event SizeList ()

SizeList is called directly before rendering anything in the list.

Other instance functions[edit]

CalculateSelectionBGPosition[edit]

function float CalculateSelectionBGPosition (int SelectedIdx)

Calculates where the selection bar should be given a selected item index.

Parameters:

  • SelectedIdx - Item to calculate selection position for.

Returns:

Returns the position of the selection bar in pixels.

ComputeListHeightWithSelection[edit]

function float ComputeListHeightWithSelection (bool bMaximum)

Computes the maximum possible height of the list, taking into account 'bubble scaling'

Parameters:

  • bMaximum - True to compute the maximum height of the list, or false for the minimum

Returns:

Returns the maximum height of the list in pixels

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. NOTE this function can assume that the item being drawn is not the selected item

DrawSelectionBG[edit]

function DrawSelectionBG (float YPos)

Draw the selection Bar

DrawSpecial[edit]

function DrawSpecial (float x, float y, float w, float h, float u, float v, float ul, float vl, Object.Color DrawColor, bool bOver, bool bPressed)


DrawStringToFit[edit]

function DrawStringToFit (string StringToDraw, float XPos, float Y1, float Y2)


GetDefaultCellHeight[edit]

function float GetDefaultCellHeight ()

Returns:

Returns the height of an menu item (without any 'bubble scaling' applied)

GetItemHeightInPixels[edit]

function float GetItemHeightInPixels (float ItemScale)

Returns:

Converts an item's scale height to pixels.

GetMousePosition[edit]

function Object.Vector GetMousePosition ()

Returns:

the mouse position in widget space

GetSelectedCellHeight[edit]

function float GetSelectedCellHeight ()

Returns:

Returns the height of a selected menu item in pixels.

GetTag[edit]

function int GetTag ()


GetText[edit]

function string GetText ()


InterpLinearColor[edit]

function Object.LinearColor InterpLinearColor (Object.LinearColor A, Object.LinearColor B, float Alpha)

Returns:

Linearly interpolates between 2 linear colors.

IsMouseOverMenu[edit]

function bool IsMouseOverMenu ()

Returns true if the mouse cursor is currently over the menu

Returns:

True if the mouse cursor is over the menu

ItemChosen[edit]

function ItemChosen (int PlayerIndex)


LinearColorToColor[edit]

function Object.Color LinearColorToColor (Object.LinearColor Src)

Returns:

Creates a color from a linear color by clamping values to 0-255.

MouseInBounds[edit]

function bool MouseInBounds ()


OnMouseOverMenu[edit]

function OnMouseOverMenu (bool bIsOverMenu)

Called when the mouse cursor moves onto or off of the menu

Parameters:

  • bIsOverMenu - True if mouse cursor is over the menu, otherwise false

PgDn[edit]

function PgDn ()

Move down 10 items

PgUp[edit]

function PgUp ()

Move up 10 items

ProcessInputAxis[edit]

function bool ProcessInputAxis (const out UIRoot.SubscribedInputEventParameters EventParms)

Enable hottracking if we are dragging

ProcessInputKey[edit]

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)


ResolveText[edit]

function string ResolveText (string Markup)

Attempt to resolve markup to it's string value

Returns:

the resolve text or the original text if unresolable

SelectUnderCursor[edit]

function bool SelectUnderCursor ()

Select whichever widget happens to be under the cursor

Returns:

Returns TRUE if we selected something, FALSE otherwise.

SetBarPositionUsingMouseY[edit]

function SetBarPositionUsingMouseY ()

Sets the bar position using the current mouse position.

ToStrings[edit]

function ToStrings (out array<string> StringList, optional bool bAppend)

Returns:

the list as an array of strings

UpdateMouseOverMenu[edit]

function UpdateMouseOverMenu ()

Updates whether or not the mouse is currently over the menu and runs the appropriate callback if needed

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