HelpSource/Classes/StartUp.schelp

   1 class:: StartUp
   2 summary:: register functions to be evaluated after the startup is finished
   3 related:: Classes/ShutDown, Classes/ServerBoot, Classes/ServerTree, Classes/CmdPeriod
   4 categories:: Control
   5
   6 description::
   7 StartUp registers functions to perform an action after the library has been compiled, and after the startup file has run. For instance this is used for creating link::Classes/SynthDef:: in the strong::initClass:: function of class files in order to be able to make the synthdef directory customizable by the startup script.
   8
   9 If an object is registered, strong::doOnStartUp:: must be implemented. Otherwise a function can be used.
  10
  11 ClassMethods::
  12
  13 method::add
  14 Registers an object or function to be evaluated after startup is finished.
  15
  16 method::defer
  17 Registers an object or function to be evaluated after startup is finished, or immediately, if this has happened already.
  18
  19 method::remove
  20 Removes an object that was previously registered.
  21
  22 method::run
  23 Call the object in order.
  24
  25 Examples::
  26
  27 code::
  28 *initClass {
  29         StartUp.add {
  30                 // something to do...
  31         }
  32 }
  33 ::