unreal.NiagaraClipboardEditorScriptingUtilities

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

Bases: Object

Niagara Clipboard Editor Scripting Utilities

C++ Source:

• Plugin: Niagara

• Module: NiagaraEditor

• File: NiagaraClipboard.h

classmethod create_bool_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, bool_value) → NiagaraClipboardFunctionInput

Create Bool Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• bool_value (bool)

Return type:

NiagaraClipboardFunctionInput

classmethod create_color_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, color_value) → NiagaraClipboardFunctionInput

Create Color Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• color_value (LinearColor)

Return type:

NiagaraClipboardFunctionInput

classmethod create_data_value_input(outer, input_name, has_edit_condition, edit_condition_value, data_value) → NiagaraClipboardFunctionInput

Create Data Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• data_value (NiagaraDataInterface)

Return type:

NiagaraClipboardFunctionInput

classmethod create_dynamic_value_input(outer, input_name, input_type_name, has_edit_condition, edit_condition_value, dynamic_value_name, dynamic_value) → NiagaraClipboardFunctionInput

Create Dynamic Value Input

Parameters:

• outer (Object)

• input_name (Name)

• input_type_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• dynamic_value_name (str)

• dynamic_value (NiagaraScript)

Return type:

NiagaraClipboardFunctionInput

classmethod create_enum_linked_value_input(outer, input_name, has_edit_condition, edit_codition_value, enum_type, linked_value) → NiagaraClipboardFunctionInput

Create Enum Linked Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_codition_value (bool)

• enum_type (UserDefinedEnum)

• linked_value (Name)

Return type:

NiagaraClipboardFunctionInput

classmethod create_enum_local_value_input(outer, input_name, has_edit_condition, edit_codition_value, enum_type, enum_value) → NiagaraClipboardFunctionInput

Create Enum Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_codition_value (bool)

• enum_type (UserDefinedEnum)

• enum_value (int32)

Return type:

NiagaraClipboardFunctionInput

classmethod create_expression_value_input(outer, input_name, input_type_name, has_edit_condition, edit_condition_value, expression_value) → NiagaraClipboardFunctionInput

Create Expression Value Input

Parameters:

• outer (Object)

• input_name (Name)

• input_type_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• expression_value (str)

Return type:

NiagaraClipboardFunctionInput

classmethod create_float_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, local_value) → NiagaraClipboardFunctionInput

Create Float Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• local_value (float)

Return type:

NiagaraClipboardFunctionInput

classmethod create_int_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, local_value) → NiagaraClipboardFunctionInput

Create Int Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• local_value (int32)

Return type:

NiagaraClipboardFunctionInput

classmethod create_linked_value_input(outer, input_name, input_type_name, has_edit_condition, edit_condition_value, linked_value) → NiagaraClipboardFunctionInput

Create Linked Value Input

Parameters:

• outer (Object)

• input_name (Name)

• input_type_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• linked_value (Name)

Return type:

NiagaraClipboardFunctionInput

classmethod create_matrix_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, matrix_value) → NiagaraClipboardFunctionInput

Create Matrix Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• matrix_value (Matrix44f)

Return type:

NiagaraClipboardFunctionInput

classmethod create_quat_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, quat_value) → NiagaraClipboardFunctionInput

Create Quat Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• quat_value (Quat4f)

Return type:

NiagaraClipboardFunctionInput

classmethod create_struct_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, struct_value) → NiagaraClipboardFunctionInput

Create Struct Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• struct_value (UserDefinedStruct)

Return type:

NiagaraClipboardFunctionInput

classmethod create_vec2_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, vec2_value) → NiagaraClipboardFunctionInput

Create Vec 2Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• vec2_value (Vector2D)

Return type:

NiagaraClipboardFunctionInput

classmethod create_vec3_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, vec3_value) → NiagaraClipboardFunctionInput

Create Vec 3Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• vec3_value (Vector)

Return type:

NiagaraClipboardFunctionInput

classmethod create_vec4_local_value_input(outer, input_name, has_edit_condition, edit_condition_value, vec4_value) → NiagaraClipboardFunctionInput

Create Vec 4Local Value Input

Parameters:

• outer (Object)

• input_name (Name)

• has_edit_condition (bool)

• edit_condition_value (bool)

• vec4_value (Vector4f)

Return type:

NiagaraClipboardFunctionInput

classmethod get_type_name(input) → Name

Get Type Name

Parameters:

input (NiagaraClipboardFunctionInput)

Return type:

Name

classmethod try_get_input_by_name(inputs, input_name) -> (out_succeeded=bool, out_input=NiagaraClipboardFunctionInput)

Try Get Input by Name

Parameters:

• inputs (Array[NiagaraClipboardFunctionInput])

• input_name (Name)

Returns:

out_succeeded (bool):

out_input (NiagaraClipboardFunctionInput):

Return type:

tuple

classmethod try_get_local_value_as_float(input) -> (out_succeeded=bool, out_value=float)

Try Get Local Value as Float

Parameters:

input (NiagaraClipboardFunctionInput)

Returns:

out_succeeded (bool):

out_value (float):

Return type:

tuple

classmethod try_get_local_value_as_int(input) -> (out_succeeded=bool, out_value=int32)

Try Get Local Value as Int

Parameters:

input (NiagaraClipboardFunctionInput)

Returns:

out_succeeded (bool):

out_value (int32):

Return type:

tuple

classmethod try_set_local_value_as_int(input, value, loose_typing=True) → bool

Try Set Local Value as Int

Parameters:

• input (NiagaraClipboardFunctionInput)

• value (int32)

• loose_typing (bool)

Returns:

out_succeeded (bool):

Return type:

bool