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
script_name_string (str) –
script_conversion_context (NiagaraScriptConversionContext) –
event_script_props (NiagaraEventHandlerAddAction) –
-
add_module_script
(script_name_string, script_conversion_context, module_script_execution_category) → None¶ Add Module Script
- Parameters
script_name_string (str) –
script_conversion_context (NiagaraScriptConversionContext) –
module_script_execution_category (ScriptExecutionCategory) –
-
add_renderer
(renderer_name_string, new_renderer_properties) → None¶ Add a renderer to this emitter conversion context through renderer properties.
- Parameters
renderer_name_string (str) –
new_renderer_properties (NiagaraRendererProperties) –
-
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
-
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
script_name_string (str) –
niagara_script_asset_data (AssetData) –
event_script_props (NiagaraEventHandlerAddAction) –
- Returns
- Return type
-
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
script_name_string (str) –
niagara_script_asset_data (AssetData) –
module_script_execution_category (ScriptExecutionCategory) –
- Returns
- Return type
-
find_renderer
(renderer_name_string) → NiagaraRendererProperties¶ Find an added renderer properties by name string.
- Parameters
renderer_name_string (str) –
- Returns
- Return type
-
get_all_renderers
()¶ Get All Renderers
- Returns
- Return type
-
get_emitter
() → NiagaraEmitter¶ Get Emitter
- Returns
- Return type
-
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.
-
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
parameter_name_string (str) –
parameter_input (NiagaraScriptConversionContextInput) –
set_parameter_execution_category (ScriptExecutionCategory) –
-
set_renderer_binding
(renderer_properties, binding_name, variable_to_bind_name, source_data_mode) → None¶ Set Renderer Binding
- Parameters
renderer_properties (NiagaraRendererProperties) –
binding_name (Name) –
variable_to_bind_name (Name) –
source_data_mode (NiagaraRendererSourceDataMode) –