Navigation
API > API/Plugins > API/Plugins/ClonerEffector
| Name | UCEEffectorSubsystem |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/ClonerEffector/Source/ClonerEffector/Public/Subsystems/CEEffectorSubsystem.h |
| Include Path | #include "Subsystems/CEEffectorSubsystem.h" |
Syntax
UCLASS ()
class UCEEffectorSubsystem :
public UEngineSubsystem ,
public FTickableGameObject
Inheritance Hierarchy
- FTickableObjectBase → FTickableGameObject → UCEEffectorSubsystem
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UCEEffectorSubsystem
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnEffectorIdentifierChanged | TMulticastDelegate_ThreeParams< void, UCEEffectorComponent *, int32, int32 > | Subsystems/CEEffectorSubsystem.h | |
| FOnEffectorSetEnabled | TMulticastDelegate_ThreeParams< void, const UWorld *, bool, bool > | Subsystems/CEEffectorSubsystem.h | |
| FOnSubsystemInitialized | TMulticastDelegate_NoParams< void > | Subsystems/CEEffectorSubsystem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DataChannelAssetPath | TCHAR | Subsystems/CEEffectorSubsystem.h | |
| OnEffectorIdentifierChangedDelegate | FOnEffectorIdentifierChanged | Broadcasted when this effector identifier changed to update linked cloners | Subsystems/CEEffectorSubsystem.h |
| OnEffectorSetEnabledDelegate | FOnEffectorSetEnabled | Delegate to change state of effectors in a world | Subsystems/CEEffectorSubsystem.h |
| OnSubsystemInitializedDelegate | FOnSubsystemInitialized | Broadcasted when this subsystem is initialized | Subsystems/CEEffectorSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCEEffectorExtensionBase * CreateNewExtension
(
FName InExtensionName, |
Creates a new extension instance for an effector | Subsystems/CEEffectorSubsystem.h | |
FName FindExtensionName
(
TSubclassOf< UCEEffectorExtensionBase > InClass |
Based on a extension class, find extension name | Subsystems/CEEffectorSubsystem.h | |
UCEEffectorComponent * GetEffectorByChannelIdentifier
(
int32 InIdentifier |
Get the effector using this channel identifier | Subsystems/CEEffectorSubsystem.h | |
TSet< TSubclassOf< UCEEffectorExtensionBase > > GetExtensionClasses
(
TSubclassOf< UCEEffectorExtensionBase > InExtensionClass |
Subsystems/CEEffectorSubsystem.h | ||
TSet< TSubclassOf< UCEEffectorExtensionBase > > GetExtensionClasses () |
Subsystems/CEEffectorSubsystem.h | ||
TSet< FName > GetExtensionNames () |
Subsystems/CEEffectorSubsystem.h | ||
TSet< FName > GetExtensionNames
(
TSubclassOf< UCEEffectorExtensionBase > InExtensionClass |
Subsystems/CEEffectorSubsystem.h | ||
bool IsExtensionClassRegistered
(
UClass* InClass |
Subsystems/CEEffectorSubsystem.h | ||
bool RegisterChannelEffector
(
UCEEffectorComponent* InEffector |
Registers an effector actor to use it within a effector channel | Subsystems/CEEffectorSubsystem.h | |
bool RegisterExtensionClass
(
UClass* InClass |
Subsystems/CEEffectorSubsystem.h | ||
void SetEffectorsEnabled
(
const TSet< UCEEffectorComponent* >& InEffectors, |
Set effectors state and optionally transact | Subsystems/CEEffectorSubsystem.h | |
void SetLevelEffectorsEnabled
(
const UWorld* InWorld, |
Set effectors state in world and optionally transact | Subsystems/CEEffectorSubsystem.h | |
bool UnregisterChannelEffector
(
UCEEffectorComponent* InEffector |
Unregister an effector actor used within a effector channel | Subsystems/CEEffectorSubsystem.h | |
bool UnregisterExtensionClass
(
UClass* InClass |
Subsystems/CEEffectorSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ScanForRegistrableClasses() |
Scan classes and registers them | Subsystems/CEEffectorSubsystem.h | |
void UpdateEffectorChannel
(
const UWorld* InWorld |
Updates all registered effectors | Subsystems/CEEffectorSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Subsystems/CEEffectorSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
Subsystems/CEEffectorSubsystem.h |
Overridden from FTickableGameObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsTickableInEditor() |
Subsystems/CEEffectorSubsystem.h |
Overridden from FTickableObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TStatId GetStatId() |
Subsystems/CEEffectorSubsystem.h | ||
virtual ETickableTickType GetTickableTickType() |
Subsystems/CEEffectorSubsystem.h | ||
virtual bool IsTickable() |
Subsystems/CEEffectorSubsystem.h | ||
virtual void Tick
(
float InDeltaSeconds |
Subsystems/CEEffectorSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UCEEffectorSubsystem * Get() |
Get this subsystem instance | Subsystems/CEEffectorSubsystem.h | |
static FOnEffectorIdentifierChanged::RegistrationType & OnEffectorIdentifierChanged() |
Subsystems/CEEffectorSubsystem.h | ||
static FOnEffectorSetEnabled::RegistrationType & OnEffectorSetEnabled() |
Subsystems/CEEffectorSubsystem.h | ||
static FOnSubsystemInitialized::RegistrationType & OnSubsystemInitialized() |
Subsystems/CEEffectorSubsystem.h |