unreal.MaterialExpressionFunctionInput

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

Bases: MaterialExpression

Material Expression Function Input

C++ Source:

  • Module: Engine

  • File: MaterialExpressionFunctionInput.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blend_input_relevance (BlendInputRelevance): [Read-Write] Marks that this input is necessary for blend function use *

  • compiling_function_preview (bool): [Read-Write] deprecated: bCompilingFunctionPreview has been removed from function inputs and has no functional usage, it has been replaced by automatic state tracking between function calls.

  • desc (str): [Read-Write] A description that level designers can add (shows in the material editor UI).

  • description (str): [Read-Write] The input’s description, which will be used as a tooltip on the connector in function call expressions that use this function.

  • input_name (Name): [Read-Write] The input’s name, which will be drawn on the connector in function call expressions that use this function.

  • input_type (FunctionInputType): [Read-Write] Type of this input. Input code chunks will be cast to this type, and a compiler error will be emitted if the cast fails.

  • material_expression_editor_x (int32): [Read-Write]

  • material_expression_editor_y (int32): [Read-Write]

  • preview_value (Vector4f): [Read-Write] Value used to preview this input when editing the material function.

  • sort_priority (int32): [Read-Write] Controls where the input is displayed relative to the other inputs.

  • use_preview_value_as_default (bool): [Read-Write] Whether to use the preview value or texture as the default value for this input.

property compiling_function_preview: bool

[Read-Write] deprecated: bCompilingFunctionPreview has been removed from function inputs and has no functional usage, it has been replaced by automatic state tracking between function calls.

Type:

(bool)

property input_name: Name

[Read-Write] The input’s name, which will be drawn on the connector in function call expressions that use this function.

Type:

(Name)

property input_type: FunctionInputType

[Read-Write] Type of this input. Input code chunks will be cast to this type, and a compiler error will be emitted if the cast fails.

Type:

(FunctionInputType)

property preview_value: Vector4f

[Read-Write] Value used to preview this input when editing the material function.

Type:

(Vector4f)

property sort_priority: int

[Read-Write] Controls where the input is displayed relative to the other inputs.

Type:

(int32)

property use_preview_value_as_default: bool

[Read-Write] Whether to use the preview value or texture as the default value for this input.

Type:

(bool)