Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

UTGame.UTUIDataStore_2DStringList

Extends
UIDataStore
Modifiers
config ( Game ) native ( UI ) transient implements ( UIListElementProvider ) implements ( UIListElementCellProvider )

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

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- UTGame.UTUIDataStore_2DStringList

Variables Summary
array<SAEditorData>ConstEditorListData
array<SAEditorData>EditorListData
array<SAArrayData>ListData
Inherited Variables from Engine.UIDataStore
RefreshSubscriberNotifies, Tag
Inherited Variables from Engine.UIDataProvider
ProviderChangedNotifies, WriteAccessType

Enumerations Summary
Inherited Enumerations from Engine.UIDataProvider
EProviderAccessType

Structures Summary
SAArrayData
Tag, Lists, RowStates
SAEditorData
Tag, ListTags
SAListData
ListTag, ColumnHeader, Strings
Inherited Structures from Engine.UIDataProvider
UIDataProviderField

Functions Summary
functionint AddField (name FieldName))
functionint AddFieldList (int FieldIdx, name ListName))
functionint AddFieldRow (int FieldIdx, optional const out array<string> RowStrings, optional bool bDisableSelection, optional bool bBatchOp))
function EmptyField (name FieldName))
function EmptyFieldLists (name FieldName))
functionint FindFieldListItem (int FieldIdx, name ListName, string SearchItem))
functionint GetFieldIndex (name FieldName)
function GetFieldList (int FieldIdx, name ListName, out array<string> ListStrings))
functionint GetFieldListIndex (int FieldIdx, name ListName))
functionint GetFieldListsLength (int FieldIdx))
function GetFieldRow (int FieldIdx, int RowIdx, out array<string> RowStrings))
functionstring GetFieldRowElement (int FieldIdx, int ColumnIdx, int RowIdx))
functionint GetFieldRowLength (int FieldIdx))
function InsertFieldListItems (int FieldIdx, name ListName, int StartRowIdx, const out array<string> ListStrings, optional bool bBatchOp))
function RemoveField (name FieldName, optional bool bBatchOp))
function RemoveFieldList (int FieldIdx, name ListName, optional bool bBatchOp))
function RemoveFieldRow (int FieldIdx, int RowIdx, optional bool bBatchOp))
function SetColumnStr (int FieldIdx, name ListName, string ColumnStr, optional bool bBatchOp))
function SetFieldListsLength (int FieldIdx, int NewListsLength, optional bool bBatchOp))
function SetFieldRowLength (int FieldIdx, int NewRowLength, optional bool bBatchOp))
function UpdateFieldList (int FieldIdx, name ListName, const out array<string> ListStrings, optional bool bBatchOp))
function UpdateFieldRow (int FieldIdx, int RowIdx, const out array<string> RowStrings, optional bool bDisableSelection, optional bool bBatchOp))
Inherited Functions from Engine.UIDataStore
GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered
Inherited Functions from Engine.UIDataProvider
AddPropertyNotificationChangeRequest, GenerateFillerData, GenerateScriptMarkupString, GetFieldValue, GetSupportedScriptFields, NotifyPropertyChanged, RemovePropertyNotificationChangeRequest, SetFieldValue


Variables Detail

ConstEditorListData Source code

var const array<SAEditorData> ConstEditorListData;

EditorListData Source code

var config array<SAEditorData> EditorListData;

ListData Source code

var array<SAArrayData> ListData;


Structures Detail

SAArrayData Source code

struct SAArrayData
{
var array<SAListData> Lists;
var array<byte> RowStates;
var name Tag;
};

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

SAEditorData Source code

struct SAEditorData
{
var array<name> ListTags;
var name Tag;
};

ListTags:
Corresponds to SAArrayData.Lists.ListTag
Tag:
Corresponds to SAArrayData.Tag

SAListData Source code

struct SAListData
{
var string ColumnHeader;
var name ListTag;
var array<string> Strings;
};

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


Functions Detail

AddField Source code

final function int AddField ( name FieldName) )

AddFieldList Source code

final function int AddFieldList ( int FieldIdx, name ListName) )

AddFieldRow Source code

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

EmptyField Source code

final function EmptyField ( name FieldName) )

EmptyFieldLists Source code

final function EmptyFieldLists ( name FieldName) )

FindFieldListItem Source code

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

GetFieldIndex Source code

native function int GetFieldIndex ( name FieldName )

@param FieldName Name of the 2D String Array to find
@return the index of a string list

GetFieldList Source code

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

GetFieldListIndex Source code

final function int GetFieldListIndex ( int FieldIdx, name ListName) )

@param FieldIdx Index of the 2D String Array as returned by GetFieldIndex
@param ListName Name of the string list to find
@return the index of the column within the specified string array

GetFieldListsLength Source code

final function int GetFieldListsLength ( int FieldIdx) )

GetFieldRow Source code

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

GetFieldRowElement Source code

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

GetFieldRowLength Source code

final function int GetFieldRowLength ( int FieldIdx) )

InsertFieldListItems Source code

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

RemoveField Source code

final function RemoveField ( name FieldName, optional bool bBatchOp) )

RemoveFieldList Source code

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

RemoveFieldRow Source code

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

SetColumnStr Source code

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

SetFieldListsLength Source code

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

SetFieldRowLength Source code

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

UpdateFieldList Source code

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

UpdateFieldRow Source code

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


Defaultproperties

defaultproperties
{
   ConstEditorListData(0)=(Tag="UTVoteGameList",ListTags=("GameList","VoteCount"))
   ConstEditorListData(1)=(Tag="UTVoteMapList",ListTags=("MapList","VoteCount"))
   ConstEditorListData(2)=(Tag="UTVoteMutators",ListTags=("VoteCount","Mutator","MutVoteIdx"))
   Tag="UT2DStringList"
   WriteAccessType=ACCESS_WriteAll
   Name="Default__UTUIDataStore_2DStringList"
   ObjectArchetype=UIDataStore'Engine.Default__UIDataStore'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:58.430 - Created with UnCodeX