Navigation
API > API/Plugins > API/Plugins/ActorModifierCore
A modifier extension is a piece of logic that multiple modifiers can reuse Can be customized for a specific scenario, only extends one modifier Differs from singleton shared object that can handle or be used by multiple modifiers Will follow the lifecycle of the modifier it is attached to
| Name | FActorModifierCoreExtension |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/ActorModifierCore/Source/ActorModifierCore/Public/Modifiers/ActorModifierCoreExtension.h |
| Include Path | #include "Modifiers/ActorModifierCoreExtension.h" |
Syntax
class FActorModifierCoreExtension : public TSharedFromThis< FActorModifierCoreExtension >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FActorModifierCoreExtension
Derived Classes
- FActorModifierRenderStateUpdateExtension
- FActorModifierSceneTreeUpdateExtension
- FActorModifierTransformUpdateExtension
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FActorModifierCoreExtension() |
Modifiers/ActorModifierCoreExtension.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExtensionEnabled | bool | Extension is enabled | Modifiers/ActorModifierCoreExtension.h | |
| bExtensionInitialized | bool | Extension was initialized properly and ready to use | Modifiers/ActorModifierCoreExtension.h | |
| ExtensionType | FName | Extension type to retrieve it on instance without cast needed | Modifiers/ActorModifierCoreExtension.h | |
| ModifierWeak | TWeakObjectPtr< UActorModifierCoreBase > | Modifier to which this extension is linked | Modifiers/ActorModifierCoreExtension.h |
Functions
Public
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetExtensionType() |
Get this extension type without needing a cast | Modifiers/ActorModifierCoreExtension.h | |
InModifierClass * GetModifier () |
Get the casted modifier to which this extension is linked | Modifiers/ActorModifierCoreExtension.h | |
| Get the modifier to which this extension is linked | Modifiers/ActorModifierCoreExtension.h | ||
AActor * GetModifierActor() |
Get the modifier actor | Modifiers/ActorModifierCoreExtension.h | |
ULevel * GetModifierLevel() |
Get the modifier actor level | Modifiers/ActorModifierCoreExtension.h | |
UWorld * GetModifierWorld() |
Get the modifier actor world | Modifiers/ActorModifierCoreExtension.h | |
bool IsExtensionEnabled() |
Is this extension enabled | Modifiers/ActorModifierCoreExtension.h | |
virtual void OnExtensionDisabled
(
EActorModifierCoreDisableReason InReason |
Overwrite this, called when the modifier is disabled | Modifiers/ActorModifierCoreExtension.h | |
virtual void OnExtensionEnabled
(
EActorModifierCoreEnableReason InReason |
Overwrite this, called when the modifier is enabled | Modifiers/ActorModifierCoreExtension.h | |
virtual void OnExtensionInitialized() |
Overwrite this, called when the extension is created | Modifiers/ActorModifierCoreExtension.h |