UTGame.UTSimpleList

Extends

UTDrawPanel

Modifiers

native ( UI )

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

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTDrawPanel
               |   
               +-- UTGame.UTSimpleList

Direct Known Subclasses:

UTMapVoteList, UTSimpleMenu, UTUIMenuList

Delegates Summary
	bool	OnDrawItem (UTSimpleList SimpleList, int ItemIndex, float XPos, out float YPos))
	bool	OnDrawSelectionBar (UTSimpleList SimpleList, float YPos ))
		OnItemChosen (UTSimpleList SourceList, int SelectedIndex, int PlayerIndex)
	bool	OnPostDrawSelectionBar (UTSimpleList SimpleList, float YPos, float Width, float Height))
		OnSelectionChange (UTSimpleList SourceList, int NewSelectedIndex)

Functions Summary
		AddItem (string Text, optional int Tag=-1))
	float	CalculateSelectionBGPosition (int SelectedIdx))
	float	ComputeListHeightWithSelection (bool bMaximum ))
	bool	CursorCheck (float X1, float Y1, float X2, float Y2))
		DrawItem (int ItemIndex, float XPos, out float YPos))
		DrawPanel ()))
		DrawSelectionBG (float YPos))
		DrawSpecial (float x, float y, float w, float h, float u, float v, float ul, float vl, color DrawColor, bool bOver, bool bPressed))
		DrawStringToFit (string StringToDraw, float XPos, float Y1, float Y2))
		Empty ()))
	int	Find (string SearchText)
	int	FindTag (int SearchTag)
	float	GetDefaultCellHeight ()))
	float	GetItemHeightInPixels (float ItemScale))
	float	GetItemScale (int ItemIdx, float SelectionPosValue, optional out float Alpha))
	Vector	GetMousePosition ()))
	float	GetSelectedCellHeight ()))
		GetSupportedUIActionKeyNames (out array out_KeyNames ))
	int	GetTag ()))
	string	GetText ()))
		ImportStringList (array<string> StringList))
		InsertItem (int Index, string Text, optional int Tag=-1))
	LinearColor	InterpLinearColor (LinearColor A, LinearColor B, float Alpha))
	bool	IsMouseOverMenu ()))
		ItemChosen (int PlayerIndex))
	color	LinearColorToColor (LinearColor Src))
	bool	MouseInBounds ()))
		OnMouseOverMenu (bool bIsOverMenu ))
		PgDn ()))
		PgUp ()))
		PostInitialize ()))
	bool	ProcessInputAxis (const out SubscribedInputEventParameters EventParms ))
	bool	ProcessInputKey (const out SubscribedInputEventParameters EventParms ))
		RefreshBarPosition ()))
		RemoveItem (int IndexToRemove))
		RemoveString (string TextToRemove))
	string	ResolveText (string Markup))
		SelectItem (int NewSelection))
	bool	SelectUnderCursor ()))
		SetBarPositionUsingMouseY ()))
		SetItemSelectionIndex (float SelectionIndex))
		SizeList ()))
		SortList ()
		ToStrings (out array<string> StringList, optional bool bAppend))
		UpdateAnimation (FLOAT DeltaTime)
		UpdateMouseOverMenu ()))

BarPosition Source code

bDownArrowPressed Source code

Whether or not the down arrow is currently pressed.

bDragging Source code

bInvalidated Source code

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

bIsMouseOverMenu Source code

True if the mouse cursor is currently over the menu

bIsUsingMouseNavigation Source code

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

bTransitioning Source code

bUpArrowPressed Source code

Whether or not the up arrow is currently pressed.

DownArrowBounds[4] Source code

DragAdjustment Source code

LastMouseUpdate Source code

LastRenderTime Source code

Last time this scene was rendered

ListHeightInPixel Source code

How big is the list in pixels

OldBarPosition Source code

OldSelection Source code

Index of the previously selected widget.

ResScaling Source code

This is calculated once each frame and cached. It holds the resolution scaling factor

SelectionAlpha Source code

SelectionPos Source code

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

StartSelectionTime Source code

Used to animate the transition from one selection to another.

TargetWindowTop Source code

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

Top Source code

Index of the current top widget

UpArrowBounds[4] Source code

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

WindowHeight Source code

How big is the rendering window

WindowTop Source code

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

WindowTopTransitionTime Source code

UTSimpleList

AboveBelowCellHeightMultiplier Source code

How mucbh to multiply the above and below cells by

AboveBelowColor Source code

ArrowColor Source code

ArrowImage Source code

bHideScrollArrows Source code

bHorizontalList Source code

Whether we are a vertical or horizontal list.

bHotTracking Source code

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

BubbleRadius Source code

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

bWrapList Source code

Whether or not the list should wrap.

DefaultCellHeight Source code

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

List Source code

The list itself.

NormalColor Source code

NormalTextOffset Source code

NormalTextPadding Source code

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

ScrollWidthRatio Source code

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

SelectedColor Source code

SelectedTextOffset Source code

SelectedTextPadding Source code

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

Selection Source code

Index of the currently selected widget

SelectionBarColor Source code

SelectionCellHeightMultiplier Source code

How much to multiply the selected cell by

SelectionImage Source code

Selection Image texture.

SelectionImageBarU Source code

Selection bar image UVs.

SelectionImageBarUL Source code

SelectionImageBarV Source code

SelectionImageBarVL Source code

SelectionImageIconBGU Source code

Selection bar icon bg UVs.

SelectionImageIconBGUL Source code

SelectionImageIconBGV Source code

SelectionImageIconBGVL Source code

ShadowColor Source code

Color of text drop shadow.

ShadowDist Source code

Distance of the text drop shadow.

TextFont Source code

The font to use for rendering

TransitionTime Source code

How fast should we transition between objects

SimpleListData Source code

TransitionAlpha:

Alpha to use to transition this item.

OnDrawItem Source code

This delegate allows anyone to alter the drawing code of the list. @Returns true to skip the default drawing

OnDrawSelectionBar Source code

OnItemChosen Source code

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

OnPostDrawSelectionBar Source code

OnSelectionChange Source code

This delegate is called when the selection index changes

AddItem Source code

Adds an item to the list @Param Text String caption of what to add @Param Tag A generic tag that can be assoicated with this list @ToDo: Add support for resolving markup on assignment.

CalculateSelectionBGPosition Source code

Calculates where the selection bar should be given a selected item index.
@param SelectedIdx Item to calculate selection position for.
@return Returns the position of the selection bar in pixels.

ComputeListHeightWithSelection Source code

Computes the maximum possible height of the list, taking into account 'bubble scaling'
@param bMaximum True to compute the maximum height of the list, or false for the minimum
@return Returns the maximum height of the list in pixels

CursorCheck Source code

All are in pixels @Param X1 Left @Param Y1 Top @Param X2 Right @Param Y2 Bottom @Returns true if the mouse is within the bounds given

DrawItem Source code

Draws an item to the screen. NOTE this function can assume that the item being drawn is not the selected item

DrawPanel Source code

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

DrawSelectionBG Source code

Draw the selection Bar

DrawSpecial Source code

DrawStringToFit Source code

Empty Source code

Empties the list

Find Source code

@Returns the index of the first entry matching SearchText

FindTag Source code

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

GetDefaultCellHeight Source code

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

GetItemHeightInPixels Source code

@return Converts an item's scale height to pixels.

GetItemScale Source code

Calculates the scaling of the item as a value between 1.0f and SelectionCellHeightMultiplier given the item's index and the current selection position.
@param ItemIdx Index of the item to calculate scale for.
@param SelectionPos Current position of the selection bar.
@param Alpha Out variable, between 0.0 - 1.0 of what the widget's transition alpha should be.
@return Returns an item's scale height given the current position of the selection bar.

GetMousePosition Source code

@Returns the mouse position in widget space

GetSelectedCellHeight Source code

@return Returns the height of a selected menu item in pixels.

GetSupportedUIActionKeyNames Source code

GetTag Source code

GetText Source code

ImportStringList Source code

Imports a string list and fills the array @Param StringList The Stringlist to import

InsertItem Source code

Inserts a string somewhere in the stack @Param Text String caption of what to add @Param Tag A generic tag that can be assoicated with this list @ToDo: Add support for resolving markup on assignment.

InterpLinearColor Source code

@return Linearly interpolates between 2 linear colors.

IsMouseOverMenu Source code

Returns true if the mouse cursor is currently over the menu
@return True if the mouse cursor is over the menu

ItemChosen Source code

LinearColorToColor Source code

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

MouseInBounds Source code

OnMouseOverMenu Source code

Called when the mouse cursor moves onto or off of the menu
@param bIsOverMenu True if mouse cursor is over the menu, otherwise false

PgDn Source code

Move down 10 items

PgUp Source code

Move up 10 items

PostInitialize Source code

Setup the input system

ProcessInputAxis Source code

Enable hottracking if we are dragging

ProcessInputKey Source code

RefreshBarPosition Source code

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

RemoveItem Source code

Removes an item from the list

RemoveString Source code

Attempts to find a string then remove it from the list @Param TextToRemove The String to remove

ResolveText Source code

Attempt to resolve markup to it's string value @Returns the resolve text or the original text if unresolable

SelectItem Source code

Selects an item

SelectUnderCursor Source code

Select whichever widget happens to be under the cursor
@return Returns TRUE if we selected something, FALSE otherwise.

SetBarPositionUsingMouseY Source code

Sets the bar position using the current mouse position.

SetItemSelectionIndex Source code

Sets the selection index for all items. This is used to calculate item scaling as the bar moves around.
@param SelectionIndex New selection index for the items, the item's distance from this value in the List array determines how much they scale.

SizeList Source code

SizeList is called directly before rendering anything in the list.

SortList Source code

Sorts the list

ToStrings Source code

@Returns the list as an array of strings

UpdateAnimation Source code

UpdateMouseOverMenu Source code

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

defaultproperties
{
   TextFont=MultiFont'UI_Fonts_Final.Menus.Fonts_Positec'
   NormalColor=(B=64,G=64,R=192,A=255)
   AboveBelowColor=(B=32,G=32,R=128,A=255)
   SelectedColor=(B=255,G=255,R=255,A=255)
   SelectionBarColor=(B=1,G=0,R=64,A=225)
   ArrowColor=(B=1,G=0,R=128,A=255)
   SelectionImage=Texture2D'UI_HUD.HUD.UI_HUD_BaseD'
   SelectionImageIconBGU=260.000000
   SelectionImageIconBGUL=80.000000
   SelectionImageIconBGVL=76.000000
   SelectionImageBarU=340.000000
   SelectionImageBarUL=361.000000
   SelectionImageBarVL=76.000000
   ArrowImage=Texture2D'UI_HUD.HUD.UI_HUD_BaseC'
   DefaultCellHeight=23.000000
   AboveBelowCellHeightMultiplier=1.500000
   SelectionCellHeightMultiplier=3.250000
   ScrollWidthRatio=1.293470
   bHideScrollArrows=True
   bWrapList=True
   SelectedTextPadding=(X=0.000000,Y=0.200000)
   SelectedTextOffset=(X=0.000000,Y=0.050000)
   ShadowDist=1.000000
   ShadowColor=(B=0,G=0,R=0,A=255)
   Selection=-1
   BubbleRadius=2
   DefaultStates(3)=Class'Engine.UIState_Active'
   DefaultStates(4)=Class'Engine.UIState_Pressed'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTDrawPanel:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTSimpleList"
   ObjectArchetype=UTDrawPanel'UTGame.Default__UTDrawPanel'
}