- 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
SABM_FIND_FIRST_BIND
Value: -2
Properties
CommandToBindNames
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
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
Type: int
Modifiers: config
Debug variable to fake a platform: -1 = Normal, 0 = PC, 1 = XBox360, 2 = PS3
Default value: 1
Default values
Structs
BindCacheElement
Modifiers: native
- name KeyName
- string MappingString
- int FieldIndex
ControllerMap
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
AddMappingToBoundKeyCache
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
native final function ClearBoundKeyCache ()
Clear the command to input keybinding cache
FindMappingInBoundKeyCache
native protected final function
bool FindMappingInBoundKeyCache (
string Command, out
string MappingStr, out
int FieldIndex)
GetBoundStringWithFieldName
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
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.