Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > INiagaraModule

Light Theme

Dark Theme

INiagaraModule

Niagara module interface

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

INiagaraModule

References

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

Syntax

class INiagaraModule : public IModuleInterface

Remarks

Niagara module interface

Variables

		Name	Description
	FCheckCompilati...	CompilationResultDelegate
	TSharedPtr< INi...	EditorOnlyDataUtilities
	TSharedPtr< INi...	MergeManager
	FOnPrecompile	ObjectPrecompilerDelegate
	FOnProcessQueue	OnProcessQueue
	FScriptCompiler	ScriptCompilerDelegate

Functions

		Name	Description
	TSharedPtr< ...	GetCompileJobResult ( int32 JobID, bool bWait )
	const INiaga...	GetEditorOnlyDataUtilities()
	float	GetGlobalSpawnCountScale()
	float	GetGlobalSystemCountScale()
	const INiaga...	GetMergeManager()
	const FNiaga...	GetVar_BeginDefaults()
	const FNiaga...	GetVar_DataInstance_Alive()
	const FNiaga...	GetVar_Emitter_Age()
	const FNiaga...	GetVar_Emitter_Determinism()
	const FNiaga...	GetVar_Emitter_InterpSpawnStartDt()
	const FNiaga...	GetVar_Emitter_LocalSpace()
	const FNiaga...	GetVar_Emitter_OverrideGlobalSpawnCountScale()
	const FNiaga...	GetVar_Emitter_RandomSeed()
	const FNiaga...	GetVar_Emitter_SimulationTarget()
	const FNiaga...	GetVar_Emitter_SpawnGroup()
	const FNiaga...	GetVar_Emitter_SpawnInterval()
	const FNiaga...	GetVar_Emitter_SpawnRate()
	const FNiaga...	GetVar_Engine_DeltaTime()
	const FNiaga...	GetVar_Engine_Emitter_NumParticles()
	const FNiaga...	GetVar_Engine_Emitter_SpawnCountScale()
	const FNiaga...	GetVar_Engine_Emitter_TotalSpawnedParticles()
	const FNiaga...	GetVar_Engine_ExecutionCount()
	const FNiaga...	GetVar_Engine_GlobalSpawnCountScale()
	const FNiaga...	GetVar_Engine_GlobalSystemScale()
	const FNiaga...	GetVar_Engine_InvDeltaTime()
	const FNiaga...	GetVar_Engine_NumSystemInstances()
	const FNiaga...	GetVar_Engine_Owner_ExecutionState()
	const FNiaga...	GetVar_Engine_Owner_LODDistance()
	const FNiaga...	GetVar_Engine_Owner_LODDistanceFraction()
	const FNiaga...	GetVar_Engine_Owner_Position()
	const FNiaga...	GetVar_Engine_Owner_Rotation()
	const FNiaga...	GetVar_Engine_Owner_Scale()
	const FNiaga...	GetVar_Engine_Owner_SystemLocalToWorld()
	const FNiaga...	GetVar_Engine_Owner_SystemLocalToWorldNoScale()
	const FNiaga...	GetVar_Engine_Owner_SystemLocalToWorldTransposed()
	const FNiaga...	GetVar_Engine_Owner_SystemWorldToLocal()
	const FNiaga...	GetVar_Engine_Owner_SystemWorldToLocalNoScale()
	const FNiaga...	GetVar_Engine_Owner_SystemWorldToLocalTransposed()
	const FNiaga...	GetVar_Engine_Owner_TimeSinceRendered()
	const FNiaga...	GetVar_Engine_Owner_Velocity()
	const FNiaga...	GetVar_Engine_Owner_XAxis()
	const FNiaga...	GetVar_Engine_Owner_YAxis()
	const FNiaga...	GetVar_Engine_Owner_ZAxis()
	const FNiaga...	GetVar_Engine_RealTime()
	const FNiaga...	GetVar_Engine_System_Age()
	const FNiaga...	GetVar_Engine_System_NumEmitters()
	const FNiaga...	GetVar_Engine_System_NumEmittersAlive()
	const FNiaga...	GetVar_Engine_System_TickCount()
	const FNiaga...	GetVar_Engine_Time()
	const FNiaga...	GetVar_Particles_CameraOffset()
	const FNiaga...	GetVar_Particles_Color()
	const FNiaga...	GetVar_Particles_DynamicMaterialParameter()
	const FNiaga...	GetVar_Particles_DynamicMaterialParameter1()
	const FNiaga...	GetVar_Particles_DynamicMaterialParameter2()
	const FNiaga...	GetVar_Particles_DynamicMaterialParameter3()
	const FNiaga...	GetVar_Particles_ID()
	const FNiaga...	GetVar_Particles_Lifetime()
	const FNiaga...	GetVar_Particles_LightEnabled()
	const FNiaga...	GetVar_Particles_LightExponent()
	const FNiaga...	GetVar_Particles_LightRadius()
	const FNiaga...	GetVar_Particles_LightVolumetricScattering()
	const FNiaga...	GetVar_Particles_MaterialRandom()
	const FNiaga...	GetVar_Particles_MeshOrientation()
	const FNiaga...	GetVar_Particles_NormalizedAge()
	const FNiaga...	GetVar_Particles_Position()
	const FNiaga...	GetVar_Particles_RibbonFacing()
	const FNiaga...	GetVar_Particles_RibbonID()
	const FNiaga...	GetVar_Particles_RibbonLinkOrder()
	const FNiaga...	GetVar_Particles_RibbonTwist()
	const FNiaga...	GetVar_Particles_RibbonWidth()
	const FNiaga...	GetVar_Particles_Scale()
	const FNiaga...	GetVar_Particles_SpriteAlignment()
	const FNiaga...	GetVar_Particles_SpriteFacing()
	const FNiaga...	GetVar_Particles_SpriteRotation()
	const FNiaga...	GetVar_Particles_SpriteSize()
	const FNiaga...	GetVar_Particles_SubImageIndex()
	const FNiaga...	GetVar_Particles_UniqueID()
	const FNiaga...	GetVar_Particles_UVScale()
	const FNiaga...	GetVar_Particles_Velocity()
	const FNiaga...	GetVar_ScriptUsage()
	TSharedPtr< ...	Precompile ( UObject* InObj )
	void	ProcessShaderCompilationQueue()
	FDelegateHan...	RegisterCompileResultDelegate ( FCheckCompilationResult ResultDeleg... )
	void	RegisterEditorOnlyDataUtilities ( TSharedRef< INiagaraEditorOnlyDataU... )
	void	RegisterMergeManager ( TSharedRef< INiagaraMergeManager > ... )
	FDelegateHan...	RegisterPrecompiler ( FOnPrecompile PreCompiler )
	FDelegateHan...	RegisterScriptCompiler ( FScriptCompiler ScriptCompiler )
	void	ResetOnProcessShaderCompilationQueue ( FDelegateHandle DelegateHandle )
	FDelegateHan...	SetOnProcessShaderCompilationQueue ( FOnProcessQueue InOnProcessQueue )
	void	ShutdownRenderingResources()
	int32	StartScriptCompileJob ( const FNiagaraCompileRequestDataBas..., const FNiagaraCompileOptions& InCo... )
	void	UnregisterCompileResultDelegate ( FDelegateHandle DelegateHandle )
	void	UnregisterEditorOnlyDataUtilities ( TSharedRef< INiagaraEditorOnlyDataU... )
	void	UnregisterMergeManager ( TSharedRef< INiagaraMergeManager > ... )
	void	UnregisterPrecompiler ( FDelegateHandle DelegateHandle )
	void	UnregisterScriptCompiler ( FDelegateHandle DelegateHandle )

Overridden from IModuleInterface

		Name	Description
	void	ShutdownModule()	Called before the module is unloaded, right before the module object is destroyed.
	void	StartupModule()	Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Typedefs

Name	Description
CompileRequestPtr
FCheckCompilationResult
FOnPrecompile
FOnProcessQueue
FScriptCompiler

Constants

Name	Description
DataInstance_Alive
Emitter_Age
Emitter_Determinism
Emitter_InterpSpawnStartDt
Emitter_LocalSpace
Emitter_OverrideGlobalSpawnCountScale
Emitter_RandomSeed
Emitter_SimulationTarget
Emitter_SpawnGroup
Emitter_SpawnInterval
Emitter_SpawnRate
Engine_DeltaTime
Engine_Emitter_NumParticles
Engine_Emitter_SpawnCountScale
Engine_Emitter_TotalSpawnedParticles
Engine_ExecutionCount
Engine_GlobalSpawnCountScale
Engine_GlobalSystemScale
Engine_InvDeltaTime
Engine_NumSystemInstances
Engine_Owner_ExecutionState
Engine_Owner_LODDistance
Engine_Owner_LODDistanceFraction
Engine_Owner_Position
Engine_Owner_Rotation
Engine_Owner_Scale
Engine_Owner_SystemLocalToWorld
Engine_Owner_SystemLocalToWorldNoScale
Engine_Owner_SystemLocalToWorldTransposed
Engine_Owner_SystemWorldToLocal
Engine_Owner_SystemWorldToLocalNoScale
Engine_Owner_SystemWorldToLocalTransposed
Engine_Owner_TimeSinceRendered
Engine_Owner_Velocity
Engine_Owner_XAxis
Engine_Owner_YAxis
Engine_Owner_ZAxis
Engine_RealTime
Engine_System_Age
Engine_System_NumEmitters
Engine_System_NumEmittersAlive
Engine_System_TickCount
Engine_Time
EngineEffectsQuality
EngineGlobalSpawnCountScale
EngineGlobalSystemCountScale
Particles_CameraOffset
Particles_Color
Particles_DynamicMaterialParameter
Particles_DynamicMaterialParameter1
Particles_DynamicMaterialParameter2
Particles_DynamicMaterialParameter3
Particles_ID
Particles_Lifetime
Particles_LightEnabled
Particles_LightExponent
Particles_LightRadius
Particles_LightVolumetricScattering
Particles_MaterialRandom
Particles_MeshOrientation
Particles_NormalizedAge
Particles_Position
Particles_RibbonFacing
Particles_RibbonID
Particles_RibbonLinkOrder
Particles_RibbonTwist
Particles_RibbonWidth
Particles_Scale
Particles_SpriteAlignment
Particles_SpriteFacing
Particles_SpriteRotation
Particles_SpriteSize
Particles_SubImageIndex
Particles_UniqueID
Particles_UVScale
Particles_Velocity
ScriptUsage
Translator_BeginDefaults

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

Take our survey

Dismiss