unreal.NiagaraEmitterConversionContext

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

Bases: unreal.Object

Wrapper for modifying a UNiagaraEmitter by adding Scripts and Renderers through UNiagaraScriptConversionContexts and UNiagaraRendererProperties, respectively.

C++ Source:

  • Plugin: CascadeToNiagaraConverter

  • Module: CascadeToNiagaraConverter

  • File: NiagaraStackGraphUtilitiesAdapterLibrary.h

add_event_handler(event_script_properties_bp)None

Add Event Handler

Parameters

event_script_properties_bp (NiagaraEventHandlerAddAction) –

add_module_event_script(script_name_string, script_conversion_context, event_script_props)None

Add Module Event Script

Parameters
add_module_script(script_name_string, script_conversion_context, module_script_execution_category)None

Add Module Script

Parameters
add_renderer(renderer_name_string, new_renderer_properties)None

Add a renderer to this emitter conversion context through renderer properties.

Parameters
cleanup()None

Cleanup

finalize()None

Apply all pending UNiagaraScriptConversionContexts and UNiagaraRendererProperties to this UNiagaraEmitterContext by creating clipboard inputs and pasting them onto the emitter conversion context’s Emitter.

find_module_script(script_name_string)NiagaraScriptConversionContext

Find Module Script

Parameters

script_name_string (str) –

Returns

Return type

NiagaraScriptConversionContext

find_or_add_module_event_script(script_name_string, niagara_script_asset_data, event_script_props)NiagaraScriptConversionContext

Find a module script conversion context or add a module script conversion context to this emitter conversion context for an event category. If a script conversion context is not found by name string then a new one is created and initialized from the NiagaraScriptAssetData.

Parameters
Returns

Return type

NiagaraScriptConversionContext

find_or_add_module_script(script_name_string, niagara_script_asset_data, module_script_execution_category)NiagaraScriptConversionContext

Find or add a script conversion context to this emitter conversion context. If a script conversion context is not found by name string then a new one is created and initialized from the NiagaraScriptAssetData.

Parameters
Returns

Return type

NiagaraScriptConversionContext

find_renderer(renderer_name_string)NiagaraRendererProperties

Find an added renderer properties by name string.

Parameters

renderer_name_string (str) –

Returns

Return type

NiagaraRendererProperties

get_all_renderers()

Get All Renderers

Returns

Return type

Array(NiagaraRendererProperties)

get_emitter()NiagaraEmitter

Get Emitter

Returns

Return type

NiagaraEmitter

get_enabled()bool

Get Enabled

Returns

Return type

bool

log(message, severity, is_verbose=False)None

Log a message to the niagara message log for the emitter.

Parameters
  • message (str) – The message string to display.

  • severity (NiagaraMessageSeverity) – The severity of the message.

  • is_verbose (bool) – Whether the message is verbose and should be displayed conditionally.

remove_module_scripts_for_assets(scripts_to_remove)None

Remove Module Scripts for Assets

Parameters

scripts_to_remove (Array(AssetData)) –

set_enabled(enabled)None

Set Enabled

Parameters

enabled (bool) –

set_parameter_directly(parameter_name_string, parameter_input, set_parameter_execution_category)None

Add a set parameter module to the emitter handled by this emitter conversion context.

Parameters
set_renderer_binding(renderer_properties, binding_name, variable_to_bind_name, source_data_mode)None

Set Renderer Binding

Parameters