Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGameplayCueTranslator
- UGameplayCueTranslator_Test
References
| Module | GameplayAbilities |
| Header | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayCueTranslator.h |
| Include | #include "GameplayCueTranslator.h" |
Syntax
UCLASS&40;Abstract&41;
class UGameplayCueTranslator : public UObject
Remarks
This is the base class for GameplayCue Translators. This is what games must extend from in order to add their own rules. These are not instantiated, and are basically just a holder for virtual functions that are called on the CDO.
There are two main things this class provides:
A set of translation rules. E.g., "I translate GameplayCue.A.B.C into GameplayCue.X.B.C", or rather "I translate A into X". (GetTranslationNameSpawns)
A runtime function to actually do the translation, based on the actors and parameters involved in the gameplay cue event. (GameplayCueToTranslationIndex)
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
int32 | GameplayCueToTranslationIndex
(
const FName& TagName, |
Runtime function to mapping Tag/Actor/Parameters to a translation index. The returned index here maps to the array was modified in ::GetTranslationNameSpawns |
   |
int32 | GetPriority () |
Sorting priority. Higher number = first chance to translate a tag. |
   |
void | GetTranslationNameSpawns
(
TArray< FGameplayCueTranslationNameSwap >& SwapList |
Return (via out param) list of tag swaps you will do. This should be deterministic/order matters for later! |
   |
bool | IsEnabled () |
Whether this translator class should be enabled. Useful for disabling WIP translators. |
   |
bool | Whether this translator should be shown in the top level view of the filter tree in the gameplaycue editor. If false, we will only add this as children of top level translators. |