1. Epic GamesDeveloper
  3. UActorModifierCoreStack

UActorModifierCoreStack

A modifier stack contains modifiers and is also a modifier by itself

API > API/Plugins > API/Plugins/ActorModifierCore

A modifier stack contains modifiers and is also a modifier by itself

   
Name UActorModifierCoreStack
Type class
Header File /Engine/Plugins/VirtualProduction/ActorModifierCore/Source/ActorModifierCore/Public/Modifiers/ActorModifierCoreStack.h
Include Path #include "Modifiers/ActorModifierCoreStack.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, DefaultToInstanced, EditInlineNew)  
class UActorModifierCoreStack : public UActorModifierCoreBase

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FOnModifierAdded TMulticastDelegate_TwoParams< void, UActorModifierCoreBase *, EActorModifierCoreEnableReason >   Modifiers/ActorModifierCoreStack.h
FOnModifierRemoved TMulticastDelegate_TwoParams< void, UActorModifierCoreBase *, EActorModifierCoreDisableReason >   Modifiers/ActorModifierCoreStack.h
FOnModifierUpdated TMulticastDelegate_OneParam< void, UActorModifierCoreBase * >   Modifiers/ActorModifierCoreStack.h

Constants

Name Type Remarks Include Path
OnModifierAddedDelegate FOnModifierAdded Called when a modifier is added to the stack Modifiers/ActorModifierCoreStack.h
OnModifierMovedDelegate FOnModifierUpdated Called when a modifier is moved in the stack Modifiers/ActorModifierCoreStack.h
OnModifierRemovedDelegate FOnModifierRemoved Called when a modifier is removed from the stack Modifiers/ActorModifierCoreStack.h
OnModifierReplacedDelegate FOnModifierUpdated Called when a modifier is replaced in the stack (blueprint) Modifiers/ActorModifierCoreStack.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllModifiersDirty bool   Modifiers/ActorModifierCoreStack.h  
bModifierProfiling bool Enable profiling for the modifiers in this stack Modifiers/ActorModifierCoreStack.h
  • EditInstanceOnly
  • Category="Modifier"
  • Meta=(DisplayName="Enable Profiling")
ExecutionTask FActorModifierCoreExecutionTask   Modifiers/ActorModifierCoreStack.h
  • Transient
  • DuplicateTransient
  • NonTransactional
Modifiers TArray< TObjectPtr< UActorModifierCoreBase > > Contains actual modifiers in the stack Modifiers/ActorModifierCoreStack.h
  • VisibleInstanceOnly
  • NoClear
  • Export
  • Instanced
  • Category="Modifiers"
OnIdleFunctions TArray< TFunction< void()> > Functions to execute once when the stack is on idle Modifiers/ActorModifierCoreStack.h  
OnRestoreFunctions TArray< TFunction< void()> > Functions to execute once when the stack is restored Modifiers/ActorModifierCoreStack.h  
RootExecutionTask TOptional< FActorModifierCoreExecutionTask > Used by root stack to trigger itself Modifiers/ActorModifierCoreStack.h
  • Transient
  • DuplicateTransient
  • NonTransactional

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ContainsModifier ( const UActorModifierCoreBase* InSearchModifier,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

   Modifiers/ActorModifierCoreStack.h  

bool ContainsModifier ( const UClass* InSearchClass,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

   Modifiers/ActorModifierCoreStack.h  

bool ContainsModifier ( const FName& InSearchName,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

 Check that we have a modifier inside this stack, checks also nested stacks Modifiers/ActorModifierCoreStack.h  

UActorModifierCoreBase * FindModifier ( const UClass* InSearchClass,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

   Modifiers/ActorModifierCoreStack.h  

UActorModifierCoreBase * FindModifier ( FName InSearchName,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

 Finds a modifier inside this stack, returns first found, checks also nested stacks Modifiers/ActorModifierCoreStack.h  

TArray< UActorModifierCoreBase * > FindModifiers ( FName InSearchName,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

 Finds modifiers inside this stack, checks also nested stacks Modifiers/ActorModifierCoreStack.h  

TArray< UActorModifierCoreBase * > FindModifiers ( const UClass* InSearchClass,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

   Modifiers/ActorModifierCoreStack.h  

InModifierType * GetClassModifier()

 Gets the first modifier of a specific class only in this stack, does not recurse Modifiers/ActorModifierCoreStack.h  

void GetClassModifiers ( TArray< InModifierType* >& OutModifiers
) const

 Get modifiers of a specific class only in this stack, does not recurse Modifiers/ActorModifierCoreStack.h  

bool GetDependentModifiers ( UActorModifierCoreBase* InModifier,
TSet< UActorModifierCoreBase* >& OutDependentModifiers
) const

 Gets all modifiers found after this one in the stack that depends on this modifier Modifiers/ActorModifierCoreStack.h  

UActorModifierCoreBase * GetFirstModifier()

 Gets the first modifier in this stack, does not recurse Modifiers/ActorModifierCoreStack.h  

UActorModifierCoreBase * GetLastModifier()

 Gets the last modifier in this stack, does not recurse Modifiers/ActorModifierCoreStack.h  

TConstArrayView< UActorModifierCoreBase * > GetModifiers()

 Gets all modifiers in this stack, does not recurse Modifiers/ActorModifierCoreStack.h  

bool GetRequiredModifiers ( UActorModifierCoreBase* InModifier,
TSet< UActorModifierCoreBase* >& OutDependentModifiers
) const

 Gets all modifiers found before this one in the stack that are required by this modifier Modifiers/ActorModifierCoreStack.h  

bool IsRootStack()

 This is the root actor stack if we do not have any parent stack Modifiers/ActorModifierCoreStack.h  

void ProcessFunctionOnIdle ( const TFunction< void()>& InFunction
)

 Execute those function when the stack is on idle, done with updates Modifiers/ActorModifierCoreStack.h  

void ProcessFunctionOnRestore ( const TFunction< void()>& InFunction
)

 Execute those function when the stack is restored, before executing it again Modifiers/ActorModifierCoreStack.h  

bool ProcessSearchFunction ( TFunctionRef< bool(const UActorModifierCoreBase*)> InFunction,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

 Process a search function to use before/after position context, stops when false is returned Modifiers/ActorModifierCoreStack.h  

void SetModifierProfiling ( bool bInProfiling
)

 Set profiling mode for stack and modifiers inside Modifiers/ActorModifierCoreStack.h  

Overridden from UActorModifierCoreBase

Name Remarks Include Path Unreal Specifiers

virtual bool IsModifierEmpty()

 Does this stack contains any modifiers Modifiers/ActorModifierCoreStack.h  

Protected

Name Remarks Include Path Unreal Specifiers
Clone a modifier with options from another stack/actor, returns the newly inserted modifier, supports BATCH operation Modifiers/ActorModifierCoreStack.h  

bool ContainsModifierAfter ( const UActorModifierCoreBase* InSearchModifier,
const UActorModifierCoreBase* InAfterModifier
) const

   Modifiers/ActorModifierCoreStack.h  

bool ContainsModifierAfter ( const FName& InSearchName,
const UActorModifierCoreBase* InAfterModifier
) const

 Checks that we have a modifier with this name inside this stack after another modifier, checks also nested stacks Modifiers/ActorModifierCoreStack.h  

bool ContainsModifierBefore ( const UActorModifierCoreBase* InSearchModifier,
const UActorModifierCoreBase* InBeforeModifier
) const

   Modifiers/ActorModifierCoreStack.h  

bool ContainsModifierBefore ( const FName& InSearchName,
const UActorModifierCoreBase* InBeforeModifier
) const

 Checks that we have a modifier with this name inside this stack before another modifier, checks also nested stacks Modifiers/ActorModifierCoreStack.h  

UActorModifierCoreBase * InsertModifier ( FActorModifierCoreStackInsertOp& InInsertOp
)

 Insert/Add a modifier with options in the stack, returns the newly inserted modifier, supports BATCH operation Modifiers/ActorModifierCoreStack.h  

bool IsModifierStackInitialized()

 Checks whether all modifier in this stack are initialized Modifiers/ActorModifierCoreStack.h  

bool MoveModifier ( FActorModifierCoreStackMoveOp& InMoveOp
)

 Moves a modifier with options in the stack, if fail will return a failing reason, supports BATCH operation Modifiers/ActorModifierCoreStack.h  

bool RemoveAllModifiers()

 Removes all modifiers from this stack in one batch to reduce updates Modifiers/ActorModifierCoreStack.h  

bool RemoveModifier ( FActorModifierCoreStackRemoveOp& InRemoveOp
)

 Removes a modifier from this stack, supports BATCH operation Modifiers/ActorModifierCoreStack.h  

Overridden from UActorModifierCoreBase

Name Remarks Include Path Unreal Specifiers

virtual void Apply()

 Execute this stack and the modifiers it contains Modifiers/ActorModifierCoreStack.h  

virtual bool IsModifierReady()

 A stack will run if all its modifiers are ready to run Modifiers/ActorModifierCoreStack.h  

virtual void OnModifiedActorTransformed()

 Calls OnModifyingActorTransformed of each modifier in the stack if enabled Modifiers/ActorModifierCoreStack.h  
Register this stack to the subsystem to query it later only if root stack Modifiers/ActorModifierCoreStack.h  

virtual void OnModifierDirty ( UActorModifierCoreBase* DirtyModifier,
bool bExecute
)

 Called when a modifier in the stack is dirty Modifiers/ActorModifierCoreStack.h  

virtual void OnModifierDisabled ( EActorModifierCoreDisableReason InReason
)

 Called when the whole stack is disabled, propagates to the children modifiers Modifiers/ActorModifierCoreStack.h  

virtual void OnModifierEnabled ( EActorModifierCoreEnableReason InReason
)

 Called when the whole stack is enabled again, propagates to the children modifiers Modifiers/ActorModifierCoreStack.h  
Unregister this stack to the subsystem and propagates to the children modifiers Modifiers/ActorModifierCoreStack.h  

virtual bool ProcessFunction ( TFunctionRef< bool(const UActorModifierCoreBase*)> InFunction,
const FActorModifierCoreStackSearchOp& InSearchOptions
) const

 Process a function through each modifier in the stack and also the stacks below, stop when we return false Modifiers/ActorModifierCoreStack.h  

virtual void RestorePreState()

 Restore the state before this stack was apply by reversing executed modifiers Modifiers/ActorModifierCoreStack.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Modifiers/ActorModifierCoreStack.h  

Static

Name Remarks Include Path Unreal Specifiers

static UActorModifierCoreStack * Create ( UActorModifierCoreComponent* InComponent,
UActorModifierCoreStack* InParentStack
)

 Create a new stack by passing the actor and the parent stack if there is one Modifiers/ActorModifierCoreStack.h  

static FOnModifierAdded::RegistrationType & OnModifierAdded ()

   Modifiers/ActorModifierCoreStack.h  

static FOnModifierUpdated::RegistrationType & OnModifierMoved()

   Modifiers/ActorModifierCoreStack.h  

static FOnModifierRemoved::RegistrationType & OnModifierRemoved ()

   Modifiers/ActorModifierCoreStack.h  

static FOnModifierUpdated::RegistrationType & OnModifierReplaced()

   Modifiers/ActorModifierCoreStack.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page