Plush

Component#

plupy · Type index

Module: plupy · obtained from obj.components[...], obj.components.add(key), plupy.scripts.attach(obj, name)

A component stored on an object or component group (obj.components[...]): its catalog key, its props and its wireable pins.

An unavailable component keeps its identity and may be removed; requesting its properties reports that the script must compile successfully first.

class Component(Handle)

Inherits Handle: its members are documented there.

Usage and examples

Members: key · owner · available · props · pins · remove

key#

key -> str   # read-only

Catalog key, separate from instance id; type remains "component".

owner#

owner -> Object | ComponentGroup   # read-only

Editable definition that owns this component.

available#

available -> bool   # read-only

Whether component metadata is available; false for an uncompiled/missing script.

props#

props -> ComponentProperties   # read-only

All supported editable properties, independently of wiring pins.

pins#

pins -> Pins   # read-only

Wireable fields currently represented in this component's graph.

remove#

remove()

Removes a locally owned component; returns None. Connected pins, including wires into held material data, must be disconnected first. Removing group-owned components this way is rejected.

ComponentGroup · ComponentProperties · Handle · Object · Pins

Source#