unreal.RigUnit_GetCandidates

class unreal.RigUnit_GetCandidates(connector: RigElementKey = Ellipsis, candidates: None = [])

Bases: RigUnit

Returns the connection candidates for one connector

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_ConnectionCandidates.h

Editor Properties: (see get_editor_property/set_editor_property)

  • candidates (Array[RigElementKey]): [Read-Write] The items being interacted on

  • connector (RigElementKey): [Read-Write] The connector being resolved

property candidates: None

[Read-Only] The items being interacted on

Type:

(Array[RigElementKey])

property connector: RigElementKey

[Read-Only] The connector being resolved

Type:

(RigElementKey)