Emitter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
//~=============================================================================
// Emitter actor class.
//~=============================================================================
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "GameFramework/Actor.h"
#include "Emitter.generated.h"
 
class UPhysicalMaterial;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams( FParticleSpawnSignature, FName, EventName, float, EmitterTime, FVector, Location, FVector, Velocity);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams( FParticleBurstSignature, FName, EventName, float, EmitterTime, int32, ParticleCount);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_SixParams( FParticleDeathSignature, FName, EventName, float, EmitterTime, int32, ParticleTime, FVector, Location, FVector, Velocity, FVector, Direction);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_NineParams( FParticleCollisionSignature, FName, EventName, float, EmitterTime, int32, ParticleTime, FVector, Location, FVector, Velocity, FVector, Direction, FVector, Normal, FName, BoneName, UPhysicalMaterial*, PhysMat);
 
UCLASS(hideCategories=(Activation,"Components|Activation",Input,Collision,"Game|Damage"), ComponentWrapperClass, MinimalAPI)
class AEmitter : public AActor
{
    GENERATED_UCLASS_BODY()
 
    ENGINE_API virtual void GetLifetimeReplicatedProps(TArray< FLifetimeProperty > & OutLifetimeProps) const override;
 
private:
    UPROPERTY(Category = Emitter, VisibleAnywhere, BlueprintReadOnly, meta = (ExposeFunctionCategories = "Particles|Beam,Particles|Parameters,Particles,Effects|Components|ParticleSystem,Rendering,Activation,Components|Activation", AllowPrivateAccess = "true"))
    TObjectPtr<class UParticleSystemComponent> ParticleSystemComponent;
public:
 
    UPROPERTY()
    uint32 bDestroyOnSystemFinish:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Emitter)
    uint32 bPostUpdateTickGroup:1;
 
    UPROPERTY(replicatedUsing=OnRep_bCurrentlyActive)
    uint32 bCurrentlyActive:1;
 
    UPROPERTY(BlueprintAssignable)
    FParticleSpawnSignature OnParticleSpawn;
 
    UPROPERTY(BlueprintAssignable)
    FParticleBurstSignature OnParticleBurst;
 
    UPROPERTY(BlueprintAssignable)
    FParticleDeathSignature OnParticleDeath;
 
    UPROPERTY(BlueprintAssignable)
    FParticleCollisionSignature OnParticleCollide;
 
#if WITH_EDITORONLY_DATA
 
private:
    UPROPERTY()
    TObjectPtr<class UBillboardComponent> SpriteComponent;
 
    UPROPERTY()
    TObjectPtr<class UArrowComponent> ArrowComponent;
public:
 
#endif
 
    UFUNCTION()
    ENGINE_API virtual void OnParticleSystemFinished(class UParticleSystemComponent* FinishedComponent);
 
    UFUNCTION()
    ENGINE_API virtual void OnRep_bCurrentlyActive();
 
    // BEGIN DEPRECATED (use component functions now in level script)
    UFUNCTION(BlueprintCallable, Category=Particles, meta=(DeprecatedFunction))
    ENGINE_API void Activate();
    UFUNCTION(BlueprintCallable, Category=Particles, meta=(DeprecatedFunction))
    ENGINE_API void Deactivate();
    UFUNCTION(BlueprintCallable, Category=Particles, meta=(DeprecatedFunction))
    ENGINE_API void ToggleActive();
    UFUNCTION(BlueprintCallable, Category=Particles, meta=(DeprecatedFunction))
    ENGINE_API bool IsActive() const;
    UFUNCTION(BlueprintCallable, Category=Particles, meta=(DeprecatedFunction))
    ENGINE_API virtual void SetTemplate(class UParticleSystem* NewTemplate);
    UFUNCTION(BlueprintCallable, Category="Particles|Parameters", meta=(DeprecatedFunction))
    ENGINE_API void SetFloatParameter(FName ParameterName, float Param);
    UFUNCTION(BlueprintCallable, Category="Particles|Parameters", meta=(DeprecatedFunction))
    ENGINE_API void SetVectorParameter(FName ParameterName, FVector Param);
    UFUNCTION(BlueprintCallable, Category="Particles|Parameters", meta=(DeprecatedFunction))
    ENGINE_API void SetColorParameter(FName ParameterName, FLinearColor Param);
    UFUNCTION(BlueprintCallable, Category="Particles|Parameters", meta=(DeprecatedFunction))
    ENGINE_API void SetActorParameter(FName ParameterName, class AActor* Param);
    UFUNCTION(BlueprintCallable, Category="Particles|Parameters", meta=(DeprecatedFunction))
    ENGINE_API void SetMaterialParameter(FName ParameterName, class UMaterialInterface* Param);
    // END DEPRECATED
 
 
    ENGINE_API void AutoPopulateInstanceProperties();
 
    //~ Begin UObject Interface
    ENGINE_API virtual FString GetDetailedInfoInternal() const override;
    //~ End UObject Interface
 
 
    //~ Begin AActor Interface
    ENGINE_API virtual void PostActorCreated() override;
    ENGINE_API virtual void PostInitializeComponents() override;
#if WITH_EDITOR
    ENGINE_API virtual void CheckForErrors() override;
    ENGINE_API virtual bool GetReferencedContentObjects( TArray<UObject*>& Objects ) const override;
    //~ End AActor Interface
 
    ENGINE_API void ResetInLevel();
#endif
 
public:
    class UParticleSystemComponent* GetParticleSystemComponent() { return ParticleSystemComponent; }
#if WITH_EDITORONLY_DATA
    class UBillboardComponent* GetSpriteComponent() const { return SpriteComponent; }
    class UArrowComponent* GetArrowComponent() const { return ArrowComponent; }
#endif
};