| 928 |
loop is thus left at that point and the text message was printed |
loop is thus left at that point and the text message was printed |
| 929 |
three times in total. |
three times in total. |
| 930 |
</p> |
</p> |
| 931 |
|
|
| 932 |
|
<h3>User Functions</h3> |
| 933 |
|
<p> |
| 934 |
|
We already came across various built-in functions, which you may call |
| 935 |
|
by your scripts to perform certain tasks or behavior which is already |
| 936 |
|
provided for you by the sampler. NKSP also allows you to write your |
| 937 |
|
own functions, which you then may call from various places of your |
| 938 |
|
script. |
| 939 |
|
<p> |
| 940 |
|
</p> |
| 941 |
|
When working on larger scripts, you |
| 942 |
|
may notice that you easily get to the point where you may have to |
| 943 |
|
duplicate portions of your script code, since there are certain things |
| 944 |
|
that you may have to do again and again in different parts of your script. |
| 945 |
|
Software developers usually try to avoid such code duplications to |
| 946 |
|
keep the overall amount of code as small as possible, since the |
| 947 |
|
overall amount of code would bloat quickly and would |
| 948 |
|
make the software very hard to maintain. One way for you to avoid such |
| 949 |
|
script code duplications with NKSP is to write so called <i>User Functions</s>. |
| 950 |
|
</p> |
| 951 |
|
<p> |
| 952 |
|
Let's assume you wanted to create a simple stuttering effect. You may do so |
| 953 |
|
like in the following example. |
| 954 |
|
</p> |
| 955 |
|
<code> |
| 956 |
|
on note |
| 957 |
|
while (1) |
| 958 |
|
wait(200000) |
| 959 |
|
if (not (event_status($EVENT_ID) .and. $EVENT_STATUS_NOTE_QUEUE)) |
| 960 |
|
exit() |
| 961 |
|
end if |
| 962 |
|
change_vol($EVENT_ID, -20000) { Reduce volume by 20 dB. } |
| 963 |
|
wait(200000) |
| 964 |
|
if (not (event_status($EVENT_ID) .and. $EVENT_STATUS_NOTE_QUEUE)) |
| 965 |
|
exit() |
| 966 |
|
end if |
| 967 |
|
change_vol($EVENT_ID, 0) { Increase volume to 0 dB. } |
| 968 |
|
end while |
| 969 |
|
end on |
| 970 |
|
</code> |
| 971 |
|
<p> |
| 972 |
|
This script will run an endless loop for each note being triggered. |
| 973 |
|
Every <code lang="none">200ms</code> it will turn the volume alternatingly down and |
| 974 |
|
up to create the audible stuttering effect. After each <code lang="nksp">wait()</code> |
| 975 |
|
call it calls <code>event_status($EVENT_ID)</code> to check whether |
| 976 |
|
this note is still alive, and as soon as the note died, it will stop |
| 977 |
|
execution of the script instance by calling <code>exit()</code>. The latter |
| 978 |
|
is important in this example, because otherwise the script execution instances would |
| 979 |
|
continue to run in this endless loop forever, even after the respectives |
| 980 |
|
notes are gone. Which would let your CPU usage to increase with every new note |
| 981 |
|
and would never decrease again. |
| 982 |
|
This behavior of the sampler is not a bug, it is intended, since there may |
| 983 |
|
also be cases where you want to do certain things by script even after the |
| 984 |
|
respective notes are dead and gone. However as you can see, that script is |
| 985 |
|
using the same portions of script code twice. To avoid that, you could also |
| 986 |
|
write the same script with a user function like this: |
| 987 |
|
</p> |
| 988 |
|
<code> |
| 989 |
|
function pauseMyScript |
| 990 |
|
wait(200000) |
| 991 |
|
if (not (event_status($EVENT_ID) .and. $EVENT_STATUS_NOTE_QUEUE)) |
| 992 |
|
exit() |
| 993 |
|
end if |
| 994 |
|
end function |
| 995 |
|
|
| 996 |
|
on note |
| 997 |
|
while (1) |
| 998 |
|
call pauseMyScript |
| 999 |
|
change_vol($EVENT_ID, -20000) { Reduce volume by 20 dB. } |
| 1000 |
|
call pauseMyScript |
| 1001 |
|
change_vol($EVENT_ID, 0) { Increase volume back to 0 dB. } |
| 1002 |
|
end while |
| 1003 |
|
end on |
| 1004 |
|
</code> |
| 1005 |
|
<p> |
| 1006 |
|
The script became in this simple example only slightly smaller, but it also |
| 1007 |
|
became easier to read and behaves identically to the previous solution. |
| 1008 |
|
And in practice, with a more complex script, you can |
| 1009 |
|
reduce the overall amount of script code a lot this way. You can choose any |
| 1010 |
|
name for your own user functions, as long as the name is not already |
| 1011 |
|
reserved by a built-in function. Note that for calling a user function, |
| 1012 |
|
you must always precede the actual user function name with the |
| 1013 |
|
<code>call</code> keyword. Likewise you may however not use the |
| 1014 |
|
<code>call</code> keyword for calling any built-in function. So that |
| 1015 |
|
substantially differs calling built-in functions from calling user functions. |
| 1016 |
|
</p> |
| 1017 |
|
|
| 1018 |
<h2>Operators</h2> |
<h2>Operators</h2> |
| 1019 |
<p> |
<p> |
| 1020 |
A programming language provides so called <i>operators</i> to perform |
A programming language provides so called <i>operators</i> to perform |
Parent Directory
| 
Revision Log
| 
Patch