Cogito, ergo sum

UE3:UTUIDataStore_StringAliasBindingsMap (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 11:47, 6 November 2009 by (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_StringBase >> UIDataStore_StringAliasMap >> UTUIDataStore_StringAliasBindingsMap
Package: 
UTGame
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.

Constants[edit]

SABM_FIND_FIRST_BIND[edit]

Value: -2


Properties[edit]

CommandToBindNames[edit]

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

Modifiers: const, transient, native

Map of command names of the form GBA_ to the key bindings that should be drawn on screen since its heavy on string compares

ControllerMapArray[edit]

Type: array<ControllerMap>

Modifiers: config

Array of mappings for localized text from [GameMappedStrings] to [ButtonFont] for non-PC platforms

Default value, index 0:

Member Value
KeyName 'GMS_XBoxTypeS_A'
PS3Mapping "PS3_X"
XBoxMapping "Xenon_A"

Default value, index 1:

Member Value
KeyName 'GMS_XBoxTypeS_B'
PS3Mapping "PS3_Circle"
XBoxMapping "Xenon_B"

Default value, index 2:

Member Value
KeyName 'GMS_XBoxTypeS_X'
PS3Mapping "PS3_Square"
XBoxMapping "Xenon_X"

Default value, index 3:

Member Value
KeyName 'GMS_XBoxTypeS_Y'
PS3Mapping "PS3_Triangle"
XBoxMapping "Xenon_Y"

Default value, index 4:

Member Value
KeyName 'GMS_XBoxTypeS_Start'
PS3Mapping "PS3_Start"
XBoxMapping "Xenon_Start"

Default value, index 5:

Member Value
KeyName 'GMS_XBoxTypeS_Back'
PS3Mapping "PS3_Select"
XBoxMapping "Xenon_Back"

Default value, index 6:

Member Value
KeyName 'GMS_XBoxTypeS_LeftShoulder'
PS3Mapping "PS3_L1"
XBoxMapping "Xenon_LeftBumper"

Default value, index 7:

Member Value
KeyName 'GMS_XBoxTypeS_RightShoulder'
PS3Mapping "PS3_R1"
XBoxMapping "Xenon_RightBumper"

Default value, index 8:

Member Value
KeyName 'GMS_XBoxTypeS_LeftTrigger'
PS3Mapping "PS3_L2"
XBoxMapping "Xenon_LeftTrigger"

Default value, index 9:

Member Value
KeyName 'GMS_XBoxTypeS_RightTrigger'
PS3Mapping "PS3_R2"
XBoxMapping "Xenon_RightTrigger"

Default value, index 10:

Member Value
KeyName 'GMS_XBoxTypeS_DPad_Up'
PS3Mapping "PS3_DPadUp"
XBoxMapping "Xenon_DPadUp"

Default value, index 11:

Member Value
KeyName 'GMS_XBoxTypeS_DPad_Down'
PS3Mapping "PS3_DPadDown"
XBoxMapping "Xenon_DPadDown"

Default value, index 12:

Member Value
KeyName 'GMS_XBoxTypeS_DPad_Left'
PS3Mapping "PS3_DPadLeft"
XBoxMapping "Xenon_DPadLeft"

Default value, index 13:

Member Value
KeyName 'GMS_XBoxTypeS_DPad_Right'
PS3Mapping "PS3_DPadRight"
XBoxMapping "Xenon_DPadRight"

Default value, index 14:

Member Value
KeyName 'GMS_XBoxTypeS_LeftThumbstick'
PS3Mapping "PS3_LeftStickButton"
XBoxMapping "Xenon_LeftStickButton"

Default value, index 15:

Member Value
KeyName 'GMS_XBoxTypeS_RightThumbstick'
PS3Mapping "PS3_RightStickButton"
XBoxMapping "Xenon_RightStickButton"

Default value, index 16:

Member Value
KeyName 'GMS_XboxTypeS_LeftX'
PS3Mapping "PS3_LeftStick"
XBoxMapping "Xenon_LeftStick"

Default value, index 17:

Member Value
KeyName 'GMS_XboxTypeS_LeftY'
PS3Mapping "PS3_LeftStick"
XBoxMapping "Xenon_LeftStick"

Default value, index 18:

Member Value
KeyName 'GMS_XboxTypeS_RightX'
PS3Mapping "PS3_RightStick"
XBoxMapping "Xenon_RightStick"

Default value, index 19:

Member Value
KeyName 'GMS_XboxTypeS_RightY'
PS3Mapping "PS3_RightStick"
XBoxMapping "Xenon_RightStick"

FakePlatform[edit]

Type: int

Modifiers: config

Debug variable to fake a platform: -1 = Normal, 0 = PC, 1 = XBox360, 2 = PS3

Default value: 1

Default values[edit]

Property Value
MenuInputMapArray[1]
Member Value
FieldName 'GBA_MoveForward'
MenuInputMapArray[2]
Member Value
FieldName 'GBA_Backward'
MenuInputMapArray[3]
Member Value
FieldName 'GBA_StrafeLeft'
MenuInputMapArray[4]
Member Value
FieldName 'GBA_StrafeRight'
MenuInputMapArray[5]
Member Value
FieldName 'GBA_TurnLeft'
MenuInputMapArray[6]
Member Value
FieldName 'GBA_TurnRight'
MenuInputMapArray[7]
Member Value
FieldName 'GBA_Jump'
MenuInputMapArray[8]
Member Value
FieldName 'GBA_Duck'
MenuInputMapArray[9]
Member Value
FieldName 'GBA_Fire'
MenuInputMapArray[10]
Member Value
FieldName 'GBA_AltFire'
MenuInputMapArray[11]
Member Value
FieldName 'GBA_Use'
MenuInputMapArray[12]
Member Value
FieldName 'GBA_FeignDeath'
MenuInputMapArray[13]
Member Value
FieldName 'GBA_SwitchToBestWeapon'
MenuInputMapArray[14]
Member Value
FieldName 'GBA_PrevWeapon'
MenuInputMapArray[15]
Member Value
FieldName 'GBA_NextWeapon'
MenuInputMapArray[16]
Member Value
FieldName 'GBA_SwitchWeapon1'
MenuInputMapArray[17]
Member Value
FieldName 'GBA_SwitchWeapon2'
MenuInputMapArray[18]
Member Value
FieldName 'GBA_SwitchWeapon3'
MenuInputMapArray[19]
Member Value
FieldName 'GBA_SwitchWeapon4'
MenuInputMapArray[20]
Member Value
FieldName 'GBA_SwitchWeapon5'
MenuInputMapArray[21]
Member Value
FieldName 'GBA_SwitchWeapon6'
MenuInputMapArray[22]
Member Value
FieldName 'GBA_SwitchWeapon7'
MenuInputMapArray[23]
Member Value
FieldName 'GBA_SwitchWeapon8'
MenuInputMapArray[24]
Member Value
FieldName 'GBA_SwitchWeapon9'
MenuInputMapArray[25]
Member Value
FieldName 'GBA_SwitchWeapon10'
MenuInputMapArray[26]
Member Value
FieldName 'GBA_ToggleTranslocator'
MenuInputMapArray[27]
Member Value
FieldName 'GBA_ToggleSpeaking'
MenuInputMapArray[28]
Member Value
FieldName 'GBA_Talk'
MenuInputMapArray[29]
Member Value
FieldName 'GBA_TeamTalk'
MenuInputMapArray[30]
Member Value
FieldName 'GBA_Taunt1'
MenuInputMapArray[31]
Member Value
FieldName 'GBA_Taunt2'
MenuInputMapArray[32]
Member Value
FieldName 'GBA_Horn'
MenuInputMapArray[33]
Member Value
FieldName 'GBA_ShowMenu'
MenuInputMapArray[34]
Member Value
FieldName 'GBA_ShowCommandMenu'
MenuInputMapArray[35]
Member Value
FieldName 'GBA_ShowScores'
MenuInputMapArray[36]
Member Value
FieldName 'GBA_ShowMap'
MenuInputMapArray[37]
Member Value
FieldName 'GBA_ToggleMinimap'
MenuInputMapArray[38]
Member Value
FieldName 'GBA_GrowHud'
MenuInputMapArray[39]
Member Value
FieldName 'GBA_ShrinkHud'
MenuInputMapArray[40]
Member Value
FieldName 'GBA_ToggleMelee'
MenuInputMapArray[41]
Member Value
FieldName 'GBA_WeaponPicker'
MenuInputMapArray[42]
Member Value
FieldName 'GBA_Jump_Gamepad'
MenuInputMapArray[43]
Member Value
FieldName 'GBA_MoveForward_Gamepad'
MenuInputMapArray[44]
Member Value
FieldName 'GBA_TurnLeft_Gamepad'
Tag 'StringAliasBindings'

Structs[edit]

BindCacheElement[edit]

Modifiers: native

name KeyName 
string MappingString 
int FieldIndex 

ControllerMap[edit]

Modifiers: native

Struct to map localized text from [GameMappedStrings] to [ButtonFont] for non-PC platforms

name KeyName 
The key - which is a [GameMappedStrings]
string XBoxMapping 
The XBox360 mapping
string PS3Mapping 
The PS3 mapping

Native functions[edit]

AddMappingToBoundKeyCache[edit]

native protected final function AddMappingToBoundKeyCache (string Command, string MappingStr, int FieldIndex)

Given a input command of the form GBA_ and its mapping store that in a lookup for future use

ClearBoundKeyCache[edit]

native final function ClearBoundKeyCache ()

Clear the command to input keybinding cache

FindMappingInBoundKeyCache[edit]

native protected final function bool FindMappingInBoundKeyCache (string Command, out string MappingStr, out int FieldIndex)


GetBoundStringWithFieldName[edit]

native virtual function int GetBoundStringWithFieldName (string FieldName, out string MappedString, optional out int StartIndex, optional out string BindString)

Called by GetStringWithFieldName() to retreive the string using the input binding system.

GetStringWithFieldName[edit]

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

Overrides: UIDataStore_StringAliasMap.GetStringWithFieldName

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.