Mostly Harmless

UE3:UTUIDataStore_2DStringList (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataStore >> UTUIDataStore_2DStringList

Contents
Package: 
UTGame
Implemented interfaces: 
UIListElementCellProvider, UIListElementProvider
This is an auto-generated page and may need human attention.
Please remove this 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.

[edit] Properties

[edit] ConstEditorListData

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'

[edit] EditorListData

Type: array<SAEditorData>

Modifiers: config


[edit] ListData

Type: array<SAArrayData>


[edit] Default values

Property Value
Tag 'UT2DStringList'
WriteAccessType ACCESS_WriteAll

[edit] Structs

[edit] SAArrayData

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

[edit] SAEditorData

Modifiers: native

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

[edit] SAListData

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

[edit] Functions

[edit] Native functions

[edit] GetFieldIndex

native function int GetFieldIndex (name FieldName)

Parameters:

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

Returns:

the index of a string list

[edit] Other instance functions

[edit] AddField

final function int AddField (name FieldName)


[edit] AddFieldList

final function int AddFieldList (int FieldIdx, name ListName)


[edit] AddFieldRow

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


[edit] EmptyField

final function EmptyField (name FieldName)


[edit] EmptyFieldLists

final function EmptyFieldLists (name FieldName)


[edit] FindFieldListItem

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


[edit] GetFieldList

final function GetFieldList (int FieldIdx, name ListName, out array<string> ListStrings)


[edit] GetFieldListIndex

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

[edit] GetFieldListsLength

final function int GetFieldListsLength (int FieldIdx)


[edit] GetFieldRow

final function GetFieldRow (int FieldIdx, int RowIdx, out array<string> RowStrings)


[edit] GetFieldRowElement

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


[edit] GetFieldRowLength

final function int GetFieldRowLength (int FieldIdx)


[edit] InsertFieldListItems

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


[edit] RemoveField

final function RemoveField (name FieldName, optional bool bBatchOp)


[edit] RemoveFieldList

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


[edit] RemoveFieldRow

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


[edit] SetColumnStr

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


[edit] SetFieldListsLength

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


[edit] SetFieldRowLength

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


[edit] UpdateFieldList

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


[edit] UpdateFieldRow

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


Retrieved from "http://wiki.beyondunreal.com/UE3:UTUIDataStore_2DStringList_(UT3)"