unreal.NiagaraSimCacheFunctionLibrary

class unreal.NiagaraSimCacheFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Niagara Sim Cache Function Library

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraSimCacheFunctionLibrary.h

classmethod capture_niagara_sim_cache_immediate(sim_cache, create_parameters, niagara_component, advance_simulation=False, advance_delta_time=0.016660) → NiagaraSimCache or None

Captures the simulations current frame data into the SimCache. This happens immediately so you may need to be careful with tick order of the component you are capturing from. The return can be invalid if the component can not be captured for some reason (i.e. not active). When AdvanceSimulation is true we will manually advance the simulation one frame using the provided AdvanceDeltaTime before capturing.

Parameters:
Returns:

out_sim_cache (NiagaraSimCache):

Return type:

NiagaraSimCache or None

classmethod create_niagara_sim_cache(world_context_object) → NiagaraSimCache

Captures the simulation cache object that can be captured into using the various API calls.

Parameters:

world_context_object (Object) –

Return type:

NiagaraSimCache