I don't need to test my programs. I have an error-correcting modem.

UE3:UIDataStore_StringAliasMap (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 09:11, 17 May 2008 by Wormbo (Talk | contribs) (Auto-generated page)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_StringAliasMap
Package: 
Engine
Direct subclasses:
UTUIDataStore_StringAliasBindingsMap, UTUIDataStore_StringAliasMap
This class in other games:
UDK

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

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

Properties[edit]

MenuInputMapArray[edit]

Type: array<UIMenuInputMap>

Modifiers: config

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

MenuInputSets[edit]

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

Type: int

Modifiers: const, transient

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

Default values[edit]

Property Value
Tag 'StringAliasMap'

Structs[edit]

UIMenuInputMap[edit]

Modifiers: native

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

name FieldName 
name Set 
string MappedText 

Native functions[edit]

FindMappingWithFieldName[edit]

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

native final function LocalPlayer GetPlayerOwner () const

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

GetStringWithFieldName[edit]

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.