Log inGet started
Package

effects.package

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

effects

The tools that play, picture and measure effects: an .effect asset on the preview stage, or an Effect placed in a scene, played where it stands. Nothing is added to the scene by a stage play, and a play in place changes none of the Effect's fields.

  • play: play an entry of an effect for a number of seconds, with inputs, and answer its profile and a picture at each time asked for. { effect, entry?, inputs?, seconds?, at? } plays it on the stage; { entity, ... } plays a placed Effect where it stands.
  • capture: pictures of an effect at moments of its graph time, every graph of the entry brought to each time and pictured together. { effect | entity, entry?, inputs?, times }.
  • profile: what playing an effect costs, as one tree: the effect, its entry, each graph the entry plays, and each graph's nodes. { effect | entity, entry?, inputs?, seconds? }.

A single graph is played, pictured and measured by the procgen toolbox (play, frames, onPresent, profile).