UE3:UTUIDataStore_StringList (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_StringBase >> UTUIDataStore_StringList

Package: 

UTGame

Implemented interfaces: 

UIListElementCellProvider, UIListElementProvider

This class in other games:

UT3

Constants

INVALIDFIELD

Value: -1

Properties

StringData

Type: array<EStringListData>

Modifiers: config

Default value, index 0:

Member	Value
ColumnHeaderText	"Match Type"
DefaultValueIndex	1
Strings	"LAN" "Internet"
Tag	'ServerType'

Default value, index 1:

Member	Value
ColumnHeaderText	"Match Type"
DefaultValueIndex	1
Strings	"System Link" "Player" "Ranked"
Tag	'ServerType360'

Default value, index 2:

Member	Value
ColumnHeaderText	"Match Type"
DefaultValueIndex	1
Strings	"LAN" "Internet"
Tag	'MatchType'

Default value, index 3:

Member	Value
ColumnHeaderText	"Match Type"
DefaultValueIndex	1
Strings	"System Link" "Player" "Ranked"
Tag	'MatchType360'

Default value, index 4:

Member	Value
ColumnHeaderText	"Bot Team"
Strings	"Random" "Iron Guard" "Ronin" "Krall" "Liandri" "Necris"
Tag	'BotTeams'

Default value, index 5:

Member	Value
ColumnHeaderText	"Demo Recording"
Strings	"No" "Yes"
Tag	'RecordDemo'

Default value, index 6:

Member	Value
ColumnHeaderText	"Fullscreen"
Strings	"Fullscreen" "Windowed"
Tag	'PlayerName'

Default value, index 7:

Member	Value
ColumnHeaderText	"Resolution"
Strings	"800x600" "960x720" "1024x768" "1280x720" "1600x1200"

Default value, index 8:

Member	Value
ColumnHeaderText	"Button Preset"
Strings	"Preset 1" "Preset 2" "Preset 3"

Default value, index 9:

Member	Value
ColumnHeaderText	"Splitscreen"
Strings	"No" "Yes"

Default value, index 10:

Member	Value
ColumnHeaderText	"Uniform"
Strings	"Facemask" "Helmet" "Goggles" "Torso" "Shoulder Pads" "Arms" "Thighs" "Boots"

Default values

Property	Value
Tag	'UTStringList'
WriteAccessType	ACCESS_WriteAll

Structs

EStringListData

Modifiers: native

name Tag 

the tag used for binding this data to a list cell

string ColumnHeaderText 

the string to use as the column header for cells bound to this field

string CurrentValue 

the currently selected value from the Strings array

int DefaultValueIndex 

the index into the Strings array for the element that should be selected by default

array<string> Strings 

the available value choices

UTUIDataProvider_StringArray DataProvider 

provider for the list of strings associated with this tag

Functions

Native functions

AddStr

native function AddStr (name FieldName, string NewString, optional bool bBatchOp)

Add a string to the list

Parameters:

• FieldName - The string list to work on
• NewString - The new string to add
• bBatchOp - if TRUE, doesn't call RefreshSubscribers()

Empty

native function Empty (name FieldName, optional bool bBatchOp)

Empty a string List

Parameters:

• FieldName - The string list to work on
• bBatchOp - if TRUE, doesn't call RefreshSubscribers()

FindStr

native function int FindStr (name FieldName, string SearchString)

Finds a string in the list

Parameters:

• FieldName - The string list to add the new string to
• SearchStr - The string to find

Returns:

the index in the list or INVALIDFIELD

GetFieldIndex

native function int GetFieldIndex (name FieldName)

Parameters:

• FieldName - Name of the String List to find

Returns:

the index of a string list

GetList

native function array<string> GetList (name FieldName)

Get a list

Parameters:

• FieldName - The string list to add the new string to

Returns:

a copy of the list

GetStr

native function string GetStr (name FieldName, int StrIndex)

Returns the a string by the index

Parameters:

• FieldName - The string list to add the new string to
• StrIndex - The index of the string to get

Returns:

the string.

InsertStr

native function InsertStr (name FieldName, string NewString, int InsertIndex, optional bool bBatchOp)

Insert a string in to the list at a given index

Parameters:

• FieldName - The string list to work on
• NewString - The new string to add
• InsertIndex - The index where you wish to insert the string
• bBatchOp - if TRUE, doesn't call RefreshSubscribers()

RemoveStr

native function RemoveStr (name FieldName, string StringToRemove, optional bool bBatchOp)

Remove a string from the list

Parameters:

• FieldName - The string list to work on
• StringToRemove - The string to remove
• bBatchOp - if TRUE, doesn't call RefreshSubscribers()

RemoveStrByIndex

native function RemoveStrByIndex (name FieldName, int Index, optional int Count, optional bool bBatchOp)

Remove a string (or multiple strings) by the index.

Parameters:

• FieldName - The string list to work on
• Index - The index to remove
• Count - Optional> # of strings to remove
• bBatchOp - if TRUE, doesn't call RefreshSubscribers()

Events

GetCurrentValue

event bool GetCurrentValue (name FieldName, out string out_Value)

Returns the current value of a field.

Parameters:

• FieldName - Field to search.
• out_Value - Variable to store the result string in.

Returns:

TRUE if the field was found, FLASE otherwise.

GetCurrentValueIndex

event int GetCurrentValueIndex (name FieldName)

Returns the current value index of a given field.

Parameters:

• FieldName - Field to search.

Num

event int Num (name FieldName)

Get the number of strings in a given list

Parameters:

• FieldName - The string list to work on

Returns:

the # of strings or -1 if the list does not exist

Registered

event Registered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Registered

Called when this data store is added to the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.

SetCurrentValueIndex

event int SetCurrentValueIndex (name FieldName, int NewValueIndex)

Sets the current value index of a given field.

Parameters:

• FieldName - Field to change.
• int - NewValueIndex