I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE3:UTUIDataStore_2DStringList (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataStore >> UTUIDataStore_2DStringList
Package: 
UTGame
Implemented interfaces
UIListElementCellProvider, UIListElementProvider

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

Properties[edit]

ConstEditorListData[edit]

Type: array<SAEditorData>

Modifiers: const


Default value, index 0:

Member Value
ListTags
  1. 'GameList'
  2. 'VoteCount'
Tag 'UTVoteGameList'

Default value, index 1:

Member Value
ListTags
  1. 'MapList'
  2. 'VoteCount'
Tag 'UTVoteMapList'

Default value, index 2:

Member Value
ListTags
  1. 'VoteCount'
  2. 'Mutator'
  3. 'MutVoteIdx'
Tag 'UTVoteMutators'

EditorListData[edit]

Type: array<SAEditorData>

Modifiers: config


ListData[edit]

Type: array<SAArrayData>


Default values[edit]

Property Value
Tag 'UT2DStringList'
WriteAccessType ACCESS_WriteAll

Structs[edit]

SAArrayData[edit]

Modifiers: native

name Tag 
The tag used for binding this data to a list cell
array<SAListData> Lists 
The 2-dimensional string list associated with this tag
array<byte> RowStates 
Used to indicate whether or not a particular row is disabled or enabled (0 or 1); each Lists.Strings element represents a row

SAEditorData[edit]

Modifiers: native

name Tag 
Corresponds to SAArrayData.Tag
array<name> ListTags 
Corresponds to SAArrayData.Lists.ListTag

SAListData[edit]

Modifiers: native

name ListTag 
The tag to use for identifying this list (corresponds to the column cell tag)
string ColumnHeader 
The column header used for this string list
array<string> Strings 
The actual string list

Functions[edit]

Native functions[edit]

GetFieldIndex[edit]

native function int GetFieldIndex (name FieldName)

Parameters:

  • FieldName - Name of the 2D String Array to find

Returns:

the index of a string list

Other instance functions[edit]

AddField[edit]

final function int AddField (name FieldName)


AddFieldList[edit]

final function int AddFieldList (int FieldIdx, name ListName)


AddFieldRow[edit]

final function int AddFieldRow (int FieldIdx, optional const out array<stringRowStrings, optional bool bDisableSelection, optional bool bBatchOp)


EmptyField[edit]

final function EmptyField (name FieldName)


EmptyFieldLists[edit]

final function EmptyFieldLists (name FieldName)


FindFieldListItem[edit]

final function int FindFieldListItem (int FieldIdx, name ListName, string SearchItem)


GetFieldList[edit]

final function GetFieldList (int FieldIdx, name ListName, out array<stringListStrings)


GetFieldListIndex[edit]

final function int GetFieldListIndex (int FieldIdx, name ListName)

Parameters:

  • FieldIdx - Index of the 2D String Array as returned by GetFieldIndex
  • ListName - Name of the string list to find

Returns:

the index of the column within the specified string array

GetFieldListsLength[edit]

final function int GetFieldListsLength (int FieldIdx)


GetFieldRow[edit]

final function GetFieldRow (int FieldIdx, int RowIdx, out array<stringRowStrings)


GetFieldRowElement[edit]

final function string GetFieldRowElement (int FieldIdx, int ColumnIdx, int RowIdx)


GetFieldRowLength[edit]

final function int GetFieldRowLength (int FieldIdx)


InsertFieldListItems[edit]

final function InsertFieldListItems (int FieldIdx, name ListName, int StartRowIdx, const out array<stringListStrings, optional bool bBatchOp)


RemoveField[edit]

final function RemoveField (name FieldName, optional bool bBatchOp)


RemoveFieldList[edit]

final function RemoveFieldList (int FieldIdx, name ListName, optional bool bBatchOp)


RemoveFieldRow[edit]

final function RemoveFieldRow (int FieldIdx, int RowIdx, optional bool bBatchOp)


SetColumnStr[edit]

final function SetColumnStr (int FieldIdx, name ListName, string ColumnStr, optional bool bBatchOp)


SetFieldListsLength[edit]

final function SetFieldListsLength (int FieldIdx, int NewListsLength, optional bool bBatchOp)


SetFieldRowLength[edit]

final function SetFieldRowLength (int FieldIdx, int NewRowLength, optional bool bBatchOp)


UpdateFieldList[edit]

final function UpdateFieldList (int FieldIdx, name ListName, const out array<stringListStrings, optional bool bBatchOp)


UpdateFieldRow[edit]

final function UpdateFieldRow (int FieldIdx, int RowIdx, const out array<stringRowStrings, optional bool bDisableSelection, optional bool bBatchOp)