className: UNiagaraEditorDataBase

description: A base class for editor only data which supports post loading from the runtime owner object.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, MinimalAPI) class UNiagaraEditorDataBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description:
Synchronize all source script variables that have been changed or removed from the parameter definitions to all eligible destination script variables owned by the editor data.
Returns an array of name pairs representing old names of script vars that were synced and the new names they inherited, respectively.

module: Niagara

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [TTuple](API\Runtime\Core\Misc\TTuple)< [FName](API\Runtime\Core\UObject\FName), [FName](API\Runtime\Core\UObject\FName) > > SynchronizeParametersWithParameterDefinitions ( const [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraParameterDefinitionsBase](API\Plugins\Niagara\UNiagaraParameterDefinitionsBase) * > TargetDefinitions, const [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraParameterDefinitionsBase](API\Plugins\Niagara\UNiagaraParameterDefinitionsBase) * > AllDefinitions, const [TSet](API\Runtime\Core\Containers\TSet)< [FGuid](API\Runtime\Core\Misc\FGuid) > & AllDefinitionsParameterIds, [INiagaraParameterDefinitionsSubscriber](API\Plugins\Niagara\INiagaraParameterDefinitionsSubs-) * Subscriber, [FSynchronizeWithParameterDefinitionsArgs](API\Plugins\Niagara\FSynchronizeWithParameterDefinit-) Args )


className: UNiagaraEditorParametersAdapterBase

description: A base class for editor only data which owns UNiagaraScriptVariables and supports synchronizing them with definitions.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, MinimalAPI) class UNiagaraEditorParametersAdapterBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


className: CurrentPerfBaselineVersion

description: The current version for perf baselines. Regenerate this if there are significant performance improvements that would invalidate existing baseline data.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) CurrentPerfBaselineVersion = FGuid(0xD854D103, 0x87C17A44, 0x87CA4524, 0x5F72FBC2);


code: static void DeclareConstructClasses ( [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutConstructClasses, const [UClass](API\Runtime\CoreUObject\UObject\UClass) * SpecificSubclass )


className: FGeneratePerfBaselines

code: typedef TBaseDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraEffectType](API\Plugins\Niagara\UNiagaraEffectType) * > & > FGeneratePerfBaselines


description: Performs the passed action for all FNiagaraPlatformSets in this FXType.

code: template<typename TAction> void ForEachPlatformSet ( TAction Func )


code: static void GeneratePerfBaselines()


className: GeneratePerfBaselinesDelegate

description: Delegate allowing us to call into editor code to generate performance baselines.


code: const [FNiagaraEmitterScalabilitySettings](API\Plugins\Niagara\FNiagaraEmitterScalabilitySettin-) & GetActiveEmitterScalabilitySettings() const


code: const [FNiagaraEmitterScalabilitySettingsArray](API\Plugins\Niagara\FNiagaraEmitterScalabilitySettin-_1) & GetEmitterScalabilitySettings() const


code: const [FNiagaraSystemScalabilitySettings](API\Plugins\Niagara\FNiagaraSystemScalabilitySetting-) & GetActiveSystemScalabilitySettings() const


code: [FNiagaraPerfBaselineStats](API\Plugins\Niagara\FNiagaraPerfBaselineStats) & GetPerfBaselineStats() const


code: [UNiagaraSignificanceHandler](API\Plugins\Niagara\UNiagaraSignificanceHandler) * GetSignificanceHandler() const


code: const [FNiagaraSystemScalabilitySettingsArray](API\Plugins\Niagara\FNiagaraSystemScalabilitySetting-_1) & GetSystemScalabilitySettings() const


description:
Called to check if the object is ready for FinishDestroy. This is called after BeginDestroy to check the completion of the potentially asynchronous object cleanup.
True if the object's asynchronous cleanup has completed and it is ready for FinishDestroy to be called.

code: virtual bool IsReadyForFinishDestroy()


code: static FGeneratePerfBaselines & OnGeneratePerfBaselines()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SpawnBaselineActor ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: UNiagaraEffectType ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: void UpdatePerfBaselineStats ( [FNiagaraPerfBaselineStats](API\Plugins\Niagara\FNiagaraPerfBaselineStats) & NewBaselineStats )


className: UNiagaraEffectType

description: Contains settings and working data shared among many NiagaraSystems that share some commonality of type. For example ImpactFX vs EnvironmentalFX.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Niagara, PerObjectConfig, MinimalAPI) class UNiagaraEffectType : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bAllowCullingForLocalPlayers

type: bool

description: Controls whether or not culling is allowed for FX that are owned by, attached to or instigated by a locally controlled pawn.

bNewSystemsSinceLastScalabilityUpdate

type: uint32:  1

description: Marks that there have been new systems added for this effect type since it's last scalability manager update.

CullReaction

type: ENiagaraCullRea...

description: How effects of this type react when they fail the cull checks.

EmitterScalabilitySettings

type: FNiagaraEmitter...

NumInstances

description: Total number of instances across all systems for this effect type.

SignificanceHandler

type: TObjectPtr<UNi...

description: Used to determine the relative significance of FX in the scene which is used in other scalability systems such as instance count culling.

SystemScalabilitySettings

type: FNiagaraSystemS...

UpdateFrequency

type: ENiagaraScalabi...

description: How regularly effects of this type are checked for scalability.

ValidationRules

type: TArray<TObject...

description: A set of rules to apply when checking content.

ValidationRuleSets

description: Array of reusable rule sets to apply when checking content.


code: void AddEventHandler ( [FNiagaraEventScriptProperties](API\Plugins\Niagara\FNiagaraEventScriptProperties) EventHandler, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) AddNewVersion ( int32 MajorVersion, int32 MinorVersion )


code: void AddRenderer ( [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * Renderer, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: void AddSimulationStage ( [UNiagaraSimulationStageBase](API\Plugins\Niagara\UNiagaraSimulationStageBase) * SimulationStage, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: bool CanObtainParticleAttribute ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVar, const [FGuid](API\Runtime\Core\Misc\FGuid) & EmitterVersion, [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & OutBoundType ) const


code: bool CanObtainEmitterAttribute ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVarWithUniqueNameNamespace, [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & OutBoundType ) const


code: bool CanObtainSystemAttribute ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVar, [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) & OutBoundType ) const


code: bool CanObtainUserVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InVar ) const


code: void ChangeParentVersion ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NewParentVersion, const [FGuid](API\Runtime\Core\Misc\FGuid) & EmitterVersion )


description: Makes sure that the default version data is available and fixes old emitter assets.

code: void CheckVersionDataAvailable()


description: Creates a new emitter by duplicating an existing emitter. The new emitter will reference the same parent emitter if one is available.

code: static [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * CreateAsDuplicate ( const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) & InEmitterToDuplicate, [FName](API\Runtime\Core\UObject\FName) InDuplicateName, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & InDuplicateOwnerSystem )


description: Creates a new emitter with the supplied emitter as a parent emitter and the supplied system as it's owner.

code: static [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * CreateWithParentAndOwner ( [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) InParentEmitter, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InOwner, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags FlagMask )


code: static void DeclareConstructClasses ( [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutConstructClasses, const [UClass](API\Runtime\CoreUObject\UObject\UClass) * SpecificSubclass )


description: Deletes the version data for an existing version. The exposed version cannot be deleted and will result in an error. Does nothing if the guid does not exist in the version data.

code: virtual void DeleteVersion ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid )


description: Disables versioning and keeps only the data from the given version guid. Note that this breaks ALL references from existing assets and should only be used when creating a copy of an emitter, as the effect is very destructive.

code: virtual void DisableVersioning ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuidToUse )


description: Duplicates this emitter, but prevents the duplicate from merging in changes from the parent emitter. The resulting duplicate will have no parent information.

code: [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * DuplicateWithoutMerging ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InOuter )


className: EmitterMergeMessageId

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) EmitterMergeMessageId;


description: Enables versioning for this emitter asset.

code: virtual void EnableVersioning()


description: Changes the exposed version. Does nothing if the guid does not exist in the version data.

code: virtual void ExposeVersion ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid )


description: Returns the version data for the given guid, if it exists. Otherwise returns nullptr.

code: virtual [FNiagaraAssetVersion](API\Plugins\Niagara\FNiagaraAssetVersion) const * FindVersionData ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid ) const


className: FOnEmitterCompiled

code: typedef TMulticastDelegate_OneParam< void, [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) > FOnEmitterCompiled


className: FOnEventHandlersChanged

code: typedef TMulticastDelegate_NoParams< void > FOnEventHandlersChanged


className: FOnPropertiesChanged

code: typedef TMulticastDelegate_NoParams< void > FOnPropertiesChanged


className: FOnRenderersChanged

code: typedef TMulticastDelegate_NoParams< void > FOnRenderersChanged


className: FOnSimStagesChanged

code: typedef TMulticastDelegate_NoParams< void > FOnSimStagesChanged


code: template<typename TAction> void ForEachVersionData ( TAction Func ) const


code: template<typename TAction> void ForEachVersionData ( TAction Func )


description: Returns all available versions for this emitter.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraAssetVersion](API\Plugins\Niagara\FNiagaraAssetVersion) > GetAllAvailableVersions() const


description: Get allUNiagaraScriptSourceBaseof this subscriber.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraScriptSourceBase](API\Plugins\Niagara\UNiagaraScriptSourceBase) * > GetAllSourceScripts()


description: Get the cached parameter map traversal for this emitter.

code: const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraGraphCachedDataBase](API\Plugins\Niagara\FNiagaraGraphCachedDataBase), ESPMode::ThreadSafe > & GetCachedTraversalData ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EmitterVersion ) const


description: Get All adapters to editor only script vars owned directly by this subscriber.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [UNiagaraEditorParametersAdapterBase](API\Plugins\Niagara\UNiagaraEditorParametersAdapterB-) * > GetEditorOnlyParametersAdapters()


description: Gets a Guid which is updated any time data in this emitter is changed.


description: Returns the emitter data for a specific version or nullptr if no such version is found. For the null-Guid it returns the exposed version.

code: [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetEmitterData ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid )


code: const [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetEmitterData ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid ) const


description: Returns the version of the exposed version data (i.e. the version used when adding an emitter to a system)

code: virtual [FNiagaraAssetVersion](API\Plugins\Niagara\FNiagaraAssetVersion) GetExposedVersion() const


code: static bool GetForceCompileOnLoad()


description: Returns the emitter data for latest exposed version.


description: Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects

code: virtual void GetAssetRegistryTags ( [TArray](API\Runtime\Core\Containers\TArray)< [FAssetRegistryTag](API\Runtime\CoreUObject\UObject\UObject\FAssetRegistryTag) > & OutTags ) const


code: const [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetLatestEmitterData() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FParameterDefinitionsSubscription](API\Plugins\Niagara\FParameterDefinitionsSubscriptio-) > & GetParameterDefinitionsSubscriptions() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FParameterDefinitionsSubscription](API\Plugins\Niagara\FParameterDefinitionsSubscriptio-) > & GetParameterDefinitionsSubscriptions()


description: Get the path to theUObjectof this subscriber.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetSourceObjectPathName() const


code: [TStatId](API\Runtime\Core\Stats\TStatId) GetStatID ( bool bGameThread, bool bConcurrent ) const


code: const [FString](API\Runtime\Core\Containers\FString) & GetUniqueEmitterName() const


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraVersionDataAccessor](API\Plugins\Niagara\FNiagaraVersionDataAccessor) > GetVersionDataAccessor ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Version )


description: Helper method for when a rename has been detected within the graph. Covers resetting the internal renderer bindings.

code: void HandleVariableRemoved ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InOldVariable, bool bUpdateContexts, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


description: Helper method for when a rename has been detected within the graph. Covers renaming the internal renderer bindings.

code: void HandleVariableRenamed ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InOldVariable, const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InNewVariable, bool bUpdateContexts, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: bool IsEnabledOnPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName ) const


description:
Called during saving to determine if the object is forced to be editor only or not
true if this object should never be loaded outside the editor

code: virtual bool IsEditorOnly() const


description: Whether or not this emitter is synchronized with its parent emitter.

code: bool IsSynchronizedWithParent() const


description: If true then this script asset uses active version control to track changes.

code: virtual bool IsVersioningEnabled() const


description: Merges in any changes from the parent emitter into this emitter.


code: void MoveRenderer ( [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * Renderer, int32 NewIndex, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: void MoveSimulationStageToIndex ( [UNiagaraSimulationStageBase](API\Plugins\Niagara\UNiagaraSimulationStageBase) * SimulationStage, int32 TargetIndex, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: virtual bool NeedsLoadForTargetPlatform ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


code: void NotifyScratchPadScriptsChanged()


description: Callback issued whenever a VM compilation successfully happened (even if the results are a script that cannot be executed due to errors)


description: Callback issued whenever a GPU compilation successfully happened (even if the results are a script that cannot be executed due to errors)


code: void OnPostCompile ( const [FGuid](API\Runtime\Core\Misc\FGuid) & EmitterVersion )


code: virtual void PostDuplicate ( [EDuplicateMode::Type](API\Runtime\CoreUObject\UObject\EDuplicateMode__Type) DuplicateMode )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: virtual void PostEditChangeVersionedProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent, const [FGuid](API\Runtime\Core\Misc\FGuid) & Version )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Called at the end ofRename(), but only if the rename was actually carried out

code: virtual void PostRename ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * OldOuter, const [FName](API\Runtime\Core\UObject\FName) OldName )


description: Objects created from within PreSave will NOT have PreSave called on them!!!

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid PreSave ( [FObjectPreSaveContext](API\Runtime\CoreUObject\UObject\FObjectPreSaveContext) ObjectSaveContext )


className: EventHandlerScriptProps

code: static EventHandlerScriptProps = ((void)sizeof(UEAsserts_Private::GetMemberNameCheckedJunk((( FVersionedNiagaraEmitterData )0)-> EventHandlerScriptProps )), FName(TEXT("EventHandlerScriptProps")));


className: PrivateMemberNames

code: struct PrivateMemberNames


description: Helper method for binding the notifications needed for proper editor integration.

code: void RebindNotifications()


code: void RemoveEventHandlerByUsageId ( [FGuid](API\Runtime\Core\Misc\FGuid) EventHandlerUsageId, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: void RemoveRenderer ( [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * Renderer, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


code: void RemoveSimulationStage ( [UNiagaraSimulationStageBase](API\Plugins\Niagara\UNiagaraSimulationStageBase) * SimulationStage, [FGuid](API\Runtime\Core\Misc\FGuid) EmitterVersion )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetEditorData ( [UNiagaraEditorDataBase](API\Plugins\Niagara\UNiagaraEditorDataBase) * InEditorData, const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid )


code: bool SetUniqueEmitterName ( const [FString](API\Runtime\Core\Containers\FString) & InName )


code: void SetParent ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InParent )


code: UNiagaraEmitter ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNiagaraEmitter

description: Niagara Emitters are particle spawners that can be reused for different effects by putting them into Niagara Systems. Emitters render their particles using different renderers, such as Sprite Renderers or Mesh Renderers to produce different effects.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UNiagaraEmitter : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [INiagaraParameterDefinitionsSubscriber](API\Plugins\Niagara\INiagaraParameterDefinitionsSubs-), public [FNiagaraVersionedObject](API\Plugins\Niagara\FNiagaraVersionedObject)

Category

type: FText

description: Category to collate this emitter into for "add new emitter" dialogs.

LibraryVisibility

type: ENiagaraScriptL...

description: If this emitter is exposed to the library, or should be explicitly hidden.

TemplateSpecification

type: ENiagaraScriptT...

ThumbnailImage

type: TObjectPtr<UTe...

description: Internal: The thumbnail image.

VersionToOpenInEditor

type: FGuid

description: This is used as a transient value to open a specific version in the editor


code: virtual void PerformAction ( [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) & OwningSim, const [FNiagaraEventReceiverProperties](API\Plugins\Niagara\FNiagaraEventReceiverProperties) & OwningEventReceiver )


className: UNiagaraEventReceiverEmitterAction

description: Base class for actions that an event receiver will perform at the emitter level.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract) class UNiagaraEventReceiverEmitterAction : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


NumParticles

description: Number of particles to spawn per event received.


description: Returns a free collision group for use in HWRT collision group filtering. Returns -1 on failure.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")) static int32 AcquireNiagaraGPURayTracedCollisionGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject )


code: static bool DefineFunctionHLSL ( const [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) & FunctionSignature, [FString](API\Runtime\Core\Containers\FString) & HlslOutput )


description: Finds an array interface of the given class.

code: template<class TDIType> static TDIType * GetDataInterface ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, [FName](API\Runtime\Core\UObject\FName) OverrideName )


code: static [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * GetDataInterface ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * DIClass, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, [FName](API\Runtime\Core\UObject\FName) OverrideName )


description: Static void SetUpdateScriptConstant(UNiagaraComponent* Component, FName EmitterName, FName ConstantName, FVector Value);

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara parameter collection", WorldContext="WorldContextObject")) static [UNiagaraParameterCollectionInstance](API\Plugins\Niagara\UNiagaraParameterCollectionInsta-) * GetNiagaraParameterCollection ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * Collection )


code: static bool GetVectorVMFastPathExternalFunction ( const [FVMExternalFunctionBindingInfo](API\Plugins\Niagara\FVMExternalFunctionBindingInfo) & BindingInfo, FVMExternalFunction & OutFunc )


description: Get the skeletal mesh data interface by name .

code: static [UNiagaraDataInterfaceSkeletalMesh](API\Plugins\Niagara\UNiagaraDataInterfaceSkeletalMes-) * GetSkeletalMeshDataInterface ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName )


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) > & GetVectorVMFastPathOps ( bool bIgnoreConsoleVariable )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Niagara Static Mesh Directly")) static void OverrideSystemUserVariableStaticMesh ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * StaticMesh )


description: Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Niagara Skeletal Mesh Component")) static void OverrideSystemUserVariableSkeletalMeshComponent ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, [USkeletalMeshComponent](API\Runtime\Engine\Components\USkeletalMeshComponent) * SkeletalMeshComponent )


description: Releases a collision group back to the system for use by ohers.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")) static void ReleaseNiagaraGPURayTracedCollisionGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, int32 CollisionGroup )


description: Sets the Niagara GPU ray traced collision group for all primitive components on the given actor.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")) static void SetActorNiagaraGPURayTracedCollisionGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [AActor](API\Runtime\Engine\GameFramework\AActor) * Actor, int32 CollisionGroup )


description: Sets the Niagara GPU ray traced collision group for the give primitive component.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara collision ray tracing", WorldContext="WorldContextObject")) static void SetComponentNiagaraGPURayTracedCollisionGroup ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) * Primitive, int32 CollisionGroup )


description: for (TSharedPtr&Emitter : Emitters) { if(UNiagaraEmitter* PinnedProps = Emitter->GetProperties().Get()) {FNameCurName = *PinnedProps->EmitterName; if (CurName == EmitterName) { Emitter->GetProperties()->UpdateScriptProps.ExternalConstants.SetOrAdd(FNiagaraTypeDefinition::GetVec4Def(), ConstantName, Value); break; } } } }

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Niagara Static Mesh Component")) static void OverrideSystemUserVariableStaticMeshComponent ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) * StaticMeshComponent )


description: Sets the Filtered Bones to use on the skeletal mesh data interface, this is destructive as it modifies the data interface.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetSkeletalMeshDataInterfaceFilteredBones ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & FilteredBones )


description: Sets the Filtered Sockets to use on the skeletal mesh data interface, this is destructive as it modifies the data interface.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetSkeletalMeshDataInterfaceFilteredSockets ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & FilteredSockets )


description: Overrides the 2D Array Texture for a Niagara 2D Array Texture Data Interface User Parameter.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetTexture2DArrayObject ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, class [UTexture2DArray](API\Runtime\Engine\Engine\UTexture2DArray) * Texture )


description: Overrides the Texture Object for a Niagara Texture Data Interface User Parameter.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetTextureObject ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, [UTexture](API\Runtime\Engine\Engine\UTexture) * Texture )


description: Overrides the Volume Texture for a Niagara Volume Texture Data Interface User Parameter.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetVolumeTextureObject ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, [UVolumeTexture](API\Runtime\Engine\Engine\UVolumeTexture) * Texture )


description:
Spawns a Niagara System at the specified world location/rotation
The spawnedUNiagaraComponent

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara System", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")) static [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * SpawnSystemAtLocation ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContextObject, class [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * SystemTemplate, FVector Location, FRotator Rotation, FVector Scale, bool bAutoDestroy, bool bAutoActivate, [ENCPoolMethod](API\Plugins\Niagara\ENCPoolMethod) PoolingMethod, bool bPreCullCheck )


description: Sets the SamplingRegion to use on the skeletal mesh data interface, this is destructive as it modifies the data interface.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara) static void SetSkeletalMeshDataInterfaceSamplingRegions ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * NiagaraSystem, const [FString](API\Runtime\Core\Containers\FString) & OverrideName, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & SamplingRegions )


description:
Spawns a Niagara System attached to a component
The spawnedUNiagaraComponent

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara System", UnsafeDuringActorConstruction="true")) static [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * SpawnSystemAttached ( [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * SystemTemplate, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * AttachToComponent, [FName](API\Runtime\Core\UObject\FName) AttachPointName, FVector Location, FRotator Rotation, [EAttachLocation::Type](API\Runtime\Engine\Engine\EAttachLocation__Type) LocationType, bool bAutoDestroy, bool bAutoActivate, [ENCPoolMethod](API\Plugins\Niagara\ENCPoolMethod) PoolingMethod, bool bPreCullCheck )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara System", WorldContext="WorldContextObject", UnsafeDuringActorConstruction="true")) static [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * SpawnSystemAtLocationWithParams ( const [FFXSystemSpawnParameters](API\Runtime\Engine\Particles\FFXSystemSpawnParameters) & SpawnParams )


code: static [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * SpawnSystemAttached ( [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * SystemTemplate, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * AttachToComponent, [FName](API\Runtime\Core\UObject\FName) AttachPointName, FVector Location, FRotator Rotation, FVector Scale, [EAttachLocation::Type](API\Runtime\Engine\Engine\EAttachLocation__Type) LocationType, bool bAutoDestroy, [ENCPoolMethod](API\Plugins\Niagara\ENCPoolMethod) PoolingMethod, bool bAutoActivate, bool bPreCullCheck )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(Keywords="niagara System", UnsafeDuringActorConstruction="true")) static [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * SpawnSystemAttachedWithParams ( const [FFXSystemSpawnParameters](API\Runtime\Engine\Particles\FFXSystemSpawnParameters) & SpawnParams )


className: VectorVMOpsHLSL

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > VectorVMOpsHLSL;


className: VectorVMOps

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) > VectorVMOps;


code: UNiagaraFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNiagaraFunctionLibrary

description: A C++ and Blueprint accessible library of utility functions for accessing Niagara simulations All positions & orientations are returned in Unreal reference frame & units, assuming the Leap device is located at the origin.


code: virtual [FNiagaraRenderer](API\Plugins\Niagara\FNiagaraRenderer) * CreateEmitterRenderer ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * Emitter, const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & InController )


code: virtual void CacheFromCompiledData ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledData )


code: virtual [FNiagaraBoundsCalculator](API\Plugins\Niagara\FNiagaraBoundsCalculator) * CreateBoundsCalculator()


code: virtual void GetRendererFeedback ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutErrors, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutInfo ) const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetOptionalAttributes()


code: virtual void GetRendererTooltipWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual void GetRendererWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual void GetUsedMaterials ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & OutMaterials ) const


description: The bindings depend on variables that are created during the NiagaraModule startup. However, the CDO's are build prior to this being initialized, so we defer setting these values until later.


code: virtual bool IsSimTargetSupported ( [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InSimTarget ) const


className: LightRendererPropertiesToDeferredInit


description: In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation.

code: virtual bool PopulateRequiredBindings ( [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & InParameterStore )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


code: virtual void UpdateSourceModeDerivates ( [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode, bool bFromPropertyEdit )


code: UNiagaraLightRendererProperties()


className: UNiagaraLightRendererProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, MinimalAPI, Meta=(DisplayName="Light Renderer")) class UNiagaraLightRendererProperties : public [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties)

bAffectsTranslucency

description: Whether lights from this renderer should affect translucency.

bAlphaScalesBrightness

description: When checked, will treat the alpha value of the particle's color as a multiplier of the light's brightness.

bOverrideInverseExposureBlend

description: When enabled we will override the project default setting with our local setting.

bUseInverseSquaredFalloff

description: Whether to use physically based inverse squared falloff from the light.

ColorAdd

description: A static color shift applied to each rendered light

ColorBinding

type: FNiagaraVariabl...

description: Which attribute should we use for light color when generating lights?

ColorDataSetAccessor

type: FNiagaraDataSet...

DefaultExponent

type: float

description: The exponent to use for all lights if no exponent binding was found

InverseExposureBlend

description: Blend Factor used to blend between Intensity and Intensity/Exposure.

LightExponentBinding

description: Which attribute should we use for the light's exponent when inverse squared falloff is disabled?

LightRenderingEnabledBinding

description: Which attribute should we use to check if light rendering should be enabled for a particle? This can be used to control the spawn-rate on a per-particle basis.

PositionBinding

description: Which attribute should we use for position when generating lights?

RadiusBinding

description: Which attribute should we use for light radius when generating lights?

RadiusScale

description: A factor used to scale each particle light radius

RendererVisibility

description: If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer.

RendererVisibilityTagBinding

description: Which attribute should we use for the renderer visibility tag?

SourceMode

type: ENiagaraRendere...

description: Whether or not to draw a single element for the Emitter or to draw the particles.

VolumetricScatteringBinding

description: Which attribute should we use for the intensity of the volumetric scattering from this light? This scales the light's intensity and color.


code: void ApplyMaterialOverrides ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * EmitterInstance, [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & InOutMaterials ) const


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual void CacheFromCompiledData ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledData )


code: bool ChangeRequiresMeshListRebuild ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property )


code: virtual void CollectPSOPrecacheData ( [FPSOPrecacheParamsList](API\Plugins\Niagara\UNiagaraRendererProperties\FPSOPrecacheParamsList) & OutParams )


code: virtual [FNiagaraBoundsCalculator](API\Plugins\Niagara\FNiagaraBoundsCalculator) * CreateBoundsCalculator()


code: virtual [FNiagaraRenderer](API\Plugins\Niagara\FNiagaraRenderer) * CreateEmitterRenderer ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * Emitter, const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & InController )


code: virtual void GetAdditionalVariables ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & OutArray ) const


description: Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties.

code: virtual [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) GetBoundAttribute ( const [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) * Binding ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > GetBoundAttributes() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetOptionalAttributes()


code: virtual void GetRendererFeedback ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutErrors, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutInfo ) const


code: virtual void GetRendererTooltipWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


code: virtual void GetRendererWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual void GetStreamingMeshInfo ( const FBoxSphereBounds & OwnerBounds, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FStreamingRenderAssetPrimitiveInfo](API\Runtime\Engine\Engine\FStreamingRenderAssetPrimitiveIn-) > & OutStreamingRenderAssets ) const


code: virtual void GetUsedMaterials ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & OutMaterials ) const


code: virtual const [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetVertexFactoryType() const


description: The bindings depend on variables that are created during the NiagaraModule startup. However, the CDO's are build prior to this being initialized, so we defer setting these values until later.


code: virtual bool IsSimTargetSupported ( [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InSimTarget ) const


className: MeshRendererPropertiesToDeferredInit

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UNiagaraMeshRendererProperties](API\Plugins\Niagara\UNiagaraMeshRendererProperties) > > MeshRendererPropertiesToDeferredInit;


code: virtual bool NeedsMIDsForMaterials() const


code: void OnAssetReimported ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * )


code: void OnMeshPostBuild ( [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation.

code: virtual bool PopulateRequiredBindings ( [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & InParameterStore )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This is called when a property is about to be modified externally

code: virtual void PreEditChange ( class [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


code: virtual void RemoveVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


code: virtual void RenameVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & NewVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetPreviousBindings ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & SrcEmitter, [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode )


code: virtual void UpdateSourceModeDerivates ( [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode, bool bFromPropertyEdit )


code: virtual bool UseHeterogeneousVolumes() const


className: UNiagaraMeshRendererProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Meta=(DisplayName="Mesh Renderer"), MinimalAPI) class UNiagaraMeshRendererProperties : public [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties)

bEnableCameraDistanceCulling

description: Enables frustum culling of individual mesh particles

bEnableMeshFlipbook

description: When checked, will treat 'ParticleMesh' as the first frame of the flipbook, and will use the other mesh flipbook options to find the other frames

bLockedAxisEnable

description: If true and in a non-default facing mode, will lock facing direction to an arbitrary plane of rotation

bOverrideMaterials

description: Whether or not to use the OverrideMaterials array instead of the mesh's existing materials.

bSortOnlyWhenTranslucent

description: If true, the particles are only sorted when using a translucent material.

bSubImageBlend

description: If true, blends the sub-image UV lookup with its next adjacent member using the fractional part of the SubImageIndex float value as the linear interpolation factor.

bUseHeterogeneousVolumes

description: Whether or not to render with heterogeneous volumes.

CameraOffsetBinding

description: Which attribute should we use for camera offset when rendering meshes?

ColorBinding

description: Which attribute should we use for color when generating instanced meshes?

CustomSortingBinding

description: Which attribute should we use custom sorting of particles in this emitter.

description: Which attribute should we use for dynamic material parameters when generating instanced meshes?

FacingMode

type: ENiagaraMeshFac...

description: Determines how the mesh orients itself relative to the camera.

FirstFlipbookFrame

type: TObjectPtr<USt...

description: The static mesh to use for the first frame of the flipbook.

FlipbookSuffixFormat

type: FString

description: Provides the format of the suffix of the names of the static meshes when searching for flipbook frames.

FlipbookSuffixNumDigits

description: The number of digits to expect in the frame number of the flipbook page.

GpuTranslucentLatency

description: Gpu simulations run at different points in the frame depending on what features are used, i.e. depth buffer, distance fields, etc.

LockedAxis

type: FVector

description: Arbitrary axis by which to lock facing rotations

LockedAxisSpace

type: ENiagaraMeshLoc...

description: Specifies what space the locked axis is in

MaterialParameters

type: FNiagaraRendere...

description: If this array has entries, we will create a MaterialInstanceDynamic per Emitter instance from Material and set the Material parameters using the Niagara simulation variables listed.

MaterialRandomBinding

description: Which attribute should we use for material randoms when generating instanced meshes?

MeshBoundsScale

description: Scale factor applied to all of the meshes bounds.

Meshes

type: TArray<FNiagar...

description: The static mesh(es) to be instanced when rendering mesh particles.

MeshIndexBinding

description: Which attribute should we use to pick the element in the mesh array on the mesh renderer?

MeshOrientationBinding

description: Which attribute should we use for orienting meshes when generating instanced meshes?

NormalizedAgeBinding

description: Which attribute should we use for Normalized Age?

NumFlipbookFrames

description: The number of frames (static meshes) to be included in the flipbook.

OverrideMaterials

description: The materials to be used instead of the StaticMesh's materials.

PositionBinding

description: Which attribute should we use for position when generating instanced meshes?

ScaleBinding

description: Which attribute should we use for scale when generating instanced meshes?

SortMode

type: ENiagaraSortMod...

description: Determines how we sort the particles prior to rendering.

SortPrecision

description: Sort precision to use when sorting is active.

SubImageIndexBinding

description: Which attribute should we use for sprite sub-image indexing when generating sprites?

SubImageSize

description: When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y.

VelocityBinding

description: Which attribute should we use for velocity when generating instanced meshes?


code: virtual bool Equals ( const [UNiagaraMessageDataBase](API\Plugins\Niagara\UNiagaraMessageDataBase) * Other ) const


code: virtual bool GetAllowDismissal() const


className: UNiagaraMessageDataBase

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UNiagaraMessageDataBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: void AddDefaultSourceParameters()


code: int32 AddParameter ( [FName](API\Runtime\Core\UObject\FName) Name, [FNiagaraTypeDefinition](API\Plugins\Niagara\FNiagaraTypeDefinition) Type )


code: int32 AddParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter )


description: Takes the real parameter name used under the hood and converts to the friendly name for use in the UI. Converts from "CollectionUniqueName_ParameterName" to "ParameterName".

code: [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) CollectionParameterFromFriendlyParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & FriendlyParameter ) const


code: [FString](API\Runtime\Core\Containers\FString) FriendlyNameFromParameterName ( [FString](API\Runtime\Core\Containers\FString) ParameterName ) const


className: FOnChanged

code: typedef TMulticastDelegate_NoParams< void > FOnChanged


code: [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) FriendlyParameterFromCollectionParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & CollectionParameter ) const


description: The compile Id is an indicator to any compiled scripts that reference this collection that contents may have changed and a recompile is recommended to be safe.


description: TODO: Optional per platform overrides of the above. TMapPerPlatformOverrides;


code: const [UNiagaraParameterCollectionInstance](API\Plugins\Niagara\UNiagaraParameterCollectionInsta-) * GetDefaultInstance() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetParameters()


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetParameters() const


description: Takes the friendly name presented to the UI and converts to the real parameter name used under the hood. Converts from "ParameterName" to "CollectionUniqueName_ParameterName".

code: [FString](API\Runtime\Core\Containers\FString) ParameterNameFromFriendlyName ( const [FString](API\Runtime\Core\Containers\FString) & FriendlyName ) const


code: const [UMaterialParameterCollection](API\Runtime\Engine\Materials\UMaterialParameterCollection) * GetSourceCollection() const


code: int32 IndexOfParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Var )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: virtual void PostDuplicate ( [EDuplicateMode::Type](API\Runtime\CoreUObject\UObject\EDuplicateMode__Type) DuplicateMode )


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


code: void RemoveParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter )


code: void RenameParameter ( [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter, [FName](API\Runtime\Core\UObject\FName) NewName )


description: If for any reason this data has changed externally and needs recompilation and it isn't autodetected, use this method.

code: void RefreshCompileId()


code: UNiagaraParameterCollection ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNiagaraParameterCollection

description: Asset containing a collection of global parameters usable by Niagara.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UNiagaraParameterCollection : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

CompileId

description: Used to track whenever something of note changes in this parameter collection that might invalidate a compilation downstream of a script/emitter/system.

DefaultInstance

type: TObjectPtr<UNi...

Namespace

type: FName

description: Namespace for this parameter collection. Is enforced to be unique across all parameter collections.

OnChangedDelegate

type: FOnChanged

SourceMaterialCollection

type: TObjectPtr<UMa...

description: Optional set of MPC that can drive scalar and vector parameters


code: void Bind ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: bool AddParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Bool Parameter")) bool GetBoolParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Color Parameter")) [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColorParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Int Parameter")) int32 GetIntParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Float Parameter")) float GetFloatParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: void GetParameters ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & OutParameters )


code: [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * GetParent() const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Quaternion Parameter")) FQuat GetQuatParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Vector2D Parameter")) FVector2D GetVector2DParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Vector4 Parameter")) FVector4 GetVector4Parameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Get Vector Parameter")) FVector GetVectorParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName )


code: const [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & GetParameterStore() const


code: bool OverridesParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter ) const


code: bool RemoveParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter )


code: virtual void PostLoad()


code: void RenameParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter, [FName](API\Runtime\Core\UObject\FName) NewName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Bool Parameter")) void SetBoolParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, bool InValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Color Parameter")) void SetColorParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, [FLinearColor](API\Runtime\Core\Math\FLinearColor) InValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Float Parameter")) void SetFloatParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, float InValue )


code: void SetParent ( [UNiagaraParameterCollection](API\Plugins\Niagara\UNiagaraParameterCollection) * InParent )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Int Parameter")) void SetIntParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, int32 InValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Quaternion Parameter")) void SetQuatParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, const FQuat & InValue )


code: void SetOverridesParameter ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & Parameter, bool bOverrides )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Vector2D Parameter")) void SetVector2DParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, FVector2D InValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Vector4 Parameter")) void SetVector4Parameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, const FVector4 & InValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=Niagara, Meta=(DisplayName="Set Vector Parameter")) void SetVectorParameter ( const [FString](API\Runtime\Core\Containers\FString) & InVariableName, FVector InValue )


description: Synchronizes this instance with any changes with it's parent collection.

code: void SyncWithCollection()


code: void Tick ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: UNiagaraParameterCollectionInstance ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNiagaraParameterCollectionInstance

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UNiagaraParameterCollectionInstance : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Collection

description: TODO: Abstract to some interface to allow a hierarchy likeUMaterialInstance?

OverridenParameters

description: When editing instances, we must track which parameters are overridden so we can pull in any changes to the default.


code: virtual int32 GetChangeIdHash() const


className: FOnParameterDefinitionsChanged

code: typedef TMulticastDelegate_NoParams< void > FOnParameterDefinitionsChanged


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetDefinitionsUniqueId() const


code: virtual [TSet](API\Runtime\Core\Containers\TSet)< [FGuid](API\Runtime\Core\Misc\FGuid) > GetParameterIds() const


description:
Called during saving to determine if the object is forced to be editor only or not
true if this object should never be loaded outside the editor

code: virtual bool IsEditorOnly() const


className: UNiagaraParameterDefinitionsBase

description: Stub class. Collection of UNiagaraScriptVariables to synchronize between UNiagaraScripts.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, Abstract) class UNiagaraParameterDefinitionsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

OnParameterDefinitionsChangedDelegate

type: FOnParameterDef...

UniqueId

type: FGuid


className: UNiagaraParticleCallbackHandler

code: class UNiagaraParticleCallbackHandler : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


code: class UNiagaraPhysicsAssetDICollectorInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


code: UNiagaraPhysicsAssetDICollectorInterface ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Applies this axis for the preview at PreviewIndex on this axis.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent) void ApplyToPreview ( [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * PreviewComponent, int32 PreviewIndex, bool bIsXAxis, [FString](API\Runtime\Core\Containers\FString) & OutLabelText )


description: Returns the number of previews for this axis.


code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


className: UNiagaraPreviewAxis

description: Base class for all preview axis types. NiagaraPreviewGrid uses these to control how many systems to spawn in each axis and how each system varies on that axis. C++ Examples are show below. You can also create these as Blueprint classes as show in the Plugin content folder.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual int32 Num_Implementation()


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamBase : public [UNiagaraPreviewAxis](API\Plugins\Niagara\UNiagaraPreviewAxis)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamFloat : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamInt32 : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamLinearColor : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamVector : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamVector2D : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


className: UNiagaraRenderableMeshInterface

description: Interface for UObjects to implement renderable mesh.

code: class UNiagaraRenderableMeshInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


code: virtual void CacheFromCompiledData ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledData )


description: Utility function that can be used to fix up old vec3 bindings into position bindings.

code: static void ChangeToPositionBinding ( [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) & Binding )


code: virtual void CollectPSOPrecacheData ( [FPSOPrecacheParamsList](API\Plugins\Niagara\UNiagaraRendererProperties\FPSOPrecacheParamsList) & OutParams )


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, BlueprintType, Blueprintable) class UNiagaraPreviewAxis_InterpParamVector4 : public [UNiagaraPreviewAxis_InterpParamBase](API\Plugins\Niagara\UNiagaraPreviewAxis_InterpParamB-)


code: virtual [FNiagaraBoundsCalculator](API\Plugins\Niagara\FNiagaraBoundsCalculator) * CreateBoundsCalculator()


code: uint32 ComputeMaxUsedComponents ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledDataSetData ) const


code: virtual void FixMaterial ( [UMaterial](API\Runtime\Engine\Materials\UMaterial) * Material )


code: virtual [FNiagaraRenderer](API\Plugins\Niagara\FNiagaraRenderer) * CreateEmitterRenderer ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * Emitter, const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & InController )


code: template<typename TAction> void ForEachPlatformSet ( TAction Func )


className: FPSOPrecacheParams

description: Collect all the data required for PSO precaching

code: struct FPSOPrecacheParams

MaterialInterface

type: UMaterialInterf...

VertexFactoryDataList

type: FPSOPrecacheVer...


className: FPSOPrecacheParamsList

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FPSOPrecacheParams](API\Plugins\Niagara\UNiagaraRendererProperties\FPSOPrecacheParams), TInlineAllocator< 2 > > FPSOPrecacheParamsList


description: Method to add asset tags that are specific to this renderer.Bydefault we add in how many instances of this class exist in the list.

code: virtual void GetAssetTagsForContext ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InAsset, [FGuid](API\Runtime\Core\Misc\FGuid) AssetVersion, const [TArray](API\Runtime\Core\Containers\TArray)< const [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * > & InProperties, [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), uint32 > & NumericKeys, [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > & StringKeys ) const


code: virtual void GetAdditionalVariables ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & OutArray ) const


className: FOnPropertiesChanged

code: typedef TMulticastDelegate_NoParams< void > FOnPropertiesChanged


description: Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties.

code: virtual [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) GetBoundAttribute ( const [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) * Binding ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< const [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) * > & GetAttributeBindings() const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > GetBoundAttributes() const


code: int32 GetDynamicParameterChannelMask ( const [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * EmitterData, [FName](API\Runtime\Core\UObject\FName) BindingName, int32 DefaultChannelMask ) const


code: [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetEmitterData() const


code: virtual bool GetIsEnabled() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetOptionalAttributes()


code: virtual void GetRendererFeedback ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutErrors, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & OutInfo ) const


code: virtual void GetRendererFeedback ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutErrors, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutInfo ) const


code: virtual void GetRendererWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual void GetRendererTooltipWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetRequiredAttributes()


description: The icon to display in the niagara stack widget under the renderer section.

code: virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetStackIcon() const


code: virtual void GetStreamingMeshInfo ( const FBoxSphereBounds & OwnerBounds, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FStreamingRenderAssetPrimitiveInfo](API\Runtime\Engine\Engine\FStreamingRenderAssetPrimitiveIn-) > & OutStreamingRenderAssets ) const


code: virtual const [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetVertexFactoryType() const


description: The text to display in the niagara stack widget under the renderer section.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetWidgetDisplayName() const


code: virtual bool IsBackfaceCullingDisabled() const


code: template<typename TAccessorType> void InitParticleDataSetAccessor ( TAccessorType & Accessor, const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledData, const [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) & Binding )


description: Is the Gpu translucent data going to be this frame, this can be restricted by things like feature level.

code: static bool IsGpuTranslucentThisFrame ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, [ENiagaraRendererGpuTranslucentLatency](API\Plugins\Niagara\ENiagaraRendererGpuTranslucentLa-) Latency )


code: virtual bool IsSimTargetSupported ( [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InSimTarget ) const


code: static bool IsSortHighPrecision ( [ENiagaraRendererSortPrecision](API\Plugins\Niagara\ENiagaraRendererSortPrecision) SortPrecision )


code: virtual void GetUsedMaterials ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & OutMaterials ) const


code: virtual bool IsMaterialValidForRenderer ( [UMaterial](API\Runtime\Engine\Materials\UMaterial) * Material, [FText](API\Runtime\Core\Internationalization\FText) & InvalidMessage )


description:
Called during saving to determine the load flags to save with the object. If false, this object will be discarded on the target platform
true if this object should be loaded on the target platform

code: virtual bool NeedsLoadForTargetPlatform ( const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform ) const


code: virtual bool IsSupportedVariableForBinding ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InSourceForBinding, const [FName](API\Runtime\Core\UObject\FName) & InTargetBindingName ) const


code: bool NeedsPreciseMotionVectors() const


code: virtual bool NeedsMIDsForMaterials() const


description: When true, the renderer will be opted in to get its OnSystemComplete_GameThread overload called

code: virtual bool NeedsSystemCompletion() const


description: When true, the renderer will be opted in to get its PostSystemTick_GameThread overload called

code: virtual bool NeedsSystemPostTick() const


description: In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation.

code: virtual bool PopulateRequiredBindings ( [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & InParameterStore )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


code: virtual void PostLoadBindings ( [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode )


code: virtual void RemoveVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


description: Internal handling of any emitter variable renames. Note that this doesn't modify the renderer, the caller will need to do that if it is desired.

code: virtual void RenameEmitter ( const [FName](API\Runtime\Core\UObject\FName) & InOldName, const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * InRenamedEmitter )


code: virtual void SetIsEnabled ( bool bInIsEnabled )


code: virtual void RenameVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & NewVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


code: [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties) * StaticDuplicateWithNewMergeId ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InOuter ) const


description: Should the Gpu translucent data be this frame or not?

code: static bool ShouldGpuTranslucentThisFrame ( [ENiagaraRendererGpuTranslucentLatency](API\Plugins\Niagara\ENiagaraRendererGpuTranslucentLa-) Latency )


description: Utility function to updates MICs.

code: void UpdateMaterialParametersMIC ( const [FNiagaraRendererMaterialParameters](API\Plugins\Niagara\FNiagaraRendererMaterialParamete-) & MaterialParameters, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > Materials, [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) >> & InOutMICs )


description: Update MIC Static Parameters.

code: bool UpdateMaterialStaticParameters ( const [FNiagaraRendererMaterialParameters](API\Plugins\Niagara\FNiagaraRendererMaterialParamete-) & MaterialParameters, [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) * MIC )


code: virtual void UpdateSourceModeDerivates ( [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode, bool bFromPropertyEdit )


code: virtual bool UseHeterogeneousVolumes() const


description: Utility function to updates MICs.

code: void UpdateMaterialParametersMIC ( const [FNiagaraRendererMaterialParameters](API\Plugins\Niagara\FNiagaraRendererMaterialParamete-) & MaterialParameters, [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) > & InOutMaterial, [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UMaterialInstanceConstant](API\Runtime\Engine\Materials\UMaterialInstanceConstant) > & InOutMIC )


className: UNiagaraRendererProperties

description: Emitter properties base class Each EmitterRenderer derives from this with its own class, and returns it in GetProperties; a copy of those specific properties is stored onUNiagaraEmitter(on the System) for serialization and handed back to the System renderer on load.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, MinimalAPI) class UNiagaraRendererProperties : public [UNiagaraMergeable](API\Plugins\NiagaraCore\UNiagaraMergeable)

AttributeBindings

type: TArray< constF...

bAllowInCullProxies

type: bool

MotionVectorSetting

type: ENiagaraRendere...

description: Hint about how to generate motion (velocity) vectors for this renderer.

OnPropertiesChangedDelegate

type: FOnPropertiesCh...

Platforms

type: FNiagaraPlatfor...

description: Platforms on which this renderer is enabled.

RendererEnabledBinding

type: FNiagaraVariabl...

description: Binding to control if the renderer is enabled or disabled.

SortOrderHint

description: Bydefault, emitters are drawn in the order that they are added to the system.


code: virtual void CacheFromCompiledData ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * CompiledData )


code: virtual [FNiagaraBoundsCalculator](API\Plugins\Niagara\FNiagaraBoundsCalculator) * CreateBoundsCalculator()


code: virtual void CollectPSOPrecacheData ( [FPSOPrecacheParamsList](API\Plugins\Niagara\UNiagaraRendererProperties\FPSOPrecacheParamsList) & OutParams )


code: virtual [FNiagaraRenderer](API\Plugins\Niagara\FNiagaraRenderer) * CreateEmitterRenderer ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * Emitter, const [FNiagaraSystemInstanceController](API\Plugins\Niagara\FNiagaraSystemInstanceController) & InController )


code: virtual void GetAdditionalVariables ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & OutArray ) const


description: Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties.

code: virtual [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) GetBoundAttribute ( const [FNiagaraVariableAttributeBinding](API\Plugins\Niagara\FNiagaraVariableAttributeBinding) * Binding ) const


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > GetBoundAttributes() const


code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetOptionalAttributes()


code: virtual void GetRendererFeedback ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutErrors, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutWarnings, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraRendererFeedback](API\Plugins\Niagara\FNiagaraRendererFeedback) > & OutInfo ) const


code: virtual void GetRendererTooltipWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


code: virtual void GetRendererWidgets ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >> & OutWidgets, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FAssetThumbnailPool](API\Editor\UnrealEd\FAssetThumbnailPool) > InThumbnailPool ) const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


code: virtual void GetUsedMaterials ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter, [TArray](API\Runtime\Core\Containers\TArray)< [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * > & OutMaterials ) const


code: virtual const [FVertexFactoryType](API\Runtime\RenderCore\FVertexFactoryType) * GetVertexFactoryType() const


code: virtual bool IsBackfaceCullingDisabled() const


description: The bindings depend on variables that are created during the NiagaraModule startup. However, the CDO's are build prior to this being initialized, so we defer setting these values until later.


code: virtual bool IsSimTargetSupported ( [ENiagaraSimTarget](API\Plugins\Niagara\ENiagaraSimTarget) InSimTarget ) const


code: virtual bool IsSupportedVariableForBinding ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InSourceForBinding, const [FName](API\Runtime\Core\UObject\FName) & InTargetBindingName ) const


code: virtual bool NeedsMIDsForMaterials() const


code: virtual bool PopulateRequiredBindings ( [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & InParameterStore )


code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: virtual void PostLoad()


code: virtual void PostInitProperties()


code: virtual void RemoveVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


code: virtual void RenameVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & NewVariable, const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FStructuredArchive::FRecord](API\Runtime\Core\Serialization\FStructuredArchive\FRecord) Record )


code: void SetPreviousBindings ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & SrcEmitter )


code: virtual void UpdateSourceModeDerivates ( [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode, bool bFromPropertyEdit )


code: UNiagaraRibbonRendererProperties()


className: UNiagaraRibbonRendererProperties

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Meta=(DisplayName="Ribbon Renderer"), MinimalAPI) class UNiagaraRibbonRendererProperties : public [UNiagaraRendererProperties](API\Plugins\Niagara\UNiagaraRendererProperties)

bEnableAccurateGeometry

type: uint8:  1

description: Disables two-sided forced rendering (Will still respect material settings) MultiPlane will double geometry count to have triangles facing both sides.

bScreenSpaceTessellation

description: If checked, use the ribbon's screen space percentage to adaptively adjust the tessellation factor.

bUseConstantFactor

description: If checked, use the above constant factor.

bUseGPUInit

description: Whether we use the CPU or GPU to generate ribbon geometry for CPU systems.

bUseMaterialBackfaceCulling

description: When enabled the ribbons renderer will not override how backface culling works depending on shape type, but instad use the material culling mode

ColorBinding

description: Which attribute should we use for color when generating ribbons?

CurveTension

type: float

description: Defines the curve tension, or how long the curve's tangents are.

CustomVertices

description: Vertices for a cross section of the ribbon in custom shape mode.

DrawDirection

type: ENiagaraRibbonD...

description: If true, the particles are only sorted when using a translucent material.

description: Which attribute should we use for dynamic material parameters when generating ribbons?

FacingDataSetAccessor

type: FNiagaraDataSet...

FacingMode

type: ENiagaraRibbonF...

MaterialParameters

type: FNiagaraRendere...

description: If this array has entries, we will create a MaterialInstanceDynamic per Emitter instance from Material and set the Material parameters using the Niagara simulation variables listed.

MaterialRandomBinding

description: Which attribute should we use for MaterialRandom when generating ribbons?

MaterialUserParamBinding

type: FNiagaraUserPar...

description: Use theUMaterialInterfacebound to this user variable if it is set to a valid value.

MultiPlaneCount

description: Number of planes in multiplane shape.

NormalizedAgeBinding

description: Which attribute should we use for normalized age when generating ribbons?

PositionBinding

description: Which attribute should we use for position when generating ribbons?

PrevPositionBinding

description: Implicit binding for previous position

PrevRibbonFacingBinding

description: Implicit binding for previous ribbon facing

PrevRibbonTwistBinding

description: Implicit binding for previous ribbon twist

PrevRibbonWidthBinding

description: Implicit binding for previous ribbon width

RibbonFacingBinding

description: Which attribute should we use for ribbon facing when generating ribbons?

RibbonIdBinding

description: Which attribute should we use for ribbon id when generating ribbons?

RibbonLinkOrderBinding

description: Which attribute should we use for RibbonLinkOrder when generating ribbons?

RibbonTwistBinding

description: Which attribute should we use for ribbon twist when generating ribbons?

RibbonUVDistance

description: Which attribute should we use for ribbon distance traveled for use in UV operations when generating ribbons?

RibbonWidthBinding

description: Which attribute should we use for ribbon width when generating ribbons?

Shape

type: ENiagaraRibbonS...

description: Shape of the ribbon, from flat plane, multiplane, 3d tube, and custom shapes.

TessellationAngle

description: Defines the angle in degrees at which tessellation occurs.

TessellationFactor

description: Custom tessellation factor. Ranges from 1 to 16. Greater values increase amount of tessellation.

TessellationMode

type: ENiagaraRibbonT...

description: Defines the tessellation mode allowing custom tessellation parameters or disabling tessellation entirely.

TubeSubdivisions

description: Number of vertices/faces in a tube.

description: Which attribute should we use for UV0 U when generating ribbons?

description: Which attribute should we use for UV1 U when generating ribbons?

type: FNiagaraRibbonU...

description: Which attribute should we use for UV0 V when generating ribbons?

description: Which attribute should we use for UV1 V when generating ribbons?

VelocityBinding

description: Which attribute should we use for velocity when generating ribbons?

WidthSegmentationCount

description: Tessellation factor to apply to the width of the ribbon.


code: void AppendScripts ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) >> & InScripts )


code: void AppendScripts ( [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNiagaraScratchPadContainer](API\Plugins\Niagara\UNiagaraScratchPadContainer) > InScripts )


description: The scripts get added in specific ordering through inheritance. These accessors just allow us to deal with checks for known scripts

code: int32 FindIndexForScript ( [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * InScript ) const


code: [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * FindScriptAtIndex ( int32 Index ) const


code: void SetScripts ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) >> & InScripts )


className: UNiagaraScratchPadContainer

description: Wrapper class for scratch pad scripts in an emitter. This is needed because each emitter version can have it's own copy of a scratch pad with the same name and they can't all be outered to the emitter that way.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UNiagaraScratchPadContainer : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Scripts

type: TArray<TObject...


code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) AddNewVersion ( int32 MajorVersion, int32 MinorVersion )


description: Updates the RI parameter store based on the provided variables (missing entries will be added and stale entries will be removed. Returns true if the parameter store was modified.

code: bool ApplyRapidIterationParameters ( TConstArrayView< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > InParameters, bool bAllowRemoval )


description: Determine if the Script and its source graph are in sync.

code: bool AreScriptAndSourceSynchronized ( const [FGuid](API\Runtime\Core\Misc\FGuid) & VersionGuid ) const


description: Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects

code: virtual void BeginCacheForCookedPlatformData ( const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Helper to convert the struct from its binary data out of the DDC to it's actual in-memory version. Do not call this on anything other than the game thread as it depends on the FObjectAndNameAsStringProxyArchive, which calls FindStaticObject which can fail when used in any other thread!

code: static bool BinaryToExecData ( const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) * Script, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBinaryData, [FNiagaraVMExecutableData](API\Plugins\Niagara\FNiagaraVMExecutableData) & OutExecData )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()