1. Epic GamesDeveloper
  3. AEmitterCameraLensEffectBase

AEmitterCameraLensEffectBase

API > API/Runtime > API/Runtime/Engine

   
Name AEmitterCameraLensEffectBase
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Particles/EmitterCameraLensEffectBase.h
Include Path #include "Particles/EmitterCameraLensEffectBase.h"

Syntax

UCLASS (Abstract, Blueprintable, MinimalAPI)  
class AEmitterCameraLensEffectBase :  
    public AEmitter ,  
    public ICameraLensEffectInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

AEmitterCameraLensEffectBase ( const FObjectInitializer& ObjectInitializer
)

   Particles/EmitterCameraLensEffectBase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowMultipleInstances uint8 True if multiple instances of this emitter can exist simultaneously, false otherwise. Particles/EmitterCameraLensEffectBase.h
  • EditAnywhere
  • Category=EmitterCameraLensEffectBase
BaseFOV float This is the assumed FOV for which the effect was authored. Particles/EmitterCameraLensEffectBase.h
  • EditDefaultsOnly
  • Category=EmitterCameraLensEffectBase
bResetWhenRetriggered uint8 If bAllowMultipleInstances is true and this effect is retriggered, the particle system will be reset if this is true Particles/EmitterCameraLensEffectBase.h
  • EditAnywhere
  • Category=EmitterCameraLensEffectBase
EmittersToTreatAsSame TArray< TSubclassOf< AActor > > If an emitter class in this array is currently playing, do not play this effect. Particles/EmitterCameraLensEffectBase.h
  • EditDefaultsOnly
  • Category=EmitterCameraLensEffectBase
  • Meta=(MustImplement="/Script/Engine.CameraLensEffectInterface")

Functions

Public

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level Particles/EmitterCameraLensEffectBase.h  

virtual void PostInitializeComponents()

 Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay Particles/EmitterCameraLensEffectBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Particles/EmitterCameraLensEffectBase.h  

Overridden from ICameraLensEffectInterface

Name Remarks Include Path Unreal Specifiers

virtual void ActivateLensEffect ()

 This will actually activate the lens Effect. Particles/EmitterCameraLensEffectBase.h  

virtual void AdjustBaseFOV ( float NewFOV
)

   Particles/EmitterCameraLensEffectBase.h  

virtual void DeactivateLensEffect ()

 Deactivtes the particle system. Particles/EmitterCameraLensEffectBase.h  

virtual float GetBaseFOV()

   Particles/EmitterCameraLensEffectBase.h  

virtual const FTransform & GetRelativeTransform()

   Particles/EmitterCameraLensEffectBase.h  

virtual bool IsLooping()

 Returns true if any associated particle system is set to looping Particles/EmitterCameraLensEffectBase.h  

virtual void NotifyRetriggered()

 Called when this emitter is re-triggered, for bAllowMultipleInstances=false emitters. Particles/EmitterCameraLensEffectBase.h  

virtual void NotifyWillBePooled()

 If this type needs to handle being pooled, override this function Particles/EmitterCameraLensEffectBase.h  

virtual void RegisterCamera ( APlayerCameraManager* C
)

 Tell the emitter what camera it is attached to. Particles/EmitterCameraLensEffectBase.h  

virtual bool ResetWhenTriggered()

   Particles/EmitterCameraLensEffectBase.h  

virtual bool ShouldAllowMultipleInstances()

   Particles/EmitterCameraLensEffectBase.h  

virtual bool ShouldTreatEmitterAsSame ( TSubclassOf< AActor > OtherEmitter
) const

 Is this emitter functionally equivalent to the class OtherEmitter? Particles/EmitterCameraLensEffectBase.h  

virtual void UpdateLocation ( const FVector& CamLoc,
const FRotator& CamRot,
float CamFOVDeg
)

 Given updated camera information, adjust this effect to display appropriately. Particles/EmitterCameraLensEffectBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static FTransform GetAttachedEmitterTransform ( AEmitterCameraLensEffectBase const* Emitter,
const FVector& CamLoc,
const FRotator& CamRot,
float CamFOVDeg
)

   Particles/EmitterCameraLensEffectBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page