Navigation
API > API/Plugins > API/Plugins/ClonerEffector
Represents an extension for an effector to apply a custom behavior on cloner
| Name | UCEEffectorExtensionBase |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/ClonerEffector/Source/ClonerEffector/Public/Effector/CEEffectorExtensionBase.h |
| Include Path | #include "Effector/CEEffectorExtensionBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType, Within=CEEffectorComponent)
class UCEEffectorExtensionBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCEEffectorExtensionBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Effector/CEEffectorExtensionBase.h | |||
UCEEffectorExtensionBase
(
FName InExtensionName |
Effector/CEEffectorExtensionBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExtensionActive | bool | Effector/CEEffectorExtensionBase.h | ||
| ExtensionName | FName | Unique extension name used for dropdown and selection | Effector/CEEffectorExtensionBase.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateExtension() |
Enable this extension | Effector/CEEffectorExtensionBase.h | |
void DeactivateExtension() |
Disable this extension | Effector/CEEffectorExtensionBase.h | |
UCEEffectorComponent * GetEffectorComponent() |
Get the effector component using this extension | Effector/CEEffectorExtensionBase.h | |
FName GetExtensionName() |
Effector/CEEffectorExtensionBase.h |
|
|
FCEExtensionSection GetExtensionSection() |
Effector/CEEffectorExtensionBase.h | ||
bool IsExtensionActive() |
Effector/CEEffectorExtensionBase.h |
|
|
virtual bool RedirectExtensionName
(
FName InOldExtensionName |
Called after load when extension name is obsolete to handle redirection to this extension | Effector/CEEffectorExtensionBase.h | |
void UpdateExtensionParameters
(
bool bInUpdateLinkedCloners |
Request refresh extension next tick | Effector/CEEffectorExtensionBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnExtensionActivated() |
Called when extension becomes active | Effector/CEEffectorExtensionBase.h | |
virtual void OnExtensionDeactivated() |
Called when extension becomes inactive | Effector/CEEffectorExtensionBase.h | |
virtual void OnExtensionParametersChanged
(
UCEEffectorComponent* InComponent |
Called to reapply type parameters | Effector/CEEffectorExtensionBase.h | |
void OnExtensionPropertyChanged() |
Used by PECP to update parameters | Effector/CEEffectorExtensionBase.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditImport() |
Effector/CEEffectorExtensionBase.h |