1. Epic GamesDeveloper
  3. IGameFrameworkInitStateInterface

IGameFrameworkInitStateInterface

API > API/Plugins > API/Plugins/ModularGameplay > API/Plugins/ModularGameplay/Components

References

   
Module ModularGameplay
Header /Engine/Plugins/Experimental/ModularGameplay/Source/ModularGameplay/Public/Components/GameFrameworkInitStateInterface.h
Include #include "Components/GameFrameworkInitStateInterface.h"

Syntax

class IGameFrameworkInitStateInterface

Variables

  Type Name Description
Protected variable FDelegateHandle ActorInitStateChangedHandle Default handle created from calling BindOnActorInitStateChanged

Functions

  Type Name Description
Public function Virtual void

BindOnActorInitStateChanged ( FName FeatureName,
FGameplayTag RequiredState,
bool bCallIfReached
)

 Call to bind the OnActorInitStateChanged function to the appropriate delegate on the component manager
Public function Virtual Const bool Should be overridden to perform class-specific checks to see if the desired state can be reached
Public function Virtual void Override to try and progress the default initialization path, likely using ContinueInitStateChain
Public function Virtual void This will call CheckDefaultInitialization on all other feature implementers using this interface, useful to update the state of any dependencies
Public function Virtual FGameplayTag

ContinueInitStateChain ( const TArray< FGameplayTag >& InitStateChain
)

 Tries to follow a chain of connected init states, will progress states in order and returns the final state reached
Public function Const UGameFrameworkComponentManager * Gets the component manager corresponding to this object based on owning actor
Public function Virtual Const UFunction BlueprintCallable, Category FName Returns the feature this object implements, this interface is only meant for simple objects with a single feature like Actor
Public function Virtual Const UFunction BlueprintCallable, Category FGameplayTag Returns the current feature state of this object, the default behavior is to query the manager
Public function Virtual Const AActor * Returns the Actor this object is bound to, might be this object
Public function Virtual void Should be overridden to perform class-specific state changes, this is called right before notifying the component manager
Public function Virtual Const UFunction BlueprintCallable, Category bool Checks the component manager to see if we have already reached the desired state or a later one
Public function Virtual void Signature for handling a game feature state, this is not registered by default
Public function Virtual UFunction BlueprintCallable, Category bool

RegisterAndCallForInitStateChange ( FGameplayTag RequiredState,
FActorInitStateChangedBPDelegate Delegate,
bool bCallImmediately
)

 Binds a BP delegate to get called on a state change for this feature
Public function Virtual void Call to register with the component manager during spawn if this is a game world
Public function Virtual bool Checks to see if a change is possible, then calls execute and notify
Public function Virtual UFunction BlueprintCallable, Category bool Unbinds a BP delegate from changes to this feature
Public function Virtual void Unregisters state and delegate binding with component manager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page