Plush

EvaluatedUse#

plupy · Type index

Module: plupy · obtained from use.evaluated

A use's resolved values after inputs, wires and group composition (use.evaluated): read-only props, inputs and transforms.

props[key] and inputs[name] return ordinary values or reference handles. Iteration yields keys; len(...) reports their count. props.schema() returns descriptors with key, name, kind, target_type and resolved/default value. Referenced datablocks retain their authored identity. These mappings do not expose every script field or per-use material parameter.

Read/write sourceMeaning
obj.props[key], component.props[key], pin.valueStored source property
obj.inputs[name]Declared default, falling back to inherited target
use.inputs[name]Stored use value, then preset/default/inheritance; excludes outer forwarding
use.evaluated.inputs[name]Resolved value, including outer forwarding

Editing a masked source changes that source, leaving its driver connected. When the wire is removed and intervening overrides/defaults reset, the new source value appears. Reads include earlier writes in the current plupy.edit(...) group immediately. No refresh or flush call is needed; repeated evaluated world-transform reads reuse current results internally.

class EvaluatedUse

Usage and examples

Members: active · props · inputs · transform · world_transform · transform_2d · world_transform_2d

active#

active -> bool   # read-only

Read-only activation after optional-child inputs, parents and the root's collection are applied. This is the authored scene result; gameplay changes during Play are not written back here.

props#

props -> EvaluatedProperties   # read-only

Read-only mapping of the registered object properties as they resolve.

inputs#

inputs -> EvaluatedInputs   # read-only

Read-only mapping of the resolved declared inputs.

transform#

transform -> Transform   # read-only

Read-only evaluated 3D channels, parent-local.

world_transform#

world_transform -> Transform   # read-only

Read-only evaluated 3D channels in world space.

transform_2d#

transform_2d -> Transform   # read-only

Read-only evaluated 2D channels, parent-local.

world_transform_2d#

world_transform_2d -> Transform   # read-only

Read-only evaluated 2D channels in world space.

EvaluatedInputs · EvaluatedProperties · Transform · edit

Source#