unreal.GameplayBehavior

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

Bases: Object

Gameplay Behavior

C++ Source:

  • Plugin: GameplayBehaviors

  • Module: GameplayBehaviorsModule

  • File: GameplayBehavior.h

Editor Properties: (see get_editor_property/set_editor_property)

  • action_tag (GameplayTag): [Read-Write] Action Tag: Tag identifying behavior this class represents

  • relevant_actors (Array[Actor]): [Read-Write] Relevant Actors: It’s up to the behavior implementation to decide how to use these actors. Can be used as patrol points, investigation location, etc.

k2_abort_behavior(avatar) → None

K2 Abort Behavior

Parameters:

avatar (Actor) –

k2_end_behavior(avatar) → None

K2 End Behavior

Parameters:

avatar (Actor) –

k2_get_next_actor_index_in_sequence(current_index=0) → int32
Parameters:

current_index (int32) –

Returns:

None if there’s no actors or only the one under the index of CurrentIndex is valid

Return type:

int32

k2_on_finished(avatar, was_interrupted) → None

K2 on Finished

Parameters:

  • avatar (Actor) –

  • was_interrupted (bool) –

k2_on_finished_character(avatar, was_interrupted) → None

K2 on Finished Character

Parameters:
k2_on_finished_pawn(avatar, was_interrupted) → None

K2 on Finished Pawn

Parameters:

  • avatar (Pawn) –

  • was_interrupted (bool) –

k2_on_triggered(avatar, config, smart_object_owner) → None

NOTE: on trigger functions - we”ll trigger the most specific one that given behavior implements

Parameters:
k2_on_triggered_character(avatar, config, smart_object_owner) → None

K2 on Triggered Character

Parameters:
k2_on_triggered_pawn(avatar, config, smart_object_owner) → None

K2 on Triggered Pawn

Parameters:
k2_trigger_behavior(avatar, config=None, smart_object_owner=None) → None

K2 Trigger Behavior

Parameters:
property relevant_actors: Array[Actor]

[Read-Write] Relevant Actors: It’s up to the behavior implementation to decide how to use these actors. Can be used as patrol points, investigation location, etc.

Type:

(Array[Actor])