1. Epic GamesDeveloper
  3. UActorModifierCoreSubsystem

UActorModifierCoreSubsystem

This subsystem handle all modifiers stack active in the engine and allows to create modifiers with registered metadata

API > API/Plugins > API/Plugins/ActorModifierCore

This subsystem handle all modifiers stack active in the engine and allows to create modifiers with registered metadata

   
Name UActorModifierCoreSubsystem
Type class
Header File /Engine/Plugins/VirtualProduction/ActorModifierCore/Source/ActorModifierCore/Public/Subsystems/ActorModifierCoreSubsystem.h
Include Path #include "Subsystems/ActorModifierCoreSubsystem.h"

Syntax

UCLASS ()  
class UActorModifierCoreSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UActorModifierCoreSubsystem()

   Subsystems/ActorModifierCoreSubsystem.h  

Typedefs

Name Type Remarks Include Path
FOnModifierClassRegistered TMulticastDelegate_OneParam< void, const FActorModifierCoreMetadata & >   Subsystems/ActorModifierCoreSubsystem.h
FOnModifierReplaced TMulticastDelegate_TwoParams< void, UActorModifierCoreBlueprintBase *, UActorModifierCoreBlueprintBase * >   Subsystems/ActorModifierCoreSubsystem.h
FOnModifierStackRegistered TMulticastDelegate_OneParam< void, const UActorModifierCoreStack * >   Subsystems/ActorModifierCoreSubsystem.h

Constants

Name Type Remarks Include Path
BlueprintClass const TCHAR *   Subsystems/ActorModifierCoreSubsystem.h
OnModifierClassRegisteredDelegate FOnModifierClassRegistered Called when a modifier class is registered Subsystems/ActorModifierCoreSubsystem.h
OnModifierClassUnregisteredDelegate FOnModifierClassRegistered Called when a modifier class is unregistered Subsystems/ActorModifierCoreSubsystem.h
OnModifierReplacedDelegate FOnModifierReplaced Called when a blueprint modifier gets replaced Subsystems/ActorModifierCoreSubsystem.h
OnModifierStackRegisteredDelegate FOnModifierStackRegistered Called when an actor modifier stack is registered Subsystems/ActorModifierCoreSubsystem.h
OnModifierStackUnregisteredDelegate FOnModifierStackRegistered Called when an actor modifier stack is unregistered Subsystems/ActorModifierCoreSubsystem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

UActorModifierCoreStack * AddActorModifierStack ( AActor* InActor
) const

 This is the correct way to add modifier component to a specific actor if it has none Subsystems/ActorModifierCoreSubsystem.h  

TArray< UActorModifierCoreBase * > AddActorsModifiers ( const TSet< AActor* >& InActors,
FActorModifierCoreStackInsertOp& InAddOp
) const

 Add a modifier to actors, adds a stack automatically if none is found, will update the original array and perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

TArray< UActorModifierCoreBase * > CloneModifiers ( const TArray< UActorModifierCoreBase* >& InModifiers,
UActorModifierCoreStack* InStack,
FActorModifierCoreStackCloneOp& InCloneOp
) const

 Clone modifiers to a specific target modifier position, will perform menu action transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool EnableModifiers ( const TSet< UActorModifierCoreBase* >& InModifiers,
bool bInEnabled,
bool bInShouldTransact
) const

 Enable or disable modifiers, will update the original array and perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool ForEachModifierMetadata ( TFunctionRef< bool(const FActorModifierCoreMetadata&)> InProcessFunction
) const

 Loops through each registered modifier metadata, only used to read Subsystems/ActorModifierCoreSubsystem.h  

UActorModifierCoreStack * GetActorModifierStack ( const AActor* InActor
) const

 This is the correct way to retrieve a modifier stack for a specific actor if it has one Subsystems/ActorModifierCoreSubsystem.h  

TSet< FName > GetAllowedModifiers ( AActor* InActor,
UActorModifierCoreBase* InContextModifier,
EActorModifierCoreStackPosition InContextPosition
) const

 Returns the modifiers names that are allowed for specific actor/stack and before another modifier Subsystems/ActorModifierCoreSubsystem.h  

TArray< UActorModifierCoreBase * > GetAllowedMoveModifiers ( UActorModifierCoreBase* InMoveModifier
) const

 Returns modifiers from the stack where we can move the provided modifier, required and dependent modifiers from this MoveModifier will not appear in the list Subsystems/ActorModifierCoreSubsystem.h  

TSet< FName > GetCategoryModifiers ( const FName& InCategory
) const

 Returns the modifiers name that match a specific category Subsystems/ActorModifierCoreSubsystem.h  

TSet< FName > GetHiddenModifiers()

 Returns the modifiers hidden to the user Subsystems/ActorModifierCoreSubsystem.h  

TSet< FName > GetModifierCategories()

 Returns the categories for all registered modifiers Subsystems/ActorModifierCoreSubsystem.h  

FName GetModifierCategory ( const FName& InModifier
) const

 Returns the category this modifier is in Subsystems/ActorModifierCoreSubsystem.h  

UActorModifierCoreSharedObject * GetModifierSharedObject ( ULevel* InLevel,
TSubclassOf< UActorModifierCoreSharedObject > InClass,
bool bInCreateIfNone
) const

 Get modifier shared object from a specific level and class, only one or none can exists per level Subsystems/ActorModifierCoreSubsystem.h  

const AActor * GetModifierStackActor ( const UActorModifierCoreStack* InStack
) const

 Return the actor this stack is linked to Subsystems/ActorModifierCoreSubsystem.h  

TSubclassOf< UActorModifierCoreBase > GetRegisteredModifierClass ( FName InModifierName
) const

 Return the modifier class from the modifier name provided Subsystems/ActorModifierCoreSubsystem.h  

TSet< TSubclassOf< UActorModifierCoreBase > > GetRegisteredModifierClasses()

 Return a set of class for all modifiers registered Subsystems/ActorModifierCoreSubsystem.h  

FName GetRegisteredModifierName ( const UClass* InModifierClass
) const

 Return the modifier name or none from the modifier class provided Subsystems/ActorModifierCoreSubsystem.h  

TSet< FName > GetRegisteredModifiers()

 Returns the name of modifiers that are currently registered Subsystems/ActorModifierCoreSubsystem.h  

void GetSortedModifiers ( const TSet< UActorModifierCoreBase* >& InModifiers,
AActor* InTargetActor,
UActorModifierCoreBase* InTargetModifier,
EActorModifierCoreStackPosition InPosition,
TArray< UActorModifierCoreBase* >& OutMoveModifiers,
TArray< UActorModifierCoreBase* >& OutCloneModifiers
) const

 Get order dependent modifiers in the correct order for stack operations Subsystems/ActorModifierCoreSubsystem.h  

UActorModifierCoreBase * InsertModifier ( UActorModifierCoreStack* InStack,
FActorModifierCoreStackInsertOp& InInsertOp
) const

 Insert a modifier in a stack before or after another modifier, will perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool IsRegisteredModifierClass ( const UClass* InClass
) const

   Subsystems/ActorModifierCoreSubsystem.h  

bool IsRegisteredModifierClass ( const FName& InName
) const

   Subsystems/ActorModifierCoreSubsystem.h  

bool MoveModifier ( UActorModifierCoreStack* InStack,
FActorModifierCoreStackMoveOp& InMoveOp
) const

 Moves a modifier in a stack before or after another modifier, will perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool MoveModifiers ( const TArray< UActorModifierCoreBase* >& InModifiers,
UActorModifierCoreStack* InStack,
FActorModifierCoreStackMoveOp& InMoveOp
) const

 Move modifiers to a specific target modifier position, will perform menu action transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool ProcessModifierMetadata ( const FName& InName,
TFunctionRef< bool(const FActorModifierCoreMetadata&)> InProcessFunction
) const

 Process this on matching registered metadata, only used to read Subsystems/ActorModifierCoreSubsystem.h  

bool RegisterModifierClass ( const UClass* InModifierClass,
bool bInOverrideIfExists
)

 Register a modifier class or override an already existing one Subsystems/ActorModifierCoreSubsystem.h  

bool RemoveActorsModifiers ( const TSet< AActor* >& InActors,
bool bInShouldTransact
) const

 Remove all modifiers from actors, will update the original array and perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool RemoveModifiers ( const TSet< UActorModifierCoreBase* >& InModifiers,
FActorModifierCoreStackRemoveOp& InRemoveOp
) const

 Remove modifiers from different actors or stacks, will update the original array and perform a transaction if wanted Subsystems/ActorModifierCoreSubsystem.h  

bool RemoveModifierStacks ( const TSet< UActorModifierCoreStack* >& InStacks,
bool bInShouldTransact
) const

 Removes modifier components and modifier stacks Subsystems/ActorModifierCoreSubsystem.h  

bool UnregisterModifierClass ( const FName& InName
)

   Subsystems/ActorModifierCoreSubsystem.h  

bool UnregisterModifierClass ( const UClass* InModifierClass
)

   Subsystems/ActorModifierCoreSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool BuildModifierDependencies ( const FName& InName,
TArray< FName >& OutBeforeModifiers
) const

 Builds a modifier dependency list, does not make additional checks Subsystems/ActorModifierCoreSubsystem.h  

UActorModifierCoreBase * CreateModifierInstance ( const FName& InName,
UActorModifierCoreStack* InStack,
FText& OutFailReason,
UActorModifierCoreBase* InBeforeModifier
) const

 Creates a modifier based on a name and a stack, should be called by the stack itself Subsystems/ActorModifierCoreSubsystem.h  

AActorModifierCoreSharedActor * GetModifierSharedProvider ( ULevel* InLevel,
bool bInSpawnIfNotFound
) const

 Gets a modifier shared provider for a world, creates one if none is found Subsystems/ActorModifierCoreSubsystem.h  
Do we have a registered root stack Subsystems/ActorModifierCoreSubsystem.h  

bool IsRegisteredActorModifierStack ( const AActor* InActor
) const

 Do we have a root modifier stack for this actor Subsystems/ActorModifierCoreSubsystem.h  

void OnAssetRegistryAssetAdded ( const FAssetData& InAssetData
)

   Subsystems/ActorModifierCoreSubsystem.h  

void OnAssetRegistryAssetRemoved ( const FAssetData& InAssetData
)

   Subsystems/ActorModifierCoreSubsystem.h  

void OnAssetRegistryAssetUpdated ( const FAssetData& InAssetData
)

   Subsystems/ActorModifierCoreSubsystem.h  

void OnAssetRegistryFilesLoaded()

   Subsystems/ActorModifierCoreSubsystem.h  

void OnBlueprintObjectsReplaced ( const TMap< UObject*, UObject* >& InReplacements
)

   Subsystems/ActorModifierCoreSubsystem.h  

void OnInsertModifier ( const FActorModifierCoreStackInsertOp& InInsertOp
) const

   Subsystems/ActorModifierCoreSubsystem.h  

bool RegisterActorModifierStack ( UActorModifierCoreStack* InStack
)

 Register a root actor stack to query this actor stack from everywhere, is called automatically at creation or deserialization by stack Subsystems/ActorModifierCoreSubsystem.h  

void RegisterModifierAsset ( const FAssetData& InAssetData
)

   Subsystems/ActorModifierCoreSubsystem.h  

bool RegisterModifierSharedProvider ( AActorModifierCoreSharedActor* InSharedActor
) const

 Registers a modifier shared provider actor for a world Subsystems/ActorModifierCoreSubsystem.h  

void ScanForModifiers()

 Done only once at subsystem initialization Subsystems/ActorModifierCoreSubsystem.h  

bool UnregisterActorModifierStack ( const AActor* InActor
)

 Unregister a root stack by providing the actor it is attached to Subsystems/ActorModifierCoreSubsystem.h  
Unregister a root stack from an actor by providing the stack itself Subsystems/ActorModifierCoreSubsystem.h  

void UnregisterModifierAsset ( const FAssetData& InAssetData
)

   Subsystems/ActorModifierCoreSubsystem.h  

bool UnregisterModifierSharedProvider ( const AActor* InSharedActor
) const

 Unregisters a modifier shared provider actor for a world Subsystems/ActorModifierCoreSubsystem.h  

bool ValidateModifierCreation ( const FName& InName,
const UActorModifierCoreStack* InStack,
FText& OutFailReason,
UActorModifierCoreBase* InBeforeModifier
) const

 Checks whether we can add a modifier to the stack Subsystems/ActorModifierCoreSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   Subsystems/ActorModifierCoreSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   Subsystems/ActorModifierCoreSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers
  Subsystems/ActorModifierCoreSubsystem.h  

static FOnModifierClassRegistered::RegistrationType & OnModifierClassRegistered()

   Subsystems/ActorModifierCoreSubsystem.h  

static FOnModifierClassRegistered::RegistrationType & OnModifierClassUnregistered()

   Subsystems/ActorModifierCoreSubsystem.h  

static FOnModifierReplaced::RegistrationType & OnModifierReplaced()

   Subsystems/ActorModifierCoreSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page