I'm a doctor, not a mechanic

UE3:UTUIDataStore_StringList (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

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

Contents
Package: 
UTGame
Implemented interfaces: 
UIListElementCellProvider, UIListElementProvider
This class in other games:
UDK
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] Constants

[edit] INVALIDFIELD

Value: -1


[edit] Properties

[edit] StringData

Type: array<EStringListData>

Modifiers: config


Default value, index 0:

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

Default value, index 1:

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

Default value, index 2:

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

Default value, index 3:

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

Default value, index 4:

Member Value
ColumnHeaderText "Bot Team"
Strings
  1. "Random"
  2. "Iron Guard"
  3. "Ronin"
  4. "Krall"
  5. "Liandri"
  6. "Necris"
Tag 'BotTeams'

Default value, index 5:

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

Default value, index 6:

Member Value
ColumnHeaderText "Fullscreen"
DefaultValueIndex 1
Strings
  1. "Fullscreen"
  2. "Windowed"
Tag 'FullScreen'

Default value, index 7:

Member Value
ColumnHeaderText "Resolution"
Strings
  1. "800x600"
  2. "960x720"
  3. "1024x768"
  4. "1280x720"
  5. "1600x1200"
Tag 'ScreenResolution'

Default value, index 8:

Member Value
ColumnHeaderText "Button Preset"
Strings
  1. "Preset 1"
  2. "Preset 2"
  3. "Preset 3"
Tag 'PS3ButtonPresets'

Default value, index 9:

Member Value
ColumnHeaderText "Splitscreen"
Strings
  1. "No"
  2. "Yes"
Tag 'Splitscreen'

Default value, index 10:

Member Value
ColumnHeaderText "Uniform"
Strings
  1. "Facemask"
  2. "Helmet"
  3. "Goggles"
  4. "Torso"
  5. "Shoulder Pads"
  6. "Arms"
  7. "Thighs"
  8. "Boots"
Tag 'CharacterParts'

Default value, index 11:

Member Value
ColumnHeaderText "Server Mode"
Strings
  1. "Listen"
  2. "Dedicated"
Tag 'PlayerCardOptions'

Default value, index 12:

Member Value
Strings
  1. "Item1"
  2. "Item2"
  3. "Item3"
  4. "Item4"
Tag 'ComboTest'

Default value, index 13:

Member Value
Strings
Tag 'MissionList'

Default value, index 14:

Member Value
Tag 'PlayerName'

Default value, index 15:

Member Value
ColumnHeaderText "Match Type"
Strings
  1. "Single Player"
  2. "Splitscreen"
  3. "LAN"
  4. "Internet Public"
  5. "Internet Private"
Tag 'MatchTypeCampaign'

Default value, index 16:

Member Value
ColumnHeaderText "Difficulty"
DefaultValueIndex 1
Strings
  1. "Casual"
  2. "Normal"
  3. "Hard"
  4. "Insane"
Tag 'Difficulty'

Default value, index 17:

Member Value
ColumnHeaderText "Bot Combatants"
DefaultValueIndex 1
Strings
  1. "Disabled"
  2. "Enabled"
Tag 'BotCombatants'

Default value, index 18:

Member Value
ColumnHeaderText "Bot Combatants"
DefaultValueIndex 1
Strings
  1. "Disabled"
  2. "Enabled"
  3. "Players vs. Bots 1:1"
  4. "Players vs. Bots 2:3"
  5. "Players vs. Bots 1:2"
Tag 'BotCombatantsRatio'

[edit] Default values

Property Value
Tag 'UTStringList'
WriteAccessType ACCESS_WriteAll

[edit] Structs

[edit] 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

[edit] Functions

[edit] Native functions

[edit] 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()

[edit] 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()

[edit] 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

[edit] GetFieldIndex

native function int GetFieldIndex (name FieldName)

Parameters:

  • FieldName - Name of the String List to find

Returns:

the index of a string list

[edit] 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

[edit] 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.

[edit] 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()

[edit] 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()

[edit] 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()

[edit] Events

[edit] 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.

[edit] GetCurrentValueIndex

event int GetCurrentValueIndex (name FieldName)

Returns the current value index of a given field.

Parameters:

  • FieldName - Field to search.

[edit] 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

[edit] 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.

[edit] SetCurrentValueIndex

event int SetCurrentValueIndex (name FieldName, int NewValueIndex)

Sets the current value index of a given field.

Parameters:

  • FieldName - Field to change.
  • int - NewValueIndex
Retrieved from "http://wiki.beyondunreal.com/UE3:UTUIDataStore_StringList_(UT3)"
Personal tools