HelpSource/Classes/RootNode.schelp

   1 class:: RootNode
   2 summary:: The persistent root group on the server
   3 categories:: Server>Nodes
   4 related:: Classes/Group, Reference/default_group
   5
   6 description::
   7 A RootNode is the Group with the nodeID of 0 which is always present on each Server and represents the root of that server's node tree.
   8
   9 It is always playing, and always running, cannot be freed, or moved anywhere.
  10
  11 Cacheing is used so that there is always one RootNode per link::Classes/Server::.
  12 code::
  13 s = Server.local;
  14
  15 a = RootNode(s);
  16 b = RootNode(s);
  17
  18 a === b; // identical object
  19 ::
  20 sending code::"/s_new":: messages to the server, the target 0 is what is represented by this object.
  21 code::
  22 s.sendMsg("/s_new", "default", -1, 0, 0);//the last argument is the target id
  23 ::
  24 IMPORTANT: In general one should strong::not:: add nodes to the RootNode unless one has a specific reason to do so. Instead one should add nodes to the default_group.
  25 This provides a known basic node order and protects functionality like Server.record, Server.scope, etc. The default group is the default target for all new nodes, so when using object style nodes will normally not be added to the RootNode unless that is explicitly specified. See link::Reference/default_group:: for more information.
  26
  27 classmethods::
  28 private:: initClass
  29 instancemethods::
  30 private:: rninit, free, moveBefore, moveAfter, moveToHead, moveToTail, run
  31