UTGame.UTUIDataStore_StringList

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_StringList

Functions Summary
		AddStr (name FieldName, string NewString, optional bool bBatchOp)
		Empty (name FieldName, optional bool bBatchOp)
	INT	FindStr (name FieldName, string SearchString)
	bool	GetCurrentValue (name FieldName, out string out_Value))
	int	GetCurrentValueIndex (name FieldName))
	INT	GetFieldIndex (Name FieldName)
	array<string>	GetList (name FieldName)
	string	GetStr (name FieldName, int StrIndex)
		InsertStr (name FieldName, string NewString, int InsertIndex, optional bool bBatchOp)
	int	Num (name FieldName))
		Registered (LocalPlayer PlayerOwner ))
		RemoveStr (name FieldName, string StringToRemove, optional bool bBatchOp)
		RemoveStrByIndex (name FieldName, int Index, optional int Count=1, optional bool bBatchOp)
	int	SetCurrentValueIndex (name FieldName, int NewValueIndex))

INVALIDFIELD Source code

StringData Source code

EStringListData Source code

ColumnHeaderText:

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

CurrentValue:

the currently selected value from the Strings array

DataProvider:

provider for the list of strings associated with this tag

DefaultValueIndex:

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

Strings:

the available value choices

Tag:

the tag used for binding this data to a list cell

AddStr Source code

Add a string to the list
@Param FieldName The string list to work on
@Param NewString The new string to add
@param bBatchOp if TRUE, doesn't call RefreshSubscribers()

Empty Source code

Empty a string List
@Param FieldName The string list to work on
@param bBatchOp if TRUE, doesn't call RefreshSubscribers()

FindStr Source code

Finds a string in the list
@Param FieldName The string list to add the new string to
@Param SearchStr The string to find
@returns the index in the list or INVALIDFIELD

GetCurrentValue Source code

Returns the current value of a field.
@param FieldName Field to search.
@param out_Value Variable to store the result string in.
@return TRUE if the field was found, FLASE otherwise.

GetCurrentValueIndex Source code

Returns the current value index of a given field.
@param FieldName Field to search.

GetFieldIndex Source code

@param FieldName Name of the String List to find
@return the index of a string list

GetList Source code

Get a list
@Param FieldName The string list to add the new string to
@returns a copy of the list

GetStr Source code

Returns the a string by the index
@Param FieldName The string list to add the new string to
@Param StrIndex The index of the string to get
@returns the string.

InsertStr Source code

Insert a string in to the list at a given index
@Param FieldName The string list to work on
@Param NewString The new string to add
@Param InsertIndex The index where you wish to insert the string
@param bBatchOp if TRUE, doesn't call RefreshSubscribers()

Num Source code

Get the number of strings in a given list
@Param FieldName The string list to work on
@returns the # of strings or -1 if the list does not exist

Registered Source code

Called when this data store is added to the data store manager's list of active data stores.
@param 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.

RemoveStr Source code

Remove a string from the list
@Param FieldName The string list to work on
@Param StringToRemove The string to remove
@param bBatchOp if TRUE, doesn't call RefreshSubscribers()

RemoveStrByIndex Source code

Remove a string (or multiple strings) by the index.
@Param FieldName The string list to work on
@Param Index The index to remove
@Param Count # of strings to remove
@param bBatchOp if TRUE, doesn't call RefreshSubscribers()

SetCurrentValueIndex Source code

Sets the current value index of a given field.
@param FieldName Field to change.
@param int NewValueIndex

defaultproperties
{
   StringData(0)=(Tag="ServerType",ColumnHeaderText="Match Type",DefaultValueIndex=1,Strings=("LAN","Internet"))
   StringData(1)=(Tag="ServerType360",ColumnHeaderText="Match Type",DefaultValueIndex=1,Strings=("System Link","Player","Ranked"))
   StringData(2)=(Tag="MatchType",ColumnHeaderText="Match Type",DefaultValueIndex=1,Strings=("LAN","Internet"))
   StringData(3)=(Tag="MatchType360",ColumnHeaderText="Match Type",DefaultValueIndex=1,Strings=("System Link","Player","Ranked"))
   StringData(4)=(Tag="BotTeams",ColumnHeaderText="Bot Team",Strings=("Random","Iron Guard","Ronin","Krall","Liandri","Necris"))
   StringData(5)=(Tag="RecordDemo",ColumnHeaderText="Demo Recording",Strings=("No","Yes"))
   StringData(6)=(Tag="FullScreen",ColumnHeaderText="Fullscreen",DefaultValueIndex=1,Strings=("Fullscreen","Windowed"))
   StringData(7)=(Tag="ScreenResolution",ColumnHeaderText="Resolution",Strings=("800x600","960x720","1024x768","1280x720","1600x1200"))
   StringData(8)=(Tag="PS3ButtonPresets",ColumnHeaderText="Button Preset",Strings=("Preset 1","Preset 2","Preset 3"))
   StringData(9)=(Tag="Splitscreen",ColumnHeaderText="Splitscreen",Strings=("No","Yes"))
   StringData(10)=(Tag="CharacterParts",ColumnHeaderText="Uniform",Strings=("Facemask","Helmet","Goggles","Torso","Shoulder Pads","Arms","Thighs","Boots"))
   StringData(11)=(Tag="PlayerCardOptions",ColumnHeaderText="Server Mode",Strings=("Listen","Dedicated"))
   StringData(12)=(Tag="ComboTest",Strings=("Item1","Item2","Item3","Item4"))
   StringData(13)=(Tag="MissionList",Strings=())
   StringData(14)=(Tag="PlayerName")
   StringData(15)=(Tag="MatchTypeCampaign",ColumnHeaderText="Match Type",Strings=("Single Player","Splitscreen","LAN","Internet Public","Internet Private"))
   StringData(16)=(Tag="Difficulty",ColumnHeaderText="Difficulty",DefaultValueIndex=1,Strings=("Casual","Normal","Hard","Insane"))
   StringData(17)=(Tag="BotCombatants",ColumnHeaderText="Bot Combatants",DefaultValueIndex=1,Strings=("Disabled","Enabled"))
   StringData(18)=(Tag="BotCombatantsRatio",ColumnHeaderText="Bot Combatants",DefaultValueIndex=1,Strings=("Disabled","Enabled","Players vs. Bots 1:1","Players vs. Bots 2:3","Players vs. Bots 1:2"))
   Tag="UTStringList"
   WriteAccessType=ACCESS_WriteAll
   Name="Default__UTUIDataStore_StringList"
   ObjectArchetype=UIDataStore'Engine.Default__UIDataStore'
}