unreal.RigModuleSettings

class unreal.RigModuleSettings(identifier: RigModuleIdentifier = Ellipsis, icon: SoftObjectPath = Ellipsis, category: str = '', keywords: str = '', description: str = '', exposed_connectors: None = [])

Bases: StructBase

Rig Module Settings

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigModuleDefines.h

Editor Properties: (see get_editor_property/set_editor_property)

  • category (str): [Read-Write] The category of the module

  • description (str): [Read-Write] The description of the module

  • exposed_connectors (Array[RigModuleConnector]): [Read-Write]

  • icon (SoftObjectPath): [Read-Write] The icon used for the module in the module library

  • identifier (RigModuleIdentifier): [Read-Write] The identifier used to retrieve the module in the module library

  • keywords (str): [Read-Write] The keywords of the module

property category: str

[Read-Write] The category of the module

Type:

(str)

property description: str

[Read-Write] The description of the module

Type:

(str)

property exposed_connectors: None

[Read-Only]

Type:

(Array[RigModuleConnector])

property icon: SoftObjectPath

[Read-Write] The icon used for the module in the module library

Type:

(SoftObjectPath)

property identifier: RigModuleIdentifier

[Read-Write] The identifier used to retrieve the module in the module library

Type:

(RigModuleIdentifier)

property keywords: str

[Read-Write] The keywords of the module

Type:

(str)