1. Epic GamesDeveloper
  3. UCEEffectorSubsystem

UCEEffectorSubsystem

API > API/Plugins > API/Plugins/ClonerEffector > API/Plugins/ClonerEffector/Subsystems

Inheritance Hierarchy

References

   
Module ClonerEffector
Header /Engine/Plugins/Experimental/ClonerEffector/Source/ClonerEffector/Public/Subsystems/CEEffectorSubsystem.h
Include #include "Subsystems/CEEffectorSubsystem.h"

Syntax

UCLASS ()  
class UCEEffectorSubsystem :  
    public UEngineSubsystem ,  
    public FTickableGameObject

Variables

  Type Name Description
Protected variable TObjectPtr< UNiagaraDataChannelAsset > EffectorDataChannelAsset This represents the data channel structure for effector
Protected variable UProperty TArray< TWeakObjectPtr< UCEEffectorComponent > > EffectorsWeak Ordered effectors included in this channel
Protected variable UProperty TMap< FName, TSubclassOf< UCEEffectorExtensionBase > > ExtensionClasses Linking name to the extension class

Functions

  Type Name Description
Public function UCEEffectorExtensionBase *

CreateNewExtension ( FName InExtensionName,
UCEEffectorComponent* InEffector
)

 Creates a new extension instance for an effector
Public function Const FName Based on a extension class, find extension name
Public function Static UCEEffectorSubsystem *

Get ()

 Get this subsystem instance
Public function Const UCEEffectorComponent * Get the effector using this channel identifier
Public function Const TSet< TSubclassOf< UCEEffectorExtensionBase > >  
Public function Const TSet< TSubclassOf< UCEEffectorExtensionBase > >  
Public function Const TSet< FName >  
Public function Const TSet< FName >  
Public function Const bool  
Public function Static FOnEffectorIdentifierChanged::RegistrationType &  
Public function Static FOnEffectorSetEnabled::RegistrationType &  
Public function Static FOnSubsystemInitialized::RegistrationType &  
Public function bool

RegisterChannelEffector ( UCEEffectorComponent* InEffector
)

 Registers an effector actor to use it within a effector channel
Public function bool  
Protected function void Scan classes and registers them
Public function void

SetEffectorsEnabled ( const TSet< UCEEffectorComponent* >& InEffectors,
bool bInEnable,
bool bInShouldTransact
)

 Set effectors state and optionally transact
Public function void

SetLevelEffectorsEnabled ( const UWorld* InWorld,
bool bInEnable,
bool bInShouldTransact
)

 Set effectors state in world and optionally transact
Public function bool

UnregisterChannelEffector ( UCEEffectorComponent* InEffector
)

 Unregister an effector actor used within a effector channel
Public function bool  
Protected function void

UpdateEffectorChannel ( const UWorld* InWorld
)

 Updates all registered effectors

Overridden from USubsystem

  Type Name Description
Protected function Virtual void Implement this for initialization of instances of the system

Overridden from FTickableGameObject

  Type Name Description
Protected function Virtual Const bool Used to determine whether the object should be ticked in the editor when there is no gameplay world.

Overridden from FTickableObjectBase

  Type Name Description
Protected function Virtual Const TStatId Return the stat id used to track the performance of this object
Protected function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class and is called before first tick.
Protected function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Protected function Virtual void

Tick ( float InDeltaSeconds
)

 Pure virtual that must be overloaded by the inheriting class.

Typedefs

Name Description
FOnEffectorIdentifierChanged  
FOnEffectorSetEnabled  
FOnSubsystemInitialized  

Constants

Name Description
DataChannelAssetPath  
OnEffectorIdentifierChangedDelegate Broadcasted when this effector identifier changed to update linked cloners
OnEffectorSetEnabledDelegate Delegate to change state of effectors in a world
OnSubsystemInitializedDelegate Broadcasted when this subsystem is initialized

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page