unreal.UpgradeNiagaraScriptResults

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

Bases: Object

Wrapper class for passing results back from the version upgrade python script.

C++ Source:

• Plugin: Niagara

• Module: NiagaraEditor

• File: UpgradeNiagaraScriptResults.h

Editor Properties: (see get_editor_property/set_editor_property)

• cancelled_by_python_error (bool): [Read-Write] Whether the converter process was cancelled due to an unrecoverable error in the python script process.

• new_inputs (Array[NiagaraPythonScriptModuleInput]): [Read-Write]

• old_inputs (Array[NiagaraPythonScriptModuleInput]): [Read-Write]

property cancelled_by_python_error: bool

[Read-Write] Whether the converter process was cancelled due to an unrecoverable error in the python script process.

Type:

(bool)

get_old_input(input_name) → NiagaraPythonScriptModuleInput

Get Old Input

Parameters:

input_name (str) –

Return type:

NiagaraPythonScriptModuleInput

property new_inputs: None

[Read-Write]

Type:

(Array[NiagaraPythonScriptModuleInput])

property old_inputs: None

[Read-Write]

Type:

(Array[NiagaraPythonScriptModuleInput])

reset_to_default(input_name) → None

Reset to Default

Parameters:

input_name (str) –

set_bool_input(input_name, value) → None

Set Bool Input

Parameters:

• input_name (str) –

• value (bool) –

set_color_input(input_name, value) → None

Set Color Input

Parameters:

• input_name (str) –

• value (LinearColor) –

set_enum_input(input_name, value) → None

Set Enum Input

Parameters:

• input_name (str) –

• value (str) –

set_float_input(input_name, value) → None

Set Float Input

Parameters:

• input_name (str) –

• value (float) –

set_int_input(input_name, value) → None

Set Int Input

Parameters:

• input_name (str) –

• value (int32) –

set_linked_input(input_name, value) → None

Set Linked Input

Parameters:

• input_name (str) –

• value (str) –

set_new_input(input_name, value) → None

Set New Input

Parameters:

• input_name (str) –

• value (NiagaraPythonScriptModuleInput) –

set_quat_input(input_name, value) → None

Set Quat Input

Parameters:

• input_name (str) –

• value (Quat) –

set_vec2_input(input_name, value) → None

Set Vec 2Input

Parameters:

• input_name (str) –

• value (Vector2D) –

set_vec3_input(input_name, value) → None

Set Vec 3Input

Parameters:

• input_name (str) –

• value (Vector) –

set_vec4_input(input_name, value) → None

Set Vec 4Input

Parameters:

• input_name (str) –

• value (Vector4) –