HelpSource/Reference/UGen-doneActions.schelp

   1 title:: UGen done-actions
   2 summary:: Actions to take when an UGen has finished
   3 categories:: UGens, Server>Nodes
   4 related:: Classes/UGen
   5
   6 A number of UGens implement doneActions. These allow one to optionally free or pause the enclosing synth and other related nodes when the UGen is finished. These include link::Classes/EnvGen::, link::Classes/Line::, link::Classes/XLine::, link::Classes/Linen::, link::Classes/DetectSilence::, link::Classes/PlayBuf::, link::Classes/Duty::, link::Classes/TDuty:: and link::Classes/Demand::.
   7
   8 For a list, see strong:: UGens>Synth control :: in the link::Browse#UGens>Synth control:: page.
   9
  10 section:: Actions
  11 The available done actions are as follows:
  12 table::
  13 ## 0 || do nothing when the UGen is finished
  14 ## 1 || pause the enclosing synth, but do not free it
  15 ## 2 || free the enclosing synth
  16 ## 3 || free both this synth and the preceding node
  17 ## 4 || free both this synth and the following node
  18 ## 5 || free this synth; if the preceding node is a group then do g_freeAll on it, else free it
  19 ## 6 || free this synth; if the following node is a group then do g_freeAll on it, else free it
  20 ## 7 || free this synth and all preceding nodes in this group
  21 ## 8 || free this synth and all following nodes in this group
  22 ## 9 || free this synth and pause the preceding node
  23 ## 10 || free this synth and pause the following node
  24 ## 11 || free this synth and if the preceding node is a group then do g_deepFree on it, else free it
  25 ## 12 || free this synth and if the following node is a group then do g_deepFree on it, else free it
  26 ## 13 || free this synth and all other nodes in this group (before and after)
  27 ## 14 || free the enclosing group and all nodes within it (including this synth)
  28 ::
  29
  30 For information on code::freeAll:: and code::deepFree::, see link::Classes/Group:: and link::Reference/Server-Command-Reference::.
  31