unreal.NiagaraFunctionLibrary
¶
-
class
unreal.
NiagaraFunctionLibrary
(outer=None, name='None')¶ Bases:
unreal.BlueprintFunctionLibrary
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.
C++ Source:
Plugin: Niagara
Module: Niagara
File: NiagaraFunctionLibrary.h
-
classmethod
get_niagara_parameter_collection
(world_context_object, collection) → NiagaraParameterCollectionInstance¶ - 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);
- Parameters
world_context_object (Object) –
collection (NiagaraParameterCollection) –
- Returns
- Return type
-
classmethod
override_system_user_variable_skeletal_mesh_component
(niagara_system, override_name, skeletal_mesh_component) → None¶ Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
skeletal_mesh_component (SkeletalMeshComponent) –
-
classmethod
override_system_user_variable_static_mesh
(niagara_system, override_name, static_mesh) → None¶ Override System User Variable Static Mesh
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
static_mesh (StaticMesh) –
-
classmethod
override_system_user_variable_static_mesh_component
(niagara_system, override_name, static_mesh_component) → None¶ Sets a Niagara StaticMesh parameter by name, overriding locally if necessary.
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
static_mesh_component (StaticMeshComponent) –
-
classmethod
set_skeletal_mesh_data_interface_sampling_regions
(niagara_system, override_name, sampling_regions) → None¶ Sets the SamplingRegion to use on the skeletal mesh data interface, this is destructive as it modifies the data interface.
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
-
classmethod
set_texture_object
(niagara_system, override_name, texture) → None¶ Overrides the Texture Object for a Niagara Texture Data Interface User Parameter.
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
texture (Texture) –
-
classmethod
set_volume_texture_object
(niagara_system, override_name, texture) → None¶ Overrides the Volume Texture for a Niagara Volume Texture Data Interface User Parameter.
- Parameters
niagara_system (NiagaraComponent) –
override_name (str) –
texture (VolumeTexture) –
-
classmethod
spawn_system_at_location
(world_context_object, system_template, location, rotation=[0.0, 0.0, 0.0], scale=[1.0, 1.0, 1.0], auto_destroy=True, auto_activate=True, pooling_method=NCPoolMethod.NONE, pre_cull_check=True) → NiagaraComponent¶ Spawns a Niagara System at the specified world location/rotation
- Parameters
world_context_object (Object) –
system_template (NiagaraSystem) –
location (Vector) –
rotation (Rotator) –
scale (Vector) –
auto_destroy (bool) –
auto_activate (bool) –
pooling_method (NCPoolMethod) –
pre_cull_check (bool) –
- Returns
The spawned UNiagaraComponent
- Return type
-
classmethod
spawn_system_attached
(system_template, attach_to_component, attach_point_name, location, rotation, location_type, auto_destroy, auto_activate=True, pooling_method=NCPoolMethod.NONE, pre_cull_check=True) → NiagaraComponent¶ Spawn System Attached
- Parameters
system_template (NiagaraSystem) –
attach_to_component (SceneComponent) –
attach_point_name (Name) –
location (Vector) –
rotation (Rotator) –
location_type (AttachLocation) –
auto_destroy (bool) –
auto_activate (bool) –
pooling_method (NCPoolMethod) –
pre_cull_check (bool) –
- Returns
- Return type