1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>message() function</title> |
5 |
<meta name="description" content="Prints text to the sampler's terminal."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>message()</h1> |
9 |
<p> |
10 |
Prints the provided text to the sampler's terminal. This function is |
11 |
merely for script development and debugging purposes. |
12 |
</p> |
13 |
|
14 |
<h3>Function Prototype</h3> |
15 |
<p/> |
16 |
<code lang="nksp"> |
17 |
message(??text??) |
18 |
</code> |
19 |
|
20 |
<h3>Arguments</h3> |
21 |
<table> |
22 |
<tr> |
23 |
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
24 |
</tr> |
25 |
<tr> |
26 |
<td><code>??text??</code></td> |
27 |
<td>String</td> |
28 |
<td>The text to be printed to the terminal.<br> |
29 |
[required]</td> |
30 |
</tr> |
31 |
</table> |
32 |
|
33 |
<h3>Return Value</h3> |
34 |
<p>None.</p> |
35 |
|
36 |
<h3>Examples</h3> |
37 |
<p/> |
38 |
<code> |
39 |
on note |
40 |
message("Note " & $EVENT_NOTE & " was triggered with velocity " & $EVENT_VELOCITY) |
41 |
end on |
42 |
|
43 |
on release |
44 |
message("Note " & $EVENT_NOTE & " was released with release velocity " & $EVENT_VELOCITY) |
45 |
end on |
46 |
|
47 |
on controller |
48 |
message("MIDI Controller " & $CC_NUM " changed its value to " & %CC[$CC_NUM]) |
49 |
end on |
50 |
</code> |
51 |
|
52 |
<note class="important"> |
53 |
The message() function is not appropriate for being used with your final |
54 |
production sounds, since it can lead to audio dropouts. |
55 |
You should only use the message() function to try out things, and to spot |
56 |
and debug problems with your scripts. Same applies to all text string |
57 |
variables in general. Don't use any |
58 |
<a href="nksp.html#string_variables">string variables</a> in your final |
59 |
production sounds. |
60 |
You may use <a href="nksp.html#preprocessor_statements">preprocessor statements</a> |
61 |
to handle this effectively. |
62 |
</note> |
63 |
|
64 |
</body> |
65 |
</html> |