/[svn]/doc/docbase/instrument_scripts/nksp/01_nksp.html

Diff of /doc/docbase/instrument_scripts/nksp/01_nksp.html

Parent Directory | Revision Log | View Patch Patch

-revision 3061 by schoenebeck,
Fri Dec 16 17:20:55 2016 UTC
+revision 3191 by schoenebeck,
Fri May 19 15:19:37 2017 UTC
 Line 11
        your own instrument scripts in short time. It concentrates on describing
        the script language. If you rather want to learn how to modify and
        attach scripts to your sounds, then please refer to the gigedit manual for
-       <a href="gigedit_scripts.html">how to manage instrument scripts with gigedit</a>.
+       <a href="gigedit_scripts.html">how to manage instrument scripts with gigedit</a>
+       for Gigasampler/GigaStudio format sounds, or refer to the SFZ opcode
+       <code lang="sfz">script</code> for attaching NKSP scripts with
+       SFZ format sounds.
      </p>
      <h3>At a Glance</h3>
-Line 251 
 end on
+Line 254 
 end on
      <p>
        The left hand side's <code>??variable-name??</code> is an arbitrary name
        you can chose for your variable. That name might consist of English
-       letters A to Z (lower and upper case) and the underscore character "<code>_</code>".
+       letters A to Z (lower and upper case), digits (<code>0</code> to <code>9</code>),
+       and the underscore character "<code>_</code>".
        Variable names must be unique. So you can neither declare several variables
        with the same name, nor can you use a name for your variable that is
        already been reserved by <i>built-in variables</i>.
-Line 768 
 on note
+Line 772 
 on note
        @postfix := "nd"
      case 3
        @postfix := "rd"
-   end if
+   end select
    message("This is the " & $numberOfNotes & @postfix & " note triggered so far.")
  end on
-Line 809 
 on note
+Line 813 
 on note
      case 3
        message("Third note was triggered!") { Will never be printed ! }
        exit
-   end if
+   end select
    message("Wow, already the " & $numberOfNotes & "th note triggered.")
  end on
-Line 848 
 on note
+Line 852 
 on note
      case 1 to 99
        message("Less than 100 notes triggered so far")
        exit
-   end if
+   end select
    message("Wow, already the " & $numberOfNotes & "th note triggered.")
  end on
-Line 933 
 end on
+Line 937 
 end on
      <p>
        We already came across various built-in functions, which you may call
        by your scripts to perform certain tasks or behavior which is already
-       provided for you by the sampler. When working on larger scripts, you
+       provided for you by the sampler. NKSP also allows you to write your
+       own functions, which you then may call from various places of your
+       script.
+     <p>
+     </p>
+       When working on larger scripts, you
        may notice that you easily get to the point where you may have to
        duplicate portions of your script code, since there are certain things
        that you may have to do again and again in different parts of your script.
        Software developers usually try to avoid such code duplications to
-       keep the overall amount of code as small as possible, since it would
+       keep the overall amount of code as small as possible, since the
+       overall amount of code would bloat quickly and would
        make the software very hard to maintain. One way for you to avoid such
        script code duplications with NKSP is to write so called <i>User Functions</s>.
      </p>
-Line 964 
 end on
+Line 974 
 end on
      </code>
      <p>
        This script will run an endless loop for each note being triggered.
-       Every <code>200ms</code> it will turn the volume alternatingly down and
+       Every <code lang="none">200ms</code> it will turn the volume alternatingly down and
-       up to create the audible stuttering effect. After each <code>wait()</code>
+       up to create the audible stuttering effect. After each <code lang="nksp">wait()</code>
        call it calls <code>event_status($EVENT_ID)</code> to check whether
        this note is still alive, and as soon as the note died, it will stop
        execution of the script instance by calling <code>exit()</code>. The latter
-       is important in this case, because otherwise the script instances would
+       is important in this example, because otherwise the script execution instances would
        continue to run in this endless loop forever, even after the respectives
-       notes are gone. Which would let your CPU usage to increase with every note.
+       notes are gone. Which would let your CPU usage to increase with every new note
+       and would never decrease again.
        This behavior of the sampler is not a bug, it is intended, since there may
        also be cases where you want to do certain things by script even after the
        respective notes are dead and gone. However as you can see, that script is
-Line 997 
 end on
+Line 1008 
 end on
      </code>
      <p>
        The script became in this simple example only slightly smaller, but it also
-       became easier to read. And in practice, with a more complex script, you can
+       became easier to read and behaves identically to the previous solution.
+       And in practice, with a more complex script, you can
        reduce the overall amount of script code a lot this way. You can choose any
        name for your own user functions, as long as the name is not already
        reserved by a built-in function. Note that for calling a user function,

 Legend:



Removed from v.3061
 


changed lines


 
Added in v.3191
 Legend:



Removed from v.3061
 


changed lines


 
Added in v.3191
-Removed from v.3061
+Added in v.3191

	ViewVC Help
Powered by ViewVC