unreal.NiagaraVariableMetaData

class unreal.NiagaraVariableMetaData

Bases: StructBase

Niagara Variable Meta Data

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraVariableMetaData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • advanced_display (bool): [Read-Write] Declares that this input is advanced and should only be visible if expanded inputs have been expanded.

  • alternate_aliases (Array[Name]): [Read-Write] List of alternate/previous names for this variable. Note that this is not normally needed if you rename through the UX. However, if you delete and then add a different variable, intending for it to match, you will likely want to add the prior name here.

    You may need to restart and reload assets after making this change to have it take effect on already loaded assets.

  • description (Text): [Read-Write]

  • display_in_overview_stack (bool): [Read-Write] Declares that this parameter’s value will be shown in the overview node if it’s set to a local value.

  • display_unit (Unit): [Read-Write] The unit to display next to input fields for this parameter - note that this is only a visual indicator and does not change any of the calculations.

  • edit_condition (NiagaraInputConditionMetadata): [Read-Write] Declares the associated input should be conditionally editable based on the value of another input.

  • enable_bool_override (bool): [Read-Write] Useful to override inline bool visualization in the overview.

  • inline_edit_condition_toggle (bool): [Read-Write] Declares the associated input is used as an inline edit condition toggle, so it should be hidden and edited as a

    checkbox inline with the input which was designated as its edit condition.

  • inline_parameter_bool_override (NiagaraBoolParameterMetaData): [Read-Write] Useful to override inline bool visualization in the overview.

  • inline_parameter_color_override (LinearColor): [Read-Write] The color used to display a parameter in the overview. If no color is specified, the type color is used.

  • inline_parameter_enum_overrides (Array[NiagaraEnumParameterMetaData]): [Read-Write] The index of the entry maps to the index of an enum value. Useful for overriding how an enum parameter is displayed in the overview.

  • inline_parameter_sort_priority (int32): [Read-Write] Affects the sort order for parameters shown inline in the overview. Use a smaller number to push it to the top. Defaults to zero.

  • override_color (bool): [Read-Write] The color used to display a parameter in the overview. If no color is specified, the type color is used.

  • property_meta_data (Map[Name, str]): [Read-Write] Property Metadata

  • visible_condition (NiagaraInputConditionMetadata): [Read-Write] Declares the associated input should be conditionally visible based on the value of another input.

  • widget_customization (NiagaraInputParameterCustomization): [Read-Write] Changes how the input is displayed.