1. Epic GamesDeveloper
  3. FActorModifierCoreMetadata

FActorModifierCoreMetadata

Metadata for each modifier CDO, modifier instance will share same metadata as CDO

API > API/Plugins > API/Plugins/ActorModifierCore

Metadata for each modifier CDO, modifier instance will share same metadata as CDO

   
Name FActorModifierCoreMetadata
Type struct
Header File /Engine/Plugins/VirtualProduction/ActorModifierCore/Source/ActorModifierCore/Public/Modifiers/ActorModifierCoreDefs.h
Include Path #include "Modifiers/ActorModifierCoreDefs.h"

Syntax

USTRUCT (BlueprintType )  
struct FActorModifierCoreMetadata

Constructors

Name Remarks Include Path Unreal Specifiers
  Modifiers/ActorModifierCoreDefs.h  
  Modifiers/ActorModifierCoreDefs.h  

Constants

Name Type Remarks Include Path
DefaultCategory const FName   Modifiers/ActorModifierCoreDefs.h
DefaultColor const FLinearColor   Modifiers/ActorModifierCoreDefs.h
DefaultDescription const FText   Modifiers/ActorModifierCoreDefs.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AvoidedAfterCategories TSet< FName > Modifier avoided after these categories Modifiers/ActorModifierCoreDefs.h  
AvoidedBeforeCategories TSet< FName > Modifier avoided before these categories Modifiers/ActorModifierCoreDefs.h  
bHidden bool Is this modifier visible or hidden in menu Modifiers/ActorModifierCoreDefs.h  
bIsStack bool Is this modifier a stack Modifiers/ActorModifierCoreDefs.h  
bMultipleAllowed bool Is this modifier allowed multiple times in the same stack Modifiers/ActorModifierCoreDefs.h  
bTickAllowed bool Tick allowed for this modifier to run additional checks to detect changes Modifiers/ActorModifierCoreDefs.h  
Category FName Category group of this modifier to sort them Modifiers/ActorModifierCoreDefs.h  
Class TSubclassOf< UActorModifierCoreBase > In order to create new instances of this modifier Modifiers/ActorModifierCoreDefs.h  
Color FLinearColor Color visible in modifier tab Modifiers/ActorModifierCoreDefs.h  
CompatibilityRuleDelegate FModifierCompatibilityRule   Modifiers/ActorModifierCoreDefs.h  
CompatibilityRuleFunction TFunction< bool(const AActor *)> Rule to pass before this modifier can be used on an actor Modifiers/ActorModifierCoreDefs.h  
Dependencies TArray< FName > What modifiers does this modifier need to work properly, in the correct order Modifiers/ActorModifierCoreDefs.h  
Description FText Description of the modifier as tooltip in menus Modifiers/ActorModifierCoreDefs.h  
DisallowedAfter TSet< FName > Is this modifier disallowed after these modifiers Modifiers/ActorModifierCoreDefs.h  
DisallowedBefore TSet< FName > Is this modifier disallowed before these modifiers Modifiers/ActorModifierCoreDefs.h  
DisplayName FText Display name of this modifier for menus Modifiers/ActorModifierCoreDefs.h  
Icon FSlateIcon Icon visible in menus, details panel and modifier tab Modifiers/ActorModifierCoreDefs.h  
Name FName Unique name to use for this modifier Modifiers/ActorModifierCoreDefs.h  
ProfilerFunction TFunction< TSharedPtr< FActorModifierCoreProfiler >(UActorModifierCoreBase *)> Function to create a new profiler instance for a modifier Modifiers/ActorModifierCoreDefs.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FActorModifierCoreMetadata & AddDependency ( const FName& InModifierName
)

 Add a modifier dependency for this modifier, will be added when this modifier is added Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & AllowMultiple ( bool bInAllowed
)

 Allows multiple modifiers of the same type in the same stack Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & AllowTick ( bool bInAllowed
)

 Allow modifier to tick to update when IsModifierDirtyable returns true Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & AvoidAfterCategory ( const FName& InCategory
)

 Avoid usage of this modifier after another modifier category Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & AvoidBeforeCategory ( const FName& InCategory
)

 Avoid usage of this modifier before another modifier category Modifiers/ActorModifierCoreDefs.h  

UActorModifierCoreBase * CreateModifierInstance ( UActorModifierCoreStack* InStack
) const

 Create the modifier instance Modifiers/ActorModifierCoreDefs.h  

TSharedPtr< FActorModifierCoreProfiler > CreateProfilerInstance ( UActorModifierCoreBase* InModifier
) const

 Create the profiler instance Modifiers/ActorModifierCoreDefs.h  

bool DependsOn ( const FName& InModifierName
) const

 Checks if this modifier depends on another modifier Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & DisallowAfter ( const FName& InModifierName
)

 Disallows this modifier after another modifier Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & DisallowBefore ( const FName& InModifierName
)

 Disallows this modifier before another modifier Modifiers/ActorModifierCoreDefs.h  

FName GetCategory()

   Modifiers/ActorModifierCoreDefs.h  
  Modifiers/ActorModifierCoreDefs.h  

const FLinearColor & GetColor()

   Modifiers/ActorModifierCoreDefs.h  

TConstArrayView< FName > GetDependencies()

   Modifiers/ActorModifierCoreDefs.h  

const FText & GetDescription()

   Modifiers/ActorModifierCoreDefs.h  

const TSet< FName > & GetDisallowedAfter()

   Modifiers/ActorModifierCoreDefs.h  

const TSet< FName > & GetDisallowedBefore()

   Modifiers/ActorModifierCoreDefs.h  

const FText & GetDisplayName()

   Modifiers/ActorModifierCoreDefs.h  

const FSlateIcon & GetIcon()

   Modifiers/ActorModifierCoreDefs.h  

FName GetName()

   Modifiers/ActorModifierCoreDefs.h  

bool IsAllowedAfter ( const FName& InModifierName
) const

   Modifiers/ActorModifierCoreDefs.h  

bool IsAllowedBefore ( const FName& InModifierName
) const

   Modifiers/ActorModifierCoreDefs.h  

bool IsCompatibleWith ( const AActor* InActor
) const

   Modifiers/ActorModifierCoreDefs.h  

bool IsDisallowedAfter ( const FName& InModifierName
) const

   Modifiers/ActorModifierCoreDefs.h  

bool IsDisallowedBefore ( const FName& InModifierName
) const

   Modifiers/ActorModifierCoreDefs.h  

bool IsHidden()

   Modifiers/ActorModifierCoreDefs.h  

bool IsMultipleAllowed()

   Modifiers/ActorModifierCoreDefs.h  

bool IsRequiredBy ( const FName& InModifierName
) const

 Check if this modifier is required by the other modifier Modifiers/ActorModifierCoreDefs.h  

bool IsStack()

   Modifiers/ActorModifierCoreDefs.h  

bool IsTickAllowed()

   Modifiers/ActorModifierCoreDefs.h  

bool ResetDefault()

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetCategory ( FName InCategory
)

 Set Category group of this modifier, should only be set once Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetColor ( const FLinearColor& InColor
)

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetCompatibilityRule ( const TFunction< bool(const AActor*)>& InModifierRule
)

 Sets the usage rule for this modifier, if it passes it will be available for this actor Modifiers/ActorModifierCoreDefs.h  
Sets the usage rule for this modifier, if it passes it will be available for this actor Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetDescription ( const FText& InDescription
)

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetDisplayName ( const FText& InName
)

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetHidden ( bool bInHidden
)

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetIcon ( const FSlateIcon& InIcon
)

   Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetName ( FName InName
)

 Set name of this modifier, should only be set once Modifiers/ActorModifierCoreDefs.h  

FActorModifierCoreMetadata & SetProfilerClass()

 Set the profiler class used for this modifier instances Modifiers/ActorModifierCoreDefs.h  

bool ShouldAvoidAfter ( FName InCategory
) const

   Modifiers/ActorModifierCoreDefs.h  

bool ShouldAvoidBefore ( FName InCategory
) const

   Modifiers/ActorModifierCoreDefs.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page