Difference between revisions of "UE3:UIDataStore InputAlias (UDK)"

Revision as of 06:24, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 06:50, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 6))
(No difference)

---

Latest revision as of 06:50, 17 January 2010

Package: 

Engine

This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

This datastore provides aliases for input keys. These aliases allow gameplay code to be decoupled from actual input key names (which can change based on platform or language) by storing the association between a gameplay concept or event (such as "Jump") with the name of the input key which should trigger that event (such as LeftMouseButton) in a way that can be easily customized for different platforms and/or languages, without the need to touch gameplay code.

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

Properties[edit]

InputAliases[edit]

Type: array<UIDataStoreInputAlias>

Modifiers: protected, config

Defines the list of supported aliases and their associated input keys.

Default value, index 0:

Member	Value
AliasName	'Generic_A'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_A>" InputKeyData Member Value InputKeyName 'XboxTypeS_A'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_A>" InputKeyData Member Value InputKeyName 'XboxTypeS_A'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_X>" InputKeyData Member Value InputKeyName 'XboxTypeS_A'

Default value, index 1:

Member	Value
AliasName	'Generic_B'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_B>" InputKeyData Member Value InputKeyName 'XboxTypeS_B'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_B>" InputKeyData Member Value InputKeyName 'XboxTypeS_B'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Circle>" InputKeyData Member Value InputKeyName 'XboxTypeS_B'

Default value, index 2:

Member	Value
AliasName	'Generic_X'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_X>" InputKeyData Member Value InputKeyName 'XboxTypeS_X'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_X>" InputKeyData Member Value InputKeyName 'XboxTypeS_X'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Square>" InputKeyData Member Value InputKeyName 'XboxTypeS_X'

Default value, index 3:

Member	Value
AliasName	'Generic_Y'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Y>" InputKeyData Member Value InputKeyName 'XboxTypeS_Y'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Y>" InputKeyData Member Value InputKeyName 'XboxTypeS_Y'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Triangle>" InputKeyData Member Value InputKeyName 'XboxTypeS_Y'

Default value, index 4:

Member	Value
AliasName	'Generic_LT'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_L2>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger'

Default value, index 5:

Member	Value
AliasName	'Generic_RT'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightTrigger'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightTrigger'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_R2>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightTrigger'

Default value, index 6:

Member	Value
AliasName	'Generic_LB'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftShoulder'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftShoulder'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_L1>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftShoulder'

Default value, index 7:

Member	Value
AliasName	'Generic_RB'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightShoulder'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightShoulder'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_R1>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightShoulder'

Default value, index 8:

Member	Value
AliasName	'Generic_Start'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Start>" InputKeyData Member Value InputKeyName 'XboxTypeS_Start'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Start>" InputKeyData Member Value InputKeyName 'XboxTypeS_Start'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Start>" InputKeyData Member Value InputKeyName 'XboxTypeS_Start'

Default value, index 9:

Member	Value
AliasName	'Generic_Back'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Back>" InputKeyData Member Value InputKeyName 'XboxTypeS_Back'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Back>" InputKeyData Member Value InputKeyName 'XboxTypeS_Back'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Select>" InputKeyData Member Value InputKeyName 'XboxTypeS_Back'

Default value, index 10:

Member	Value
AliasName	'Generic_DPad_Up'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadUp>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Up'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadUp>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Up'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_DPadUp>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Up'

Default value, index 11:

Member	Value
AliasName	'Generic_DPad_Down'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadDown>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Down'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadDown>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Down'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_DPadDown>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Down'

Default value, index 12:

Member	Value
AliasName	'Generic_DPad_Left'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadLeft>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Left'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadLeft>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Left'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_DPadLeft>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Left'

Default value, index 13:

Member	Value
AliasName	'Generic_DPad_Right'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadRight>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Right'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadRight>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Right'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_DPadRight>" InputKeyData Member Value InputKeyName 'XboxTypeS_DPad_Right'

Default value, index 14:

Member	Value
AliasName	'Gamepad_LeftStick_Up'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadUp>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Up'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadUp>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Up'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_LeftStick>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Up'

Default value, index 15:

Member	Value
AliasName	'Gamepad_LeftStick_Down'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadDown>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Down'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadDown>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Down'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_LeftStick>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Down'

Default value, index 16:

Member	Value
AliasName	'Gamepad_LeftStick_Left'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadLeft>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Left'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadLeft>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Left'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_LeftStick>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Left'

Default value, index 17:

Member	Value
AliasName	'Gamepad_LeftStick_Right'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadRight>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Right'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadRight>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Right'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_LeftStick>" InputKeyData Member Value InputKeyName 'Gamepad_LeftStick_Right'

Default value, index 18:

Member	Value
AliasName	'Gamepad_RightStick_Up'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Up'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Up'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Up'

Default value, index 19:

Member	Value
AliasName	'Gamepad_RightStick_Down'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Down'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Down'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Down'

Default value, index 20:

Member	Value
AliasName	'Gamepad_RightStick_Left'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Left'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Left'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Left'

Default value, index 21:

Member	Value
AliasName	'Gamepad_RightStick_Right'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Right'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Right'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_RightStick>" InputKeyData Member Value InputKeyName 'Gamepad_RightStick_Right'

Default value, index 22:

Member	Value
AliasName	'Generic_LeftStickButton'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftThumbstick'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftThumbstick'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_LeftStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftThumbstick'

Default value, index 23:

Member	Value
AliasName	'Generic_RightStickButton'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightThumbstick'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftThumbstick'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_RightStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightThumbstick'

Default value, index 24:

Member	Value
AliasName	'CycleLeft'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadLeft>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftShoulder'

Default value, index 25:

Member	Value
AliasName	'CycleRight'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_DPadRight>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightShoulder'

Default value, index 26:

Member	Value
AliasName	'AnyKey'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.Generic.Fire>" InputKeyData Member Value InputKeyName '*'

Default value, index 27:

Member	Value
AliasName	'Accept'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_A>" InputKeyData Member Value InputKeyName 'XboxTypeS_A'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_X>" InputKeyData Member Value InputKeyName 'XboxTypeS_A'

Default value, index 28:

Member	Value
AliasName	'Cancel'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_B>" InputKeyData Member Value InputKeyName 'XboxTypeS_B'
PlatformInputKeys[2]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.PS3_Circle>" InputKeyData Member Value InputKeyName 'XboxTypeS_B'

Default value, index 29:

Member	Value
AliasName	'SpecialLeft'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_X>" InputKeyData Member Value InputKeyName 'XboxTypeS_X'

Default value, index 30:

Member	Value
AliasName	'SpecialTop'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Color:R=1,G=1,B=1,A=1><Fonts:UI_Fonts.Fonts.UI_Fonts_Xbox18>Y<Fonts:/><Color:/>" InputKeyData Member Value InputKeyName 'XboxTypeS_Y'

Default value, index 31:

Member	Value
AliasName	'Start'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Start>" InputKeyData Member Value InputKeyName 'XboxTypeS_Start'

Default value, index 32:

Member	Value
AliasName	'Back'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_Back>" InputKeyData Member Value InputKeyName 'XboxTypeS_Back'

Default value, index 33:

Member	Value
AliasName	'ShiftUp'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftShoulder'

Default value, index 34:

Member	Value
AliasName	'ShiftDown'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightBumper>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightShoulder'

Default value, index 35:

Member	Value
AliasName	'ShiftUpPage'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger'

Default value, index 36:

Member	Value
AliasName	'ShiftDownPage'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightTrigger'

Default value, index 37:

Member	Value
AliasName	'ShiftBoth'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftTrigger><Strings:UTGameUI.ButtonFont.Xenon_RightTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger+XboxTypeS_RightTrigger'

Default value, index 38:

Member	Value
AliasName	'Defaults'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftTrigger>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftTrigger'

Default value, index 39:

Member	Value
AliasName	'MouseLeft'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "LEFT MOUSE" InputKeyData Member Value InputKeyName 'LeftMouseButton'

Default value, index 40:

Member	Value
AliasName	'MouseRight'
PlatformInputKeys[0]	Member Value ButtonFontMarkupString "RIGHT MOUSE" InputKeyData Member Value InputKeyName 'RightMouseButton'

Default value, index 41:

Member	Value
AliasName	'ClickLeft'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_LeftStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_LeftThumbstick'

Default value, index 42:

Member	Value
AliasName	'ClickRight'
PlatformInputKeys[1]	Member Value ButtonFontMarkupString "<Strings:UTGameUI.ButtonFont.Xenon_RightStickButton>" InputKeyData Member Value InputKeyName 'XboxTypeS_RightThumbstick'

InputAliasLookupMap[edit]

Type: Map{FName,INT}

Modifiers: protected, const, transient, native

Mapping of input alias name => index into the InputAliases array for the UIDataStoreInputAlias associated with that input alias. Provides a way to quickly access the input key data for an input alias without linear searching. Generated when the data store is registered.

Default values[edit]

Property	Value
Tag	'ButtonCallouts'

Structs[edit]

UIDataStoreInputAlias[edit]

Modifiers: native

Defines a single input alias (i.e. Accept) along with the raw input keys for each platform which should activate that alias.

name AliasName 

The name of the alias which will be referenced by the game (i.e. Accept, Cancel, ShiftUp, etc.).

UIInputKeyData PlatformInputKeys[3] (EInputPlatformType.IPT_MAX) 

Input keys associated with this alias, per platform.

UIInputKeyData[edit]

Modifiers: native

Stores an input key name (and optional modifier keys) and a button icon markup string.

UIRoot.RawInputKeyEventData InputKeyData 

The name of the actual input key (LeftMouseButton) and optional modifiers (Ctrl, Alt, Shift).

string ButtonFontMarkupString 

A string containing data store markup for this key's graph from an icon font. Can refer to the button icon

directly (such as <Fonts:GamepadKeyFont>X<Fonts:/>), or cases where the button itself might be different in another language (e.g. Circle and Square are swapped on PS3 in Japan) can refer to a localized string containing the button markup (i.e. <Strings:UILocFile.ButtonIcons.CircleButton>).

Native functions[edit]

FindInputAliasIndex[edit]

Finds the location [in the InputAliases array] for an input alias.

Parameters:

• DesiredAlias - the name of the alias (i.e. Accept) to find

Returns:

the index into the InputAliases array for the alias, or INDEX_NONE if it doesn't exist.

GetAliasFontMarkup[edit]

Retrieves the button icon font markup string for an input alias

Parameters:

• DesiredAlias - the name of the alias (i.e. Accept) to get the markup string for
• OverridePlatform - specifies which platform's markup string is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the markup string for the button icon associated with the alias.

GetAliasFontMarkupByIndex[edit]

Retrieves the button icon font markup string for an input alias

Parameters:

• AliasIndex - the index [into the InputAliases array] for the alias to get the markup string for.
• OverridePlatform - specifies which platform's markup string is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the markup string for the button icon associated with the alias.

GetAliasInputKeyData[edit]

Retrieves both the input key name and modifier keys for an input alias

Parameters:

• DesiredAlias - the name of the alias (i.e. Accept) to get the input key data for
• OverridePlatform - specifies which platform's markup string is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the struct containing the input key name and modifier keys associated with the alias.

GetAliasInputKeyDataByIndex[edit]

Retrieves both the input key name and modifier keys for an input alias

Parameters:

• AliasIndex - the index [into the InputAliases array] for the alias to get the input key data for.
• OverridePlatform - specifies which platform's markup string is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the struct containing the input key name and modifier keys associated with the alias.

GetAliasInputKeyName[edit]

Retrieves the associated input key name for an input alias

Parameters:

• AliasIndex - the index [into the InputAliases array] for the alias to get the input key for.
• OverridePlatform - specifies which platform's input key is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the name of the input key (i.e. LeftMouseButton) which triggers the alias.

GetAliasInputKeyNameByIndex[edit]

Retrieves the associated input key name for an input alias

Parameters:

• AliasIndex - the index [into the InputAliases array] for the alias to get the input key for.
• OverridePlatform - specifies which platform's markup string is desired; if not specified, uses the current platform, taking into account whether the player is using a gamepad (PC) or a keyboard (console).

Returns:

the name of the input key (i.e. LeftMouseButton) which triggers the alias.

HasAliasMappingForPlatform[edit]

Determines whether an input alias is supported on a particular platform.

Parameters:

• DesiredAlias - the name of the alias (i.e. Accept) to check
• DesiredPlatform - the platform to check for an input key

Returns:

TRUE if the alias has a corresponding input key for the specified platform.