view release on metacpan or  search on metacpan

lib/Algorithm/Gutter/Cell.pod  view on Meta::CPAN

=item B<update>

Mutator for a code reference that will be called when the B<drain>
method in L<Algorithm::Gutter> calculates that this cell's fluid
drains. The reference is called with the cell object, cell index in the
gutter list, how much fluid drained, and an optional I<stash> provided
by the caller.

The caller is responsible for the return value, which will be
accumulated by the parent B<drain> method and returned to the caller as
a list. For example, the B<update> code could return MIDI events, the
amount of fluid drained, both, neither, or other values as need be.

Failing to set an update callback for a cell that triggers will result
in an exception.

=back

=head1 METHODS