Plush

Effect#

plupy · Type index

Module: plupy · obtained from plupy.data.of_type("effect")[...]

A particle/refraction effect obtained through plupy.data.of_type("effect"). Root values use props; elements use stable IDs. Look values are ordinary material props.

class Effect(DataBlock)

Inherits DataBlock: its members are documented there.

Members: elements · add_element · set_element · remove_element

elements#

elements -> tuple[dict, ...]   # read-only

Element snapshots: id, name, model and effective values; references return typed handles.

add_element#

add_element(model: str) -> str

Add a Streaks, Splats, Medium or Pressure Wave element by model ID; return its stable element ID.

set_element#

set_element(element: str, name: str, value) -> None

Set a model-declared element field (e.g. burst, size, look). None resets numeric/boolean fields or clears look/layer. Look/layer values require typed material/collision-layer handles. Invalid fields and values are refused.

remove_element#

remove_element(element: str) -> None

Remove the element by stable ID; its shared look remains in the project. Undo restores the element.

DataBlock

Source#