unreal.NiagaraComponent

class unreal.NiagaraComponent(outer=None, name='None')

Bases: unreal.FXSystemComponent

UNiagaraComponent is the primitive component for a Niagara System. see: ANiagaraActor see: UNiagaraSystem

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • affect_distance_field_lighting (bool): [Read-Write] Controls whether the primitive should affect dynamic distance field lighting methods. This flag is only used if CastShadow is true. *

  • affect_dynamic_indirect_lighting (bool): [Read-Write] Controls whether the primitive should inject light into the Light Propagation Volume. This flag is only used if CastShadow is true. *

  • allow_cull_distance_volume (bool): [Read-Write] Whether to accept cull distance volumes to modify cached cull distance.

  • always_create_physics_state (bool): [Read-Write] Indicates if we’d like to create physics state all the time (for collision and simulation). If you set this to false, it still will create physics state if collision or simulation activated. This can help performance if you’d like to avoid overhead of creating physics state when triggers

  • apply_impulse_on_damage (bool): [Read-Write] True for damage to this component to apply physics impulse, false to opt out of these impulses.

  • asset (NiagaraSystem): [Read-Write] Asset

  • asset_user_data (Array(AssetUserData)): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • auto_attach_location_rule (AttachmentRule): [Read-Write] Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_parent (SceneComponent): [Read-Only] Component we automatically attach to when activated, if bAutoManageAttachment is true. If null during registration, we assign the existing AttachParent and defer attachment until we activate. see: bAutoManageAttachment

  • auto_attach_rotation_rule (AttachmentRule): [Read-Write] Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_scale_rule (AttachmentRule): [Read-Write] Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

  • auto_attach_socket_name (Name): [Read-Write] Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

  • auto_attach_weld_simulated_bodies (bool): [Read-Write] Option for how we handle bWeldSimulatedBodies when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

  • auto_manage_attachment (bool): [Read-Write] True if we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed. This overrides any current attachment that may be present at the time of activation (deferring initial attachment until activation, if AutoAttachParent is null). When enabled, detachment occurs regardless of whether AutoAttachParent is assigned, and the relative transform from the time of activation is restored. This also disables attachment on dedicated servers, where we don’t actually activate even if bAutoActivate is true. see: AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType

  • batch_imposters_as_instances (bool): [Read-Write] If true, the proxy generation process will use instancing to render this imposter

  • body_instance (BodyInstance): [Read-Write] Physics scene information for this component, holds a single rigid body with multiple shapes.

  • bounds_scale (float): [Read-Write] Scales the bounds of the object. This is useful when using World Position Offset to animate the vertices of the object outside of its bounds. Warning: Increasing the bounds of an object will reduce performance and shadow quality! Currently only used by StaticMeshComponent and SkeletalMeshComponent.

  • cached_max_draw_distance (float): [Read-Only] The distance to cull this primitive at. A CachedMaxDrawDistance of 0 indicates that the primitive should not be culled by distance.

  • can_character_step_up_on (CanBeCharacterBase): [Read-Write] Determine whether a Character can step up onto this component. This controls whether they can try to step up on it when they bump in to it, not whether they can walk on it after landing on it. see: FWalkableSlopeOverride

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • cast_cinematic_shadow (bool): [Read-Write] Whether this component should cast shadows from lights that have bCastShadowsFromCinematicObjectsOnly enabled. This is useful for characters in a cinematic with special cinematic lights, where the cost of shadowmap rendering of the environment is undesired.

  • cast_contact_shadow (bool): [Read-Write] Whether the object should cast contact shadows. This flag is only used if CastShadow is true.

  • cast_dynamic_shadow (bool): [Read-Write] Controls whether the primitive should cast shadows in the case of non precomputed shadowing. This flag is only used if CastShadow is true. *

  • cast_far_shadow (bool): [Read-Write] When enabled, the component will be rendering into the far shadow cascades (only for directional lights).

  • cast_hidden_shadow (bool): [Read-Write] If true, the primitive will cast shadows even if bHidden is true. Controls whether the primitive should cast shadows when hidden. This flag is only used if CastShadow is true.

  • cast_inset_shadow (bool): [Read-Write] Whether this component should create a per-object shadow that gives higher effective shadow resolution. Useful for cinematic character shadowing. Assumed to be enabled if bSelfShadowOnly is enabled.

  • cast_shadow (bool): [Read-Write] Controls whether the primitive component should cast a shadow or not.

  • cast_shadow_as_two_sided (bool): [Read-Write] Whether this primitive should cast dynamic shadows as if it were a two sided material.

  • cast_static_shadow (bool): [Read-Write] Whether the object should cast a static shadow from shadow casting lights. This flag is only used if CastShadow is true.

  • cast_volumetric_translucent_shadow (bool): [Read-Write] Whether the object should cast a volumetric translucent shadow. Volumetric translucent shadows are useful for primitives with smoothly changing opacity like particles representing a volume, But have artifacts when used on highly opaque surfaces.

  • component_tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • custom_depth_stencil_value (int32): [Read-Write] Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)

  • custom_depth_stencil_write_mask (RendererStencilMask): [Read-Write] Mask used for stencil buffer writes.

  • custom_primitive_data (CustomPrimitiveData): [Read-Write] Optional user defined default values for the custom primitive data of this primitive

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • enable_auto_lod_generation (bool): [Read-Write] If true, and if World setting has bEnableHierarchicalLOD equal to true, then this component will be included when generating a Proxy mesh for the parent Actor

  • enable_gpu_compute_debug (bool): [Read-Write] When true the GPU simulation debug display will enabled, allowing information used during simulation to be visualized.

  • exclude_for_specific_hlod_levels (Array(int32)): [Read-Write] Which specific HLOD levels this component should be excluded from

  • exclude_from_light_attachment_group (bool): [Read-Write] If set, then it overrides any bLightAttachmentsAsGroup set in a parent.

  • fill_collision_underneath_for_navmesh (bool): [Read-Write] If set, navmesh will not be generated under the surface of the geometry

  • force_mip_streaming (bool): [Read-Write] If true, forces mips for textures used by this component to be resident when this component’s level is loaded.

  • force_solo (bool): [Read-Write] When true, this component’s system will be force to update via a slower “solo” path rather than the more optimal batched path with other instances of the same system.

  • generate_overlap_events (bool): [Read-Write] Generate Overlap Events

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • hidden_in_scene_capture (bool): [Read-Write] When true, will not be captured by Scene Capture

  • ignore_radial_force (bool): [Read-Write] Will ignore radial forces applied to this component.

  • ignore_radial_impulse (bool): [Read-Write] Will ignore radial impulses applied to this component.

  • indirect_lighting_cache_quality (IndirectLightingCacheQuality): [Read-Write] Quality of indirect lighting for Movable primitives. This has a large effect on Indirect Lighting Cache update time.

  • instance_parameter_overrides (Map(NiagaraVariableBase, NiagaraVariant)): [Read-Write] Instance Parameter Overrides

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • ld_max_draw_distance (float): [Read-Write] Max draw distance exposed to LDs. The real max draw distance is the min (disregarding 0) of this and volumes affecting this object.

  • light_attachments_as_group (bool): [Read-Write] Whether to light this component and any attachments as a group. This only has effect on the root component of an attachment tree. When enabled, attached component shadowing settings like bCastInsetShadow, bCastVolumetricTranslucentShadow, etc, will be ignored. This is useful for improving performance when multiple movable components are attached together.

  • lighting_channels (LightingChannels): [Read-Write] Channels that this component should be in. Lights with matching channels will affect the component. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing.

  • lightmap_type (LightmapType): [Read-Write] Controls the type of lightmap used for this component.

  • lpv_bias_multiplier (float): [Read-Write] Multiplier used to scale the Light Propagation Volume light injection bias, to reduce light bleeding. Set to 0 for no bias, 1 for default or higher for increased biasing (e.g. for thin geometry such as walls)

  • min_draw_distance (float): [Read-Write] The minimum distance at which the primitive should be rendered, measured in world space units from the center of the primitive’s bounding sphere to the camera position.

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • multi_body_overlap (bool): [Read-Write] If true, this component will generate individual overlaps for each overlapping physics body if it is a multi-body component. When false, this component will generate only one overlap, regardless of how many physics bodies it has and how many of them are overlapping another component/body. This flag has no influence on single body components.

  • never_distance_cull (bool): [Read-Write] When enabled this object will not be culled by distance. This is ignored if a child of a HLOD.

  • on_begin_cursor_over (ComponentBeginCursorOverSignature): [Read-Write] Event called when the mouse cursor is moved over this component and mouse over events are enabled in the player controller

  • on_clicked (ComponentOnClickedSignature): [Read-Write] Event called when the left mouse button is clicked while the mouse is over this component and click events are enabled in the player controller

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_begin_overlap (ComponentBeginOverlapSignature): [Read-Write] Event called when something starts to overlaps this component, for example a player walking into a trigger. For events when objects have a blocking collision, for example a player hitting a wall, see ‘Hit’ events. note: Both this component and the other one must have GetGenerateOverlapEvents() set to true to generate overlap events. note: When receiving an overlap from another object’s movement, the directions of ‘Hit.Normal’ and ‘Hit.ImpactNormal’ will be adjusted to indicate force from the other object against this object.

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • on_component_end_overlap (ComponentEndOverlapSignature): [Read-Write] Event called when something stops overlapping this component note: Both this component and the other one must have GetGenerateOverlapEvents() set to true to generate overlap events.

  • on_component_hit (ComponentHitSignature): [Read-Write] Event called when a component hits (or is hit by) something solid. This could happen due to things like Character movement, using Set Location with ‘sweep’ enabled, or physics simulation. For events when objects overlap (e.g. walking into a trigger) see the ‘Overlap’ event. note: For collisions during physics simulation to generate hit events, ‘Simulation Generates Hit Events’ must be enabled for this component. note: When receiving a hit from another object’s movement, the directions of ‘Hit.Normal’ and ‘Hit.ImpactNormal’ will be adjusted to indicate force from the other object against this object. note: NormalImpulse will be filled in for physics-simulating bodies, but will be zero for swept-component blocking collisions.

  • on_component_sleep (ComponentSleepSignature): [Read-Write] Event called when the underlying physics objects is put to sleep

  • on_component_wake (ComponentWakeSignature): [Read-Write] Event called when the underlying physics objects is woken up

  • on_end_cursor_over (ComponentEndCursorOverSignature): [Read-Write] Event called when the mouse cursor is moved off this component and mouse over events are enabled in the player controller

  • on_input_touch_begin (ComponentOnInputTouchBeginSignature): [Read-Write] Event called when a touch input is received over this component when touch events are enabled in the player controller

  • on_input_touch_end (ComponentOnInputTouchEndSignature): [Read-Write] Event called when a touch input is released over this component when touch events are enabled in the player controller

  • on_input_touch_enter (ComponentBeginTouchOverSignature): [Read-Write] Event called when a finger is moved over this component when touch over events are enabled in the player controller

  • on_input_touch_leave (ComponentEndTouchOverSignature): [Read-Write] Event called when a finger is moved off this component when touch over events are enabled in the player controller

  • on_released (ComponentOnReleasedSignature): [Read-Write] Event called when the left mouse button is released while the mouse is over this component click events are enabled in the player controller

  • on_system_finished (OnNiagaraSystemFinished): [Read-Write] Called when the particle system is done

  • only_owner_see (bool): [Read-Write] If this is True, this component will only be visible when the view actor is the component’s owner, directly or indirectly.

  • owner_no_see (bool): [Read-Write] If this is True, this component won’t be visible when the view actor is the component’s owner, directly or indirectly.

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • random_seed_offset (int32): [Read-Write] Offsets the deterministic random seed of all emitters. Used to achieve variety between components, while still achieving determinism. WARNINGS: - If this value is set in a non-deterministic way, it has the potential to break determinism of the entire system. - This value is applied when emitters are activated/reset, and changing them while the emitter is active has no effect.

  • receive_mobile_csm_shadows (bool): [Read-Write] Mobile only: If disabled this component will not receive CSM shadows. (Components that do not receive CSM may have reduced shading cost)

  • receives_decals (bool): [Read-Write] Whether the primitive receives decals.

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • render_custom_depth (bool): [Read-Write] If true, this component will be rendered in the CustomDepth pass (usually used for outlines)

  • render_in_depth_pass (bool): [Read-Write] If true, this component will be rendered in the depth pass even if it’s not rendered in the main pass

  • render_in_main_pass (bool): [Read-Write] If true, this component will be rendered in the main pass (z prepass, basepass, transparency)

  • replicate_physics_to_autonomous_proxy (bool): [Read-Write] True if physics should be replicated to autonomous proxies. This should be true for

    server-authoritative simulations, and false for client authoritative simulations.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • return_material_on_move (bool): [Read-Write] If true, component sweeps will return the material in their hit result. see: MoveComponent(), FHitResult

  • runtime_virtual_textures (Array(RuntimeVirtualTexture)): [Read-Write] Array of runtime virtual textures into which we draw the mesh for this actor. The material also needs to be set up to output to a virtual texture.

  • self_shadow_only (bool): [Read-Write] When enabled, the component will only cast a shadow on itself and not other components in the world. This is especially useful for first person weapons, and forces bCastInsetShadow to be enabled.

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • single_sample_shadow_from_stationary_lights (bool): [Read-Write] Whether the whole component should be shadowed as one from stationary lights, which makes shadow receiving much cheaper. When enabled shadowing data comes from the volume lighting samples precomputed by Lightmass, which are very sparse. This is currently only used on stationary directional lights.

  • template_parameter_overrides (Map(NiagaraVariableBase, NiagaraVariant)): [Read-Write] Template Parameter Overrides

  • tick_behavior (NiagaraTickBehavior): [Read-Write] Allows you to control how Niagara selects the tick group, changing this while an instance is active will result in not change as it is cached.

  • trace_complex_on_move (bool): [Read-Write] If true, component sweeps with this component should trace against complex collision during movement (for example, each triangle of a mesh). If false, collision will be resolved against simple collision bounds instead. see: MoveComponent()

  • translucency_sort_distance_offset (float): [Read-Write] Modified sort distance offset for translucent objects in world units. A positive number will move the sort distance further and a negative number will move the distance closer.

    Ignored if the object is not translucent. Warning: Adjusting this value will prevent the renderer from correctly sorting based on distance. Only modify this value if you are certain it will not cause visual artifacts.

  • translucency_sort_priority (int32): [Read-Write] Translucent objects with a lower sort priority draw behind objects with a higher priority. Translucent objects with the same priority are rendered from back-to-front based on their bounds origin. This setting is also used to sort objects being drawn into a runtime virtual texture.

    Ignored if the object is not translucent. The default priority is zero. Warning: This should never be set to a non-default value unless you know what you are doing, as it will prevent the renderer from sorting correctly. It is especially problematic on dynamic gameplay effects.

  • treat_as_background_for_occlusion (bool): [Read-Write] Treat this primitive as part of the background for occlusion purposes. This can be used as an optimization to reduce the cost of rendering skyboxes, large ground planes that are part of the vista, etc.

  • use_as_occluder (bool): [Read-Write] Whether to render the primitive in the depth only pass. This should generally be true for all objects, and let the renderer make decisions about whether to render objects in the depth only pass. todo: if any rendering features rely on a complete depth only pass, this variable needs to go away.

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • use_max_lod_as_imposter (bool): [Read-Write] Use the Maximum LOD Mesh (imposter) instead of including Mesh data from this component in the Proxy Generation process

  • virtual_texture_cull_mips (int8): [Read-Write] Number of lower mips in the runtime virtual texture to skip for rendering this primitive. Larger values reduce the effective draw distance in the runtime virtual texture. This culling method doesn’t take into account primitive size or virtual texture size.

  • virtual_texture_lod_bias (int8): [Read-Write] Bias to the LOD selected for rendering to runtime virtual textures.

  • virtual_texture_min_coverage (int8): [Read-Write] Set the minimum pixel coverage before culling from the runtime virtual texture. Larger values reduce the effective draw distance in the runtime virtual texture.

  • virtual_texture_render_pass_type (RuntimeVirtualTextureMainPassType): [Read-Write] Controls if this component draws in the main pass as well as in the virtual texture.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

  • visible_in_ray_tracing (bool): [Read-Write] If true, this component will be visible in ray tracing effects. Turning this off will remove it from ray traced reflections, shadows, etc.

  • visible_in_real_time_sky_captures (bool): [Read-Write] If true, this component will be visible in real-time sky light reflection captures.

  • visible_in_reflection_captures (bool): [Read-Write] If true, this component will be visible in reflection captures.

  • visible_in_scene_capture_only (bool): [Read-Write] When true, will only be visible in Scene Capture

  • wait_for_compilation_on_activate (bool): [Read-Write] Wait for Compilation on Activate

advance_simulation(tick_count, tick_delta_seconds) → None

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

Parameters

  • tick_count (int32) –

  • tick_delta_seconds (float) –

advance_simulation_by_time(simulate_time, tick_delta_seconds) → None

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.

Parameters

  • simulate_time (float) –

  • tick_delta_seconds (float) –

property auto_attach_location_rule

[Read-Write] Options for how we handle our location when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type

(AttachmentRule)

property auto_attach_parent

[Read-Only] Component we automatically attach to when activated, if bAutoManageAttachment is true. If null during registration, we assign the existing AttachParent and defer attachment until we activate. see: bAutoManageAttachment

Type

(SceneComponent)

property auto_attach_rotation_rule

[Read-Write] Options for how we handle our rotation when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type

(AttachmentRule)

property auto_attach_scale_rule

[Read-Write] Options for how we handle our scale when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment, EAttachmentRule

Type

(AttachmentRule)

property auto_attach_socket_name

[Read-Write] Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

Type

(Name)

property auto_attach_weld_simulated_bodies

[Read-Write] Option for how we handle bWeldSimulatedBodies when we attach to the AutoAttachParent, if bAutoManageAttachment is true. see: bAutoManageAttachment

Type

(bool)

property auto_manage_attachment

[Read-Only] True if we should automatically attach to AutoAttachParent when activated, and detach from our parent when completed. This overrides any current attachment that may be present at the time of activation (deferring initial attachment until activation, if AutoAttachParent is null). When enabled, detachment occurs regardless of whether AutoAttachParent is assigned, and the relative transform from the time of activation is restored. This also disables attachment on dedicated servers, where we don’t actually activate even if bAutoActivate is true. see: AutoAttachParent, AutoAttachSocketName, AutoAttachLocationType

Type

(bool)

get_age_update_mode() → NiagaraAgeUpdateMode

Get Age Update Mode

Returns

Return type

NiagaraAgeUpdateMode

get_asset() → NiagaraSystem

Get Asset

Returns

Return type

NiagaraSystem

get_data_interface(name) → NiagaraDataInterface

Get Data Interface

Parameters

name (str) –

Returns

Return type

NiagaraDataInterface

get_desired_age() → float

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

Returns

Return type

float

get_force_solo() → bool

Get Force Solo

Returns

Return type

bool

get_lock_desired_age_delta_time_to_seek_delta() → bool
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.

Returns

Return type

bool

get_max_sim_time() → float
Sets the maximum time that you can jump within a tick which is used when seeking from the current age, to the desired age. This is only relevant

when using the DesiredAge age update mode.

Returns

Return type

float

get_niagara_particle_positions_debug_only(emitter_name)

Debug accessors for getting positions in blueprints. deprecated: Get Niagara Emitter Positions is deprecated, use the particle export DI inside your emitter instead.

Parameters

emitter_name (str) –

Returns

Return type

Array(Vector)

get_niagara_particle_value_vec3_debug_only(emitter_name, value_name)

Debug accessors for getting a FVector attribute array in blueprints. The attribute name should be without namespaces. For example for “Particles.Position”, send “Position”. deprecated: Get Niagara Emitter Vec3 Attrib is deprecated, use the particle export DI inside your emitter instead.

Parameters

  • emitter_name (str) –

  • value_name (str) –

Returns

Return type

Array(Vector)

get_niagara_particle_values_debug_only(emitter_name, value_name)

Debug accessors for getting a float attribute array in blueprints. The attribute name should be without namespaces. For example for “Particles.Position”, send “Position”. deprecated: Get Niagara Emitter Float Attrib is deprecated, use the particle export DI inside your emitter instead.

Parameters

  • emitter_name (str) –

  • value_name (str) –

Returns

Return type

Array(float)

get_preview_lod_distance() → float

Get Preview LODDistance

Returns

Return type

float

get_preview_lod_distance_enabled() → bool

Get Preview LODDistance Enabled

Returns

Return type

bool

get_random_seed_offset() → int32

Get Random Seed Offset

Returns

Return type

int32

get_seek_delta() → float
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.

Returns

Return type

float

get_tick_behavior() → NiagaraTickBehavior

Get Tick Behavior

Returns

Return type

NiagaraTickBehavior

init_for_performance_baseline() → None

Initializes this component for capturing a performance baseline. This will do things such as disabling distance culling and setting a LODDistance of 0 to ensure the effect is at it’s maximum cost.

is_paused() → bool

Is Paused

Returns

Return type

bool

property on_system_finished

[Read-Write] Called when the particle system is done

Type

(OnNiagaraSystemFinished)

reinitialize_system() → None

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

reset_system() → None

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

seek_to_desired_age(desired_age) → None
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.

Parameters

desired_age (float) –

set_age_update_mode(age_update_mode) → None

Sets the age update mode for the System instance.

Parameters

age_update_mode (NiagaraAgeUpdateMode) –

set_allow_scalability(allow) → None

Set whether this component is allowed to perform scalability checks and potentially be culled etc. Occasionally it is useful to disable this for specific components. E.g. Effects on the local player.

Parameters

allow (bool) –

set_asset(asset, reset_existing_override_parameters=True) → None

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.

Parameters
set_auto_destroy(auto_destroy) → None

Set Auto Destroy

Parameters

auto_destroy (bool) –

set_can_render_while_seeking(can_render_while_seeking) → None

Sets whether or not the system can render while seeking.

Parameters

can_render_while_seeking (bool) –

set_desired_age(desired_age) → None

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

Parameters

desired_age (float) –

set_force_solo(force_solo) → None

Set Force Solo

Parameters

force_solo (bool) –

set_gpu_compute_debug(enable_debug) → None

Set Gpu Compute Debug

Parameters

enable_debug (bool) –

set_lock_desired_age_delta_time_to_seek_delta(lock) → None
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.

Parameters

lock (bool) –

set_max_sim_time(max_time) → None
Sets the maximum time that you can jump within a tick which is used when seeking from the current age, to the desired age. This is only relevant

when using the DesiredAge age update mode.

Parameters

max_time (float) –

set_niagara_variable_actor(variable_name, actor) → None

Set Niagara Variable Actor

Parameters

  • variable_name (str) –

  • actor (Actor) –

set_niagara_variable_bool(variable_name, value) → None

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

Parameters

  • variable_name (str) –

  • value (bool) –

set_niagara_variable_float(variable_name, value) → None

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

Parameters

  • variable_name (str) –

  • value (float) –

set_niagara_variable_int(variable_name, value) → None

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

Parameters

  • variable_name (str) –

  • value (int32) –

set_niagara_variable_linear_color(variable_name, value) → None

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

Parameters
set_niagara_variable_object(variable_name, object) → None

Set Niagara Variable Object

Parameters

  • variable_name (str) –

  • object (Object) –

set_niagara_variable_quat(variable_name, value) → None

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

Parameters

  • variable_name (str) –

  • value (Quat) –

set_niagara_variable_vec2(variable_name, value) → None

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

Parameters
set_niagara_variable_vec3(variable_name, value) → None

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

Parameters
set_niagara_variable_vec4(variable_name, value) → None

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

Parameters
set_paused(paused) → None

Set Paused

Parameters

paused (bool) –

set_preview_lod_distance(enable_preview_lod_distance, preview_lod_distance) → None

Set Preview LODDistance

Parameters

  • enable_preview_lod_distance (bool) –

  • preview_lod_distance (float) –

set_random_seed_offset(new_random_seed_offset) → None

Set Random Seed Offset

Parameters

new_random_seed_offset (int32) –

set_rendering_enabled(rendering_enabled) → None

Sets whether or not rendering is enabled for this component.

Parameters

rendering_enabled (bool) –

set_seek_delta(seek_delta) → None
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.

Parameters

seek_delta (float) –

set_tick_behavior(new_tick_behavior) → None

Set Tick Behavior

Parameters

new_tick_behavior (NiagaraTickBehavior) –

set_variable_actor(variable_name, actor) → None

Set Variable Actor

Parameters
set_variable_bool(variable_name, value) → None

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

Parameters

  • variable_name (Name) –

  • value (bool) –

set_variable_float(variable_name, value) → None

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

Parameters
set_variable_int(variable_name, value) → None

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

Parameters

  • variable_name (Name) –

  • value (int32) –

set_variable_linear_color(variable_name, value) → None

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

Parameters
set_variable_material(variable_name, object) → None

Set Variable Material

Parameters
set_variable_object(variable_name, object) → None

Set Variable Object

Parameters
set_variable_quat(variable_name, value) → None

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

Parameters

  • variable_name (Name) –

  • value (Quat) –

set_variable_texture_render_target(variable_name, texture_render_target) → None

Set Variable Texture Render Target

Parameters
set_variable_vec2(variable_name, value) → None

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

Parameters
set_variable_vec3(variable_name, value) → None

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

Parameters
set_variable_vec4(variable_name, value) → None

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

Parameters