unreal.GameFrameworkInitStateInterface

class unreal.GameFrameworkInitStateInterface(outer: Object | None = None, name: Name | str = 'None')

Bases: Interface

Game Framework Init State Interface

C++ Source:

• Plugin: ModularGameplay

• Module: ModularGameplay

• File: GameFrameworkInitStateInterface.h

get_feature_name() → Name

Returns the feature this object implements, this interface is only meant for simple objects with a single feature like Actor

Return type:

Name

get_init_state() → GameplayTag

Returns the current feature state of this object, the default behavior is to query the manager

Return type:

GameplayTag

has_reached_init_state(desired_state) → bool

Checks the component manager to see if we have already reached the desired state or a later one

Parameters:

desired_state (GameplayTag) –

Return type:

bool

register_and_call_for_init_state_change(required_state, delegate, call_immediately=True) → bool

Binds a BP delegate to get called on a state change for this feature

Parameters:

• required_state (GameplayTag) –

• delegate (ActorInitStateChangedBPDelegate) –

• call_immediately (bool) –

Return type:

bool

unregister_init_state_delegate(delegate) → bool

Unbinds a BP delegate from changes to this feature

Parameters:

delegate (ActorInitStateChangedBPDelegate) –

Return type:

bool