UE3:UIDataStore_StringAliasMap (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_StringBase >> UIDataStore_StringAliasMap

Package: 

Engine

Direct subclasses:

UTUIDataStore_StringAliasBindingsMap, UTUIDataStore_StringAliasMap

This class in other games:

UT3

This datastore allows games to map aliases to strings that may change based on the current platform or language setting.

Properties

MenuInputMapArray

Type: array<UIMenuInputMap>

Modifiers: config

Array of input string mappings for use in the front end.

MenuInputSets

Type: Object.Map_Mirror{TMap<FName, TMap<FName, INT> >}

Modifiers: const, private, native, transient

collection of list element provider instances that are associated with each ElementProviderType

PlayerIndex

Type: int

Modifiers: const, transient

The index [into the Engine.GamePlayers array] for the player that this data store provides settings for.

Default values

Property	Value
Tag	'StringAliasMap'

Structs

UIMenuInputMap

Modifiers: native

Struct to store the field values and how they map to localized strings

name FieldName 

the name of the input alias; i.e. Accept, Cancel, Conditional1, etc.

name Set 

Name of the platform type this mapping is associated with. Valid values are PC, 360, and PS3.

string MappedText 

The actual markup string corresponding to this alias's letter in [usually] a button font

Native functions

FindMappingWithFieldName

native final function int FindMappingWithFieldName (optional string FieldName, optional string SetName)

Attempts to find a mapping index given a field name.

Parameters:

• FieldName - Fieldname to search for.

Returns:

Returns the index of the mapping in the mapping array, otherwise INDEX_NONE if the mapping wasn't found.

GetPlayerOwner

native final function LocalPlayer GetPlayerOwner () const

Returns a reference to the ULocalPlayer that this PlayerSettingsProvdier provider settings data for

GetStringWithFieldName

native virtual function int GetStringWithFieldName (string FieldName, out string MappedString)

Set MappedString to be the localized string using the FieldName as a key Returns the index into the mapped string array of where it was found.