Navigation
API > API/Plugins > API/Plugins/CommonUI
Base CommonUI metadata implementation for specification in IMC's.
Utilizes a map of input actions to metadata to prevent users from having to create multiple metadata assets / instances. Using this map is not mandatory.
| Name | UCommonMappingContextMetadata |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonUITypes.h |
| Include Path | #include "CommonUITypes.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UCommonMappingContextMetadata :
public UDataAsset ,
public ICommonMappingContextMetadataInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDataAsset → UCommonMappingContextMetadata
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EnhancedInputMetadata | TObjectPtr< UCommonInputMetadata > | Fallback or default metadata CommonUI relies on if no per-action meta is found below | CommonUITypes.h |
|
| PerActionEnhancedInputMetadata | TMap< TObjectPtr< UInputAction >, TObjectPtr< const UCommonInputMetadata > > | Map of action to metadata, allows creation of single metadata asset rather than one per input action type | CommonUITypes.h |
|
Functions
Public
Overridden from ICommonMappingContextMetadataInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const UCommonInputMetadata * GetCommonInputMetadata
(
const UInputAction* InInputAction |
Gets base info needed from CommonUI from this IMC metadata Accepts InputAction as an arg to allow for user to create one metadata with multiple values per action, rather than having to create one metadata asset per unique value | CommonUITypes.h |