Niagara

Niagara

Choose your operating system:

Windows

macOS

Linux

On this page

Actions

Acquire Niagara GPURay Traced Collision Group

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

Target is Niagara Function Library

Advance Simulation

Advances this system's simulation by the specified number of ticks and delta time.

Target is Niagara Particle System Component

Advance Simulation by Time

Advances this system's simulation by the specified time in seconds and delta time. Advancement is done in whole ticks of TickDeltaSeconds so actual simulated time will be the nearest lower multiple of TickDeltaSeconds.

Target is Niagara Particle System Component

Clear Emitter Fixed Bounds

Clear any previously set fixed bounds for the emitter instance.

Target is Niagara Particle System Component

Clear System Fixed Bounds

Clear any previously set fixed bounds for the system instance.

Target is Niagara Particle System Component

Get Age Update Mode

Get Age Update Mode

Target is Niagara Particle System Component

Get Bool Parameter

Accessors from Blueprint. For now just exposing common types but ideally we can expose any somehow in future.

Target is Niagara Parameter Collection Instance

Get Color Parameter

Get Color Parameter

Target is Niagara Parameter Collection Instance

Get Custom Time Dilation

Get Custom Time Dilation

Target is Niagara Particle System Component

Get Data Interface

Get Data Interface

Target is Niagara Particle System Component

Get Desired Age

Gets the desired age of the System instance. This is only relevant when using the DesiredAge age update mode.

Target is Niagara Particle System Component

Get Desired Age Seek Delta

Gets the delta value which is used when seeking from the current age, to the desired age. This is only relevant when using the DesiredAge age update mode.

Target is Niagara Particle System Component

Get Emitter Fixed Bounds

Gets the fixed bounds for an emitter instance. This will return the user set fixed bounds if set, or the emitters fixed bounds if set. Note: The returned box may be invalid if no fixed bounds exist

Target is Niagara Particle System Component

Get Float Parameter

Get Float Parameter

Target is Niagara Parameter Collection Instance

Get Int Parameter

Get Int Parameter

Target is Niagara Parameter Collection Instance

Get Max Desired Age Tick Delta

Get the maximum CPU time in seconds we will simulate to the desired age, when we go beyond this limit ticks will be processed in the next frame. This is only relevant when using the DesiredAge age update mode. Note: The componet will not be visibile if we have ticks to process and SetCanRenderWhileSeeking is set to true

Target is Niagara Particle System Component

Get Niagara Parameter Collection

This is gonna be totally reworked UFUNCTION(BlueprintCallable, Category = Niagara, meta = (Keywords = "niagara System", UnsafeDuringActorConstruction = "true")) static void SetUpdateScriptConstant(UNiagaraComponent* Component, FName EmitterName, FName ConstantName, FVector Value);

Target is Niagara Function Library

Get Niagara System Asset

Get Asset

Target is Niagara Particle System Component

Get Quaternion Parameter

Get Quat Parameter

Target is Niagara Parameter Collection Instance

Get Random Seed Offset

Get Random Seed Offset

Target is Niagara Particle System Component

Get Raw Texture Size

Get Raw Texture Size

Target is Grid3D Collection

Get System Fixed Bounds

Gets the fixed bounds for the system instance. This will return the user set fixed bounds if set, or the systems fixed bounds if set. Note: The returned box may be invalid if no fixed bounds exist

Target is Niagara Particle System Component

Get Texture Size

Get Texture Size

Target is Grid3D Collection

Get Tick Behavior

Get Tick Behavior

Target is Niagara Particle System Component

Get Vector Parameter

Get Vector Parameter

Target is Niagara Parameter Collection Instance

Get Vector2D Parameter

Get Vector 2DParameter

Target is Niagara Parameter Collection Instance

Get Vector4 Parameter

Get Vector 4Parameter

Target is Niagara Parameter Collection Instance

Get whether or not to lock the desired age delta time to the seek delta.

Gets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta. When true, the system instance will only be ticked when the desired age has changed by more than the seek delta. When false the system instance will be ticked by the change in desired age when not seeking.

Target is Niagara Particle System Component

Is In Forced Solo Mode

Get Force Solo

Target is Niagara Particle System Component

Is Paused

Is Paused

Target is Niagara Particle System Component

Niagara Get Bool Array

Gets a copy of Niagara Bool Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Bool Array Value

Gets a single value within a Niagara Array Bool.

Target is Niagara Data Interface Array Function Library

Niagara Get Color Array

Gets a copy of Niagara FLinearColor Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Color Array Value

Gets a single value within a Niagara Array FLinearColor.

Target is Niagara Data Interface Array Function Library

Niagara Get Float Array

Gets a copy of Niagara Float Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Float Array Value

Gets a single value within a Niagara Array Float.

Target is Niagara Data Interface Array Function Library

Niagara Get Int32 Array

Gets a copy of Niagara Int32 Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Int32 Array Value

Gets a single value within a Niagara Array Int32.

Target is Niagara Data Interface Array Function Library

Niagara Get Position Array

Gets a copy of Niagara Position Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Position Array Value

Gets a single value within a Niagara Array Position.

Target is Niagara Data Interface Array Function Library

Niagara Get Quaternion Array

Gets a copy of Niagara FQuat Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Quaternion Array Value

Gets a single value within a Niagara Array FQuat.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector 2D Array

Gets a copy of Niagara FVector2D Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector 2D Array Value

Gets a single value within a Niagara Array FVector2D.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector 4 Array

Gets a copy of Niagara FVector4 Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector 4 Array Value

Gets a single value within a Niagara Array FVector4.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector Array

Gets a copy of Niagara FVector Data.

Target is Niagara Data Interface Array Function Library

Niagara Get Vector Array Value

Gets a single value within a Niagara Array FVector.

Target is Niagara Data Interface Array Function Library

Niagara Set Bool Array

Sets Niagara Array Bool Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Bool Array Value

Sets a single value within a Niagara Array Bool.

Target is Niagara Data Interface Array Function Library

Niagara Set Color Array

Sets Niagara Array FLinearColor Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Color Array Value

Sets a single value within a Niagara Array FLinearColor.

Target is Niagara Data Interface Array Function Library

Niagara Set Float Array

Sets Niagara Array Float Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Float Array Value

Sets a single value within a Niagara Array Float.

Target is Niagara Data Interface Array Function Library

Niagara Set Int32 Array

Sets Niagara Array Int32 Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Int32 Array Value

Sets a single value within a Niagara Array Int32.

Target is Niagara Data Interface Array Function Library

Niagara Set Position Array

Sets Niagara Array FVector Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Position Array Value

Set Niagara Array Position Value

Target is Niagara Data Interface Array Function Library

Niagara Set Quaternion Array

Sets Niagara Array FQuat Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Quaternion Array Value

Sets a single value within a Niagara Array FQuat.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector 2D Array

Sets Niagara Array FVector2D Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector 2D Array Value

Sets a single value within a Niagara Array FVector2D.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector 4 Array

Sets Niagara Array FVector4 Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector 4 Array Value

Sets a single value within a Niagara Array FVector4.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector Array

Sets Niagara Array FVector Data.

Target is Niagara Data Interface Array Function Library

Niagara Set Vector Array Value

Sets a single value within a Niagara Array FVector.

Target is Niagara Data Interface Array Function Library

Receive Particle Data

This function is called once per tick with the gathered particle data. It will not be called if there is no particle data to call it with.

Target is Niagara Particle Callback Handler

Receive Particle Data (Message)

This function is called once per tick with the gathered particle data. It will not be called if there is no particle data to call it with.

Target is Niagara Particle Callback Handler

Reinitialize System

Called on when an external object wishes to force this System to reinitialize itself from the System data.

Target is Niagara Particle System Component

Release Niagara GPURay Traced Collision Group

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

Target is Niagara Function Library

Reset System

Resets the System to it's initial pre-simulated state.

Target is Niagara Particle System Component

Seek to Desired Age

Sets the desired age of the System instance and designates that this change is a seek. When seeking to a desired age the The component can optionally prevent rendering.

Target is Niagara Particle System Component

Set Actor Niagara GPURay Traced Collision Group

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

Target is Niagara Function Library

Set Age Update Mode

Sets the age update mode for the System instance.

Target is Niagara Particle System Component

Set Auto Destroy

Set Auto Destroy

Target is Niagara Particle System Component

Set Bool Parameter

Set Bool Parameter

Target is Niagara Parameter Collection Instance

Set Can Render While Seeking

Sets whether or not the system can render while seeking.

Target is Niagara Particle System Component

Set Color Parameter

Set Color Parameter

Target is Niagara Parameter Collection Instance

Set Component Niagara GPURay Traced Collision Group

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

Target is Niagara Function Library

Set Custom Time Dilation

Sets the custom time dilation value for the component. Note: This is only available on components that are in solo mode currently.

Target is Niagara Particle System Component

Set Desired Age

Sets the desired age of the System instance. This is only relevant when using the DesiredAge age update mode.

Target is Niagara Particle System Component

Set Desired Age Seek Delta

Sets the delta value which is used when seeking from the current age, to the desired age. This is only relevant when using the DesiredAge age update mode.

Target is Niagara Particle System Component

Set Emitter Fixed Bounds

Sets the fixed bounds for an emitter instance, this overrides all other bounds. The box is expected to be in local space not world space. A default uninitialized box will clear the fixed bounds and revert back to emitter fixed / dynamic bounds.

Target is Niagara Particle System Component

Set Float Parameter

Set Float Parameter

Target is Niagara Parameter Collection Instance

Set Forced Solo Mode

Set Force Solo

Target is Niagara Particle System Component

Set Gpu Compute Debug

Set Gpu Compute Debug

Target is Niagara Particle System Component

Set Int Parameter

Set Int Parameter

Target is Niagara Parameter Collection Instance

Set Max Desired Age Tick Delta

Sets the maximum CPU time in seconds we will simulate to the desired age, when we go beyond this limit ticks will be processed in the next frame. This is only relevant when using the DesiredAge age update mode. Note: The componet will not be visibile if we have ticks to process and SetCanRenderWhileSeeking is set to true

Target is Niagara Particle System Component

Set Niagara Skeletal Mesh Component

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

Target is Niagara Function Library

Set Niagara Static Mesh Component

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

Target is Niagara Function Library

Set Niagara Static Mesh Directly

Override System User Variable Static Mesh

Target is Niagara Function Library

Set Niagara System Asset

Switch which asset the component is using. This requires Niagara to wait for concurrent execution and the override parameter store to be synchronized with the new asset. By default existing parameters are reset when we call SetAsset, modify bResetExistingOverrideParameters to leave existing parameter data as is.

Target is Niagara Particle System Component

Set Niagara Variable (Actor)

Set Variable Actor

Target is Niagara Particle System Component

Set Niagara Variable (Bool)

Sets a Niagara float parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Float)

Sets a Niagara float parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Int32)

Sets a Niagara int parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (LinearColor)

Sets a Niagara FLinearColor parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Material)

Set Variable Material

Target is Niagara Particle System Component

Set Niagara Variable (Object)

Set Variable Object

Target is Niagara Particle System Component

Set Niagara Variable (Position)

Sets a Niagara Position parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Quaternion)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Static Mesh)

Set Variable Static Mesh

Target is Niagara Particle System Component

Set Niagara Variable (Texture)

Set Variable Texture

Target is Niagara Particle System Component

Set Niagara Variable (TextureRenderTarget)

Set Variable Texture Render Target

Target is Niagara Particle System Component

Set Niagara Variable (Vector2)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Vector3)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable (Vector4)

Sets a Niagara Vector4 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Actor)

Set Niagara Variable Actor

Target is Niagara Particle System Component

Set Niagara Variable By String (Bool)

Sets a Niagara float parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Float)

Sets a Niagara float parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Int32)

Sets a Niagara int parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (LinearColor)

Sets a Niagara FLinearColor parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Object)

Set Niagara Variable Object

Target is Niagara Particle System Component

Set Niagara Variable By String (Position)

Sets a Niagara Position parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Quaternion)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Vector2)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Vector3)

Sets a Niagara Vector3 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Niagara Variable By String (Vector4)

Sets a Niagara Vector4 parameter by name, overriding locally if necessary.

Target is Niagara Particle System Component

Set Paused

Set Paused

Target is Niagara Particle System Component

Set Quaternion Parameter

Set Quat Parameter

Target is Niagara Parameter Collection Instance

Set Random Seed Offset

Set Random Seed Offset

Target is Niagara Particle System Component

Set Rendering Enabled

Sets whether or not rendering is enabled for this component.

Target is Niagara Particle System Component

Set Skeletal Mesh Data Interface Sampling Regions

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

Target is Niagara Function Library

Set System Fixed Bounds

Sets the fixed bounds for the system instance, this overrides all other bounds. The box is expected to be in local space not world space. A default uninitialized box will clear the fixed bounds and revert back to system fixed / dynamic bounds.

Target is Niagara Particle System Component

Set Texture 2DArray Object

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

Target is Niagara Function Library

Set Texture Object

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

Target is Niagara Function Library

Set Tick Behavior

Set Tick Behavior

Target is Niagara Particle System Component

Set UObject Reader Property Remap

Remaps a property reader, where the

Target is Object Reader

Set Vector Parameter

Set Vector Parameter

Target is Niagara Parameter Collection Instance

Set Vector2D Parameter

Set Vector 2DParameter

Target is Niagara Parameter Collection Instance

Set Vector4 Parameter

TODO[mg]: add position setter for LWC

Target is Niagara Parameter Collection Instance

Set Volume Texture Object

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

Target is Niagara Function Library

Set whether or not to lock the desired age delta time to the seek delta.

Sets whether or not the delta time used to tick the system instance when using desired age is locked to the seek delta. When true, the system instance will only be ticked when the desired age has changed by more than the seek delta. When false the system instance will be ticked by the change in desired age when not seeking.

Target is Niagara Particle System Component

Spawn System at Location

Spawns a Niagara System at the specified world location/rotation

Target is Niagara Function Library

Spawn System at Location with Params

Spawn System at Location with Params

Target is Niagara Function Library

Spawn System Attached

Spawn System Attached

Target is Niagara Function Library

Spawn System Attached with Params

Spawn System Attached with Params

Target is Niagara Function Library

Categories

Preview

Preview