Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraComponentRendererProperties

Light Theme

Dark Theme

UNiagaraComponentRendererProperties

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

UNiagaraComponentRendererProperties

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, MinimalAPI, Meta=(DisplayName="Component Renderer"))
class UNiagaraComponentRendererProperties : public UNiagaraRendererProperties

Variables

	Name	Description
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.
bool	bOnlyCreateComponentsOnParticleSpawn	If true then new components can only be created on newly spawned particles.
bool	bVisualizeComponents	If true then the editor visualization is enabled for the component; has no effect in-game.
uint32	ComponentCountLimit	The max number of components that this emitter will spawn or update each frame.
TSubclassOf< US...	ComponentType	The scene component class to instantiate
FNiagaraVariabl...	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.
TArray< FNiagar...	PropertyBindings
int32	RendererVisibility	If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.
FNiagaraVariabl...	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.
TMap< FName, FN...	SetterFunctionMapping
USceneComponent...	TemplateComponent	The object template used to create new components at runtime.

Constructors

	Name	Description
	UNiagaraComponentRendererProperties()

Destructors

	Name	Description
	~UNiagaraComponentRendererProperties()

Functions

		Name	Description
	FNiagaraType...	GetFColorDef()
	FNiagaraType...	GetFRotatorDef()
	void	InitCDOPropertiesAfterModuleStartup()
	bool	IsConvertible ( const FNiagaraTypeDefinition& Sour..., const FNiagaraTypeDefinition& Targ... )
	FNiagaraType...	ToNiagaraType ( FProperty* Property )

Overridden from UNiagaraRendererProperties

	Name	Description
void	CacheFromCompiledData ( const FNiagaraDataSetCompiledData&... )
FNiagaraBoun...	CreateBoundsCalculator()
FNiagaraRend...	CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel, const FNiagaraEmitterInstance..., const UNiagaraComponent InCom... )
const TArray...	GetBoundAttributes()
const TArray...	GetOptionalAttributes()
void	GetRendererFeedback ( UNiagaraEmitter* InEmitter, TArray< FNiagaraRendererFeedback > ..., TArray< FNiagaraRendererFeedback > ..., TArray< FNiagaraRendererFeedback > ... )
void	GetRendererTooltipWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetRendererWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
const FSlate...	GetStackIcon()	The icon to display in the niagara stack widget under the renderer section.
void	GetUsedMaterials ( const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
FText	GetWidgetDisplayName()	The text to display in the niagara stack widget under the renderer section.
bool	IsSimTargetSupported ( ENiagaraSimTarget InSimTarget )
bool	NeedsSystemCompletion()	When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called
bool	NeedsSystemPostTick()	When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called
void	UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSo..., bool bFromPropertyEdit )

Overridden from UObject

	Name	Description
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Constants

Name	Description
ComponentRendererPropertiesToDeferredInit

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss