unreal.GameplayCueFunctionLibrary

class unreal.GameplayCueFunctionLibrary(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: BlueprintFunctionLibrary

UGameplayCueFunctionLibrary

Helpful utility function for working with gameplay cues.

C++ Source:

  • Plugin: GameplayAbilities

  • Module: GameplayAbilities

  • File: GameplayCueFunctionLibrary.h

classmethod add_gameplay_cue_on_actor(target, gameplay_cue_tag, parameters) → None

Invoke the added event for a gameplay cue on the target actor. This should be paired with a RemoveGameplayCueOnActor call. * If the actor has an ability system, the event will fire on authority only and will be replicated. * If the actor does not have an ability system, the event will only be fired locally.

Parameters:
classmethod execute_gameplay_cue_on_actor(target, gameplay_cue_tag, parameters) → None

Invoke a one time “instant” execute event for a gameplay cue on the target actor. * If the actor has an ability system, the event will fire on authority only and will be replicated. * If the actor does not have an ability system, the event will only be fired locally.

Parameters:
classmethod make_gameplay_cue_parameters_from_hit_result(hit_result) → GameplayCueParameters

Builds gameplay cue parameters using data from a hit result.

Parameters:

hit_result (HitResult) –

Return type:

GameplayCueParameters

classmethod remove_gameplay_cue_on_actor(target, gameplay_cue_tag, parameters) → None

Invoke the removed event for a gameplay cue on the target actor. This should be paired with an AddGameplayCueOnActor call. * If the actor has an ability system, the event will fire on authority only and will be replicated. * If the actor does not have an ability system, the event will only be fired locally.

Parameters: