UE3:UINavigationList (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> UIList >> UINavigationList

Package: 

Engine

Implemented interfaces: 

UIDataStorePublisher

A specialized list class which interacts with a special UI sequence object to provide the designer with a very simple, high-level view of the various paths into and out of a scene. Each element in this list will correspond to a selection that takes the user to a different scene. When one of these lists are added to a scene, it will automatically create a special sequence object that generates an output link for each item in the list.

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

Default values

Property	Value
Children[0]	UIScrollbar'Engine.Default__UINavigationList:VertScrollbarTemplate'
Position	Member Value ScaleType[2] EVALPOS_PixelOwner ScaleType[3] EVALPOS_PixelOwner Value[2] 300.0 Value[3] 400.0
VerticalScrollbar	UIScrollbar'Engine.Default__UINavigationList:VertScrollbarTemplate'

Subobjects

ListPresentationComponent

Class: Engine.UIComp_ListPresenter

Inherits from: UIList.ListPresentationComponent

Property	Value
bDisplayColumnHeaders	False
ListItemOverlay[0]	UITexture'Engine.Default__UINavigationList:ListPresentationComponent.NormalOverlayTemplate'
ListItemOverlay[1]	UITexture'Engine.Default__UINavigationList:ListPresentationComponent.ActiveOverlayTemplate'
ListItemOverlay[2]	UITexture'Engine.Default__UINavigationList:ListPresentationComponent.SelectionOverlayTemplate'
ListItemOverlay[3]	UITexture'Engine.Default__UINavigationList:ListPresentationComponent.HoverOverlayTemplate'

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIList.WidgetEventComponent

No new values.

Functions

Static functions

GetGameResourceDataStore

static final function UIDataStore_GameResource GetGameResourceDataStore ()

Returns:

a reference to the gear-specific static game resource data store.

Instance functions

GetItemTagAtIndex

function string GetItemTagAtIndex (int DesiredIndex)

Gets the item tag for the navigaiton item at the specified index.

Parameters:

• DesiredIndex - the index of the element to retrieve the item tag for

Returns:

the path name of the scene associated with the navigation item at the specified index, or an empty string if the specified index is invalid or the list isn't bound to the GameResources data store.

GetScenePathAtIndex

function string GetScenePathAtIndex (int DesiredIndex)

Gets the path name of the scene associated with a list element.

Parameters:

• DesiredIndex - the index of the element to retrieve a scene path name for.

Returns:

the path name of the scene associated with the navigation item at the specified index, or an empty string if the specified index is invalid or the list isn't bound to the GameResources data store.

GetSelectedItemTag

function string GetSelectedItemTag ()

Wrapper for getting the ItemTag for the currently selected list item.

GetSelectedScenePath

function string GetSelectedScenePath ()

Wrapper for getting the path name for the scene associated with the currently selected list item.