1. Epic GamesDeveloper
  3. UNiagaraComponentRendererProperties

UNiagaraComponentRendererProperties

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraComponentRendererProperties.h
Include #include "NiagaraComponentRendererProperties.h"

Syntax

UCLASS&40;EditInlineNew, MinimalAPI, Meta&61;&40;DisplayName&61;"Component Renderer"&41;&41;  
class UNiagaraComponentRendererProperties : public UNiagaraRendererProperties

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bAssignComponentsOnParticleID If true then components will not be automatically assigned to the first particle available, but try to stick to the same particle based on its unique id.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta displayname bool bCreateComponentFirstParticleFrame If true then new components can only be created on newly spawned particles.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bOnlyActivateNewlyAquiredComponents If true then components will only be activated when newly acquired.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bVisualizeComponents If true then the editor visualization is enabled for the component; has no effect in-game.
Public variable UProperty Category, EditAnywhere, Meta uint32 ComponentCountLimit The max number of components that this emitter will spawn or update each frame.
Public variable UProperty Category, EditAnywhere TSubclassOf< USceneComponent > ComponentType The scene component class to instantiate
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding EnabledBinding Which attribute should we use to check if component rendering should be enabled for a particle? This can be used to control the spawn-rate on a per-particle basis.
Public variable UProperty TArray< FNiagaraComponentPropertyBinding > PropertyBindings  
Public variable UProperty Category, EditAnywhere int32 RendererVisibility If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
Public variable UProperty Category, EditAnywhere FNiagaraVariableAttributeBinding RendererVisibilityTagBinding Which attribute should we use to check if component rendering should be enabled for a particle? This can be used to control the spawn-rate on a per-particle basis.
Public variable TMap< FName, FNiagaraPropertySetter > SetterFunctionMapping  
Public variable UProperty Category, EditAnywhere export, instanced TObjectPtr< USceneComponent > TemplateComponent The object template used to create new components at runtime.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static FNiagaraTypeDefinition  
Public function Static void  
Public function Static bool

IsConvertible ( const FNiagaraTypeDefinition& SourceType,
const FNiagaraTypeDefinition& TargetType
)

  
Public function Static FNiagaraTypeDefinition

ToNiagaraType ( FProperty* Property
)

  

Overridden from UNiagaraRendererProperties

  Type Name Description
Public function Virtual void  
Public function Virtual FNiagaraBoundsCalculator *  
Public function Virtual FNiagaraRenderer *  
Public function Virtual Const TArray< FNiagaraVariable >  
Public function Virtual const TArray< FNiagaraVariable > &  
Public function Virtual Const void  
Public function Virtual Const void

GetRendererTooltipWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget >>& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
)

  
Public function Virtual Const void

GetRendererWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget >>& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
)

  
Public function Virtual Const const FSlateBrush * The icon to display in the niagara stack widget under the renderer section.
Public function Virtual Const void

GetUsedMaterials ( const FNiagaraEmitterInstance* InEmitter,
TArray< UMaterialInterface* >& OutMaterials
)

  
Public function Virtual Const FText The text to display in the niagara stack widget under the renderer section.
Public function Virtual Const bool  
Public function Virtual Const bool

IsSupportedVariableForBinding ( const FNiagaraVariableBase& InSourceForBinding,
const FName& InTargetBindingName
)

  
Public function Virtual Const bool When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called
Public function Virtual Const bool When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called
Protected function Virtual void

UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Constants

Name Description
ComponentRendererPropertiesToDeferredInit  

Deprecated Variables

  Type Name Description
Public variable UProperty bool bOnlyCreateComponentsOnParticleSpawn_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page