more logical naming + update docs

packages/core/controls.mjs

@@ -972,53 +972,62 @@ const generic_params = [
   [['room', 'size']],
   /**
    * Reverb lowpass starting frequency (in hertz).
+   * When this property is changed, the reverb will be recaculated, so only change this sparsely..
    *
-   * @name revlp
-   * @param {number} level between 0 and 20000hz
+   * @name roomlp
+   * @synonyms rlp
+   * @param {number} frequency between 0 and 20000hz
    * @example
-   * s("bd sd").room(0.5).revlp(10000)
+   * s("bd sd").room(0.5).rlp(10000)
    * @example
-   * s("bd sd").room(0.5).revlp(5000)
+   * s("bd sd").room(0.5).rlp(5000)
    */
-  ['revlp'],
+  ['roomlp', 'rlp'],
   /**
    * Reverb lowpass frequency at -60dB (in hertz).
+   * When this property is changed, the reverb will be recaculated, so only change this sparsely..
    *
-   * @name revdim
-   * @param {number} level between 0 and 20000hz
+   * @name roomdim
+   * @synonyms rdim
+   * @param {number} frequency between 0 and 20000hz
    * @example
-   * s("bd sd").room(0.5).revlp(10000).revdim(8000)
+   * s("bd sd").room(0.5).rlp(10000).rdim(8000)
    * @example
-   * s("bd sd").room(0.5).revlp(5000).revdim(400)
+   * s("bd sd").room(0.5).rlp(5000).rdim(400)
    *
    */
-  ['revdim'],
+  ['roomdim', 'rdim'],
   /**
    * Reverb fade time (in seconds).
+   * When this property is changed, the reverb will be recaculated, so only change this sparsely..
    *
-   * @name fade
+   * @name roomfade
+   * @synonyms rfade
    * @param {number} seconds for the reverb to fade
    * @example
-   * s("bd sd").room(0.5).revlp(10000).fade(0.5)
+   * s("bd sd").room(0.5).rlp(10000).rfade(0.5)
    * @example
-   * s("bd sd").room(0.5).revlp(5000).fade(4)
+   * s("bd sd").room(0.5).rlp(5000).rfade(4)
    *
    */
-  ['fade'],
+  ['roomfade', 'rfade'],
   /**
    * Sets the room size of the reverb, see {@link room}.
+   * When this property is changed, the reverb will be recaculated, so only change this sparsely..
    *
    * @name roomsize
    * @param {number | Pattern} size between 0 and 10
-   * @synonyms size, sz
+   * @synonyms rsize, sz, size
    * @example
-   * s("bd sd").room(.8).roomsize("<0 1 2 4 8>")
+   * s("bd sd").room(.8).rsize(1)
+   * @example
+   * s("bd sd").room(.8).rsize(4)
    *
    */
   // TODO: find out why :
   // s("bd sd").room(.8).roomsize("<0 .2 .4 .6 .8 [1,0]>").osc()
   // .. does not work. Is it because room is only one effect?
-  ['size', 'sz', 'roomsize'],
+  ['roomsize', 'size', 'sz', 'rsize'],
   // ['sagogo'],
   // ['sclap'],
   // ['sclaves'],

packages/superdough/superdough.mjs

@@ -227,10 +227,10 @@ export const superdough = async (value, deadline, hapDuration) => {
     delaytime = 0.25,
     orbit = 1,
     room,
-    fade = 0.1,
-    revlp = 15000,
-    revdim = 1000,
-    size = 2,
+    roomfade = 0.1,
+    roomlp = 15000,
+    roomdim = 1000,
+    roomsize = 2,
     velocity = 1,
     analyze, // analyser wet
     fft = 8, // fftSize 0 - 10
@@ -368,8 +368,8 @@ export const superdough = async (value, deadline, hapDuration) => {
   }
   // reverb
   let reverbSend;
-  if (room > 0 && size > 0) {
-    const reverbNode = getReverb(orbit, size, fade, revlp, revdim);
+  if (room > 0 && roomsize > 0) {
+    const reverbNode = getReverb(orbit, roomsize, roomfade, roomlp, roomdim);
     reverbSend = effectSend(post, reverbNode, room);
   }
 

website/src/pages/learn/effects.mdx

@@ -183,36 +183,40 @@ global effects use the same chain for all events of the same orbit:
 
 <JsDoc client:idle name="orbit" h={0} />
 
-## delay
+## Delay
+
+### delay
 
 <JsDoc client:idle name="delay" h={0} />
 
-## delaytime
+### delaytime
 
 <JsDoc client:idle name="delaytime" h={0} />
 
-## delayfeedback
+### delayfeedback
 
 <JsDoc client:idle name="delayfeedback" h={0} />
 
-## room
+## Reverb
+
+### room
 
 <JsDoc client:idle name="room" h={0} />
 
-## roomsize
+### roomsize
 
 <JsDoc client:idle name="roomsize" h={0} />
 
-## fade
+### roomfade
 
-<JsDoc client:idle name="fade" h={0} />
+<JsDoc client:idle name="roomfade" h={0} />
 
-## revlp
+### roomlp
 
-<JsDoc client:idle name="revlp" h={0} />
+<JsDoc client:idle name="roomlp" h={0} />
 
-## revdim
+### roomdim
 
-<JsDoc client:idle name="revdim" h={0} />
+<JsDoc client:idle name="roomdim" h={0} />
 
 Next, we'll look at strudel's support for [Csound](/learn/csound).