Navigation
API > API/Plugins > API/Plugins/ClonerEffector
Reusable extension on cloner layout to group similar options
| Name | UCEClonerExtensionBase |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/ClonerEffector/Source/ClonerEffector/Public/Cloner/Extensions/CEClonerExtensionBase.h |
| Include Path | #include "Cloner/Extensions/CEClonerExtensionBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType, Within=CEClonerComponent)
class UCEClonerExtensionBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCEClonerExtensionBase
Derived Classes
UCEClonerExtensionBase derived class hierarchy
- UCEClonerCollisionExtension
- UCEClonerConstraintExtension
- UCEClonerDisplacementExtension
- UCEClonerEffectorExtension
- UCEClonerEmitterSpawnExtension
- UCEClonerLifetimeExtension
- UCEClonerMeshRendererExtension
- UCEClonerProgressExtension
- UCEClonerRangeExtension
- UCEClonerStepExtension
- UCEClonerTextureExtension
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Cloner/Extensions/CEClonerExtensionBase.h | |||
UCEClonerExtensionBase
(
FName InExtensionName, |
Cloner/Extensions/CEClonerExtensionBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExtensionActive | bool | Cloner/Extensions/CEClonerExtensionBase.h | ||
| ExtensionName | FName | Unique extension name for the cloner | Cloner/Extensions/CEClonerExtensionBase.h |
|
| ExtensionPriority | int32 | Some extensions need to be called before or after others | Cloner/Extensions/CEClonerExtensionBase.h |
|
| ExtensionStatus | ECEClonerSystemStatus | Cloner/Extensions/CEClonerExtensionBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateExtension() |
Enable this extension | Cloner/Extensions/CEClonerExtensionBase.h | |
void DeactivateExtension() |
Disable this extension | Cloner/Extensions/CEClonerExtensionBase.h | |
UCEClonerComponent * GetClonerComponent() |
Get the cloner component using this extension | Cloner/Extensions/CEClonerExtensionBase.h | |
UCEClonerComponent * GetClonerComponentChecked() |
Get the cloner component using this extension checked version | Cloner/Extensions/CEClonerExtensionBase.h | |
UCEClonerLayoutBase * GetClonerLayout() |
Get the cloner active layout that uses this extension | Cloner/Extensions/CEClonerExtensionBase.h | |
FName GetExtensionName() |
Cloner/Extensions/CEClonerExtensionBase.h |
|
|
int32 GetExtensionPriority() |
Cloner/Extensions/CEClonerExtensionBase.h | ||
FCEExtensionSection GetExtensionSection() |
Cloner/Extensions/CEClonerExtensionBase.h | ||
bool IsExtensionActive() |
Cloner/Extensions/CEClonerExtensionBase.h |
|
|
bool IsExtensionDirty() |
Is this extension dirty | Cloner/Extensions/CEClonerExtensionBase.h | |
virtual bool IsLayoutSupported
(
const UCEClonerLayoutBase* InLayout |
Filter supported layout for this extension | Cloner/Extensions/CEClonerExtensionBase.h | |
void MarkExtensionDirty
(
bool bInUpdateCloner |
Request refresh extension next tick | Cloner/Extensions/CEClonerExtensionBase.h | |
virtual void OnClonerMeshesUpdated() |
Called when the meshes are updated | Cloner/Extensions/CEClonerExtensionBase.h | |
virtual void OnExtensionDirtied
(
const UCEClonerExtensionBase* InExtension |
Called when an active extension is dirtied to allow other extensions to react accordingly | Cloner/Extensions/CEClonerExtensionBase.h | |
void UpdateExtensionParameters() |
Updates all extensions parameters | Cloner/Extensions/CEClonerExtensionBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnExtensionActivated() |
Called when the extension becomes active | Cloner/Extensions/CEClonerExtensionBase.h | |
virtual void OnExtensionDeactivated() |
Called when the extension becomes inactive | Cloner/Extensions/CEClonerExtensionBase.h | |
virtual void OnExtensionParametersChanged
(
UCEClonerComponent* InComponent |
Called to reapply extension parameters | Cloner/Extensions/CEClonerExtensionBase.h | |
void OnExtensionPropertyChanged() |
Used by PECP to update parameters | Cloner/Extensions/CEClonerExtensionBase.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditImport() |
Cloner/Extensions/CEClonerExtensionBase.h | ||
virtual void PostEditUndo() |
Cloner/Extensions/CEClonerExtensionBase.h |