1. Epic GamesDeveloper
  3. UActorModifierCoreLibrary

UActorModifierCoreLibrary

Blueprint Create/Read/Update/Delete operations for modifiers

API > API/Plugins > API/Plugins/ActorModifierCore

Blueprint Create/Read/Update/Delete operations for modifiers

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

Syntax

UCLASS (MinimalAPI, DisplayName="Motion Design Modifier Library")  
class UActorModifierCoreLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FActorModifierCoreMetadata & AddModifierMetadataDependency ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
TSubclassOf< UActorModifierCoreBase > InModifierClass
)

 Adds a modifier metadata dependency for this modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool CloneModifier ( UActorModifierCoreStack* InModifierStack,
const FActorModifierCoreCloneOperation& InOperation,
UActorModifierCoreBase*& OutNewModifier
)

 Clones an existing modifier into a modifier stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool ContainsModifier ( UActorModifierCoreStack* InModifierStack,
UActorModifierCoreBase* InModifier
)

 Checks if a modifier is contained in the stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool EnableModifier ( UActorModifierCoreBase* InModifier,
bool bInState
)

 Sets the state of an existing modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static UActorModifierCoreBase * FindModifierByClass ( UActorModifierCoreStack* InModifierStack,
TSubclassOf< UActorModifierCoreBase > InModifierClass
)

 Returns the first modifier of a specified class in the stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"
  • Meta=(DeterminesOutputType="InModifierClass")

static UActorModifierCoreBase * FindModifierByName ( const UActorModifierCoreStack* InModifierStack,
FName InModifierName
)

 Returns the first modifier with specified name in the stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static TArray< UActorModifierCoreBase * > FindModifiersByClass ( UActorModifierCoreStack* InModifierStack,
TSubclassOf< UActorModifierCoreBase > InModifierClass
)

 Finds all modifiers with specified class in the stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"
  • Meta=(DeterminesOutputType="InModifierClass")

static TArray< UActorModifierCoreBase * > FindModifiersByName ( UActorModifierCoreStack* InModifierStack,
FName InModifierName
)

 Finds all modifiers with specified class in the stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool FindModifierStack ( AActor* InActor,
UActorModifierCoreStack*& OutModifierStack,
bool bInCreateIfNone
)

 Retrieves the modifier stack or create one if none is found Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetAvailableModifiers ( TSet< TSubclassOf< UActorModifierCoreBase > >& OutAvailableModifierClasses
)

 Gets all available modifier classes registered Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetDependentModifiers ( UActorModifierCoreBase* InModifier,
TSet< UActorModifierCoreBase* >& OutModifiers
)

 Retrieves all modifiers found after this one that depends on this modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierActor ( const UActorModifierCoreBase* InModifier,
AActor*& OutModifiedActor
)

 Retrieves the actor modified by a modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierCategories ( TSet< FName >& OutModifierCategories
)

 Retrieves the modifier categories available Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierCategory ( const UActorModifierCoreBase* InModifier,
FName& OutModifierCategory
)

 Retrieves the modifier category of an existing modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierCategoryByClass ( TSubclassOf< UActorModifierCoreBase > InModifierClass,
FName& OutModifierCategory
)

 Retrieves the modifier category from a modifier class Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierClass ( FName InModifierName,
TSubclassOf< UActorModifierCoreBase >& OutModifierClass
)

 Retrieves the modifier class from a modifier name Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierName ( const UActorModifierCoreBase* InModifier,
FName& OutModifierName
)

 Retrieves the modifier name of an existing modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierNameByClass ( TSubclassOf< UActorModifierCoreBase > InModifierClass,
FName& OutModifierName
)

 Retrieves the modifier name from a modifier class Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifiersByCategory ( FName InCategory,
TSet< TSubclassOf< UActorModifierCoreBase > >& OutSupportedModifierClasses
)

 Retrieves the modifiers classes by a category Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetModifierStack ( const UActorModifierCoreBase* InModifier,
UActorModifierCoreStack*& OutModifierStack
)

 Retrieves the modifier stack this modifier is in Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static bool GetRequiredModifiers ( UActorModifierCoreBase* InModifier,
TSet< UActorModifierCoreBase* >& OutModifiers
)

 Retrieves all modifiers found before this one that are required for this modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetStackModifiers ( const UActorModifierCoreStack* InModifierStack,
TArray< UActorModifierCoreBase* >& OutModifiers
)

 Retrieves all modifiers from a modifier stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool GetSupportedModifiers ( AActor* InActor,
TSet< TSubclassOf< UActorModifierCoreBase > >& OutSupportedModifierClasses,
EActorModifierCoreStackPosition InContextPosition,
UActorModifierCoreBase* InContextModifier
)

 Gets all modifier classes supported by this actor at a specific position Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool InsertModifier ( UActorModifierCoreStack* InModifierStack,
const FActorModifierCoreInsertOperation& InOperation,
UActorModifierCoreBase*& OutNewModifier
)

 Creates and insert a new modifier into a modifier stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool IsModifierEnabled ( const UActorModifierCoreBase* InModifier,
bool& bOutEnabled
)

 Checks the state of an existing modifier Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintPure
  • Category="Motion Design|Modifiers|Utility"

static void MarkModifierDirty ( UActorModifierCoreBase* InModifier
)

 Marks the modifier dirty Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool MoveModifier ( UActorModifierCoreStack* InModifierStack,
const FActorModifierCoreMoveOperation& InOperation
)

 Moves an existing modifier into a modifier stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static bool RemoveModifier ( UActorModifierCoreStack* InModifierStack,
const FActorModifierCoreRemoveOperation& InOperation
)

 Removes an existing modifier from a modifier stack Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static FActorModifierCoreMetadata & SetModifierMetadataCategory ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
FName InCategory
)

 Sets the modifier metadata category Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static FActorModifierCoreMetadata & SetModifierMetadataColor ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
const FLinearColor& InColor
)

 Sets the modifier metadata color (EDITOR-ONLY) Modifiers/Utilities/ActorModifierCoreLibrary.h  

static FActorModifierCoreMetadata & SetModifierMetadataCompatibilityRule ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
const FModifierCompatibilityRule& InDelegate
)

 Sets the modifier metadata compatibility rule Modifiers/Utilities/ActorModifierCoreLibrary.h  

static FActorModifierCoreMetadata & SetModifierMetadataDescription ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
const FText& InDescription
)

 Sets the modifier metadata description (EDITOR-ONLY) Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static FActorModifierCoreMetadata & SetModifierMetadataDisplayName ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
const FText& InName
)

 Sets the modifier metadata display name (EDITOR-ONLY) Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

static FActorModifierCoreMetadata & SetModifierMetadataName ( UPARAM(Ref) FActorModifierCoreMetadata& InMetadata,
FName InName
)

 Sets the modifier metadata name Modifiers/Utilities/ActorModifierCoreLibrary.h
  • BlueprintCallable
  • Category="Motion Design|Modifiers|Utility"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page