Navigation
API > API/Plugins > API/Plugins/Niagara
| Name | UNiagaraComponentRendererProperties |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraComponentRendererProperties.h |
| Include Path | #include "NiagaraComponentRendererProperties.h" |
Syntax
UCLASS (EditInlineNew, MinimalAPI, Meta=(DisplayName="Component Renderer"))
class UNiagaraComponentRendererProperties : public UNiagaraRendererProperties
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNiagaraNotifyOnChanged → UNiagaraMergeable → UNiagaraRendererProperties → UNiagaraComponentRendererProperties
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNiagaraComponentRendererProperties() |
NiagaraComponentRendererProperties.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UNiagaraComponentRendererProperties() |
NiagaraComponentRendererProperties.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ComponentRendererPropertiesToDeferredInit | TArray< TWeakObjectPtr< UNiagaraComponentRendererProperties > > | NiagaraComponentRendererProperties.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAssignComponentsOnParticleID | bool | 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. | NiagaraComponentRendererProperties.h |
|
| bCreateComponentFirstParticleFrame | bool | If true then new components can only be created on newly spawned particles. | NiagaraComponentRendererProperties.h |
|
| bOnlyActivateNewlyAquiredComponents | bool | If true then components will only be activated when newly acquired. | NiagaraComponentRendererProperties.h |
|
| bVisualizeComponents | bool | If true then the editor visualization is enabled for the component; has no effect in-game. | NiagaraComponentRendererProperties.h |
|
| ComponentCountLimit | uint32 | The max number of components that this emitter will spawn or update each frame. | NiagaraComponentRendererProperties.h |
|
| ComponentType | TSubclassOf< USceneComponent > | The scene component class to instantiate | NiagaraComponentRendererProperties.h |
|
| EnabledBinding | FNiagaraVariableAttributeBinding | 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. | NiagaraComponentRendererProperties.h |
|
| PropertyBindings | TArray< FNiagaraComponentPropertyBinding > | NiagaraComponentRendererProperties.h | ||
| RendererVisibility | int32 | If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer. | NiagaraComponentRendererProperties.h |
|
| RendererVisibilityTagBinding | FNiagaraVariableAttributeBinding | 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. | NiagaraComponentRendererProperties.h |
|
| SetterFunctionMapping | TMap< FName, FNiagaraPropertySetter > | NiagaraComponentRendererProperties.h | ||
| TemplateComponent | TObjectPtr< USceneComponent > | The object template used to create new components at runtime. | NiagaraComponentRendererProperties.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IsSetterMappingDirty | std::atomic_bool | NiagaraComponentRendererProperties.h |
Functions
Public
Overridden from UNiagaraRendererProperties
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CacheFromCompiledData
(
const FNiagaraDataSetCompiledData* CompiledData |
NiagaraComponentRendererProperties.h | ||
virtual FNiagaraBoundsCalculator * CreateBoundsCalculator() |
NiagaraComponentRendererProperties.h | ||
virtual FNiagaraRenderer * CreateEmitterRenderer
(
ERHIFeatureLevel::Type FeatureLevel, |
NiagaraComponentRendererProperties.h | ||
virtual TArray< FNiagaraVariable > GetBoundAttributes() |
NiagaraComponentRendererProperties.h | ||
virtual const TArray< FNiagaraVariable > & GetOptionalAttributes() |
NiagaraComponentRendererProperties.h | ||
virtual void GetRendererFeedback
(
const FVersionedNiagaraEmitter& InEmitter, |
NiagaraComponentRendererProperties.h | ||
virtual void GetRendererTooltipWidgets
(
const FNiagaraEmitterInstance* InEmitter, |
NiagaraComponentRendererProperties.h | ||
virtual const FSlateBrush * GetStackIcon() |
The icon to display in the niagara stack widget under the renderer section. | NiagaraComponentRendererProperties.h | |
virtual void GetUsedMaterials
(
const FNiagaraEmitterInstance* InEmitter, |
NiagaraComponentRendererProperties.h | ||
virtual FText GetWidgetDisplayName() |
The text to display in the niagara stack widget under the renderer section. | NiagaraComponentRendererProperties.h | |
virtual bool IsSimTargetSupported
(
ENiagaraSimTarget InSimTarget |
NiagaraComponentRendererProperties.h | ||
virtual bool IsSupportedVariableForBinding
(
const FNiagaraVariableBase& InSourceForBinding, |
NiagaraComponentRendererProperties.h | ||
virtual bool NeedsSystemCompletion() |
When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called | NiagaraComponentRendererProperties.h | |
virtual bool NeedsSystemPostTick() |
When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called | NiagaraComponentRendererProperties.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
bool bDuplicateForPIE |
NiagaraComponentRendererProperties.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& e |
NiagaraComponentRendererProperties.h | ||
virtual void PostInitProperties() |
NiagaraComponentRendererProperties.h | ||
virtual void PostLoad() |
NiagaraComponentRendererProperties.h |
Protected
Overridden from UNiagaraRendererProperties
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateSourceModeDerivates
(
ENiagaraRendererSourceDataMode InSourceMode, |
NiagaraComponentRendererProperties.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FNiagaraTypeDefinition GetDoubleDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFColorDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFQuatDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFRotatorDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFVector2DDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFVector3fDef() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFVector4Def() |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition GetFVectorDef() |
NiagaraComponentRendererProperties.h | ||
static void InitCDOPropertiesAfterModuleStartup() |
NiagaraComponentRendererProperties.h | ||
static bool IsConvertible
(
const FNiagaraTypeDefinition& SourceType, |
NiagaraComponentRendererProperties.h | ||
static FNiagaraTypeDefinition ToNiagaraType
(
FProperty* Property |
NiagaraComponentRendererProperties.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOnlyCreateComponentsOnParticleSpawn_DEPRECATED | bool | NiagaraComponentRendererProperties.h |