/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_message_function.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_message_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3312 - (show annotations) (download) (as text)
Sat Jul 15 17:04:05 2017 UTC (4 months, 1 week ago) by schoenebeck
File MIME type: text/html
File size: 2684 byte(s)
* NKSP: Updated docs for built-in preprocessor condition "NKSP_NO_MESSAGE".

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 <note class="important">
14 The message() function is not appropriate for being used with your final
15 production sounds, since it can lead to audio dropouts.
16 You should only use the message() function to try out things, and to spot
17 and debug problems with your scripts. Same applies to all text string
18 variables in general. Don't use any
19 <a href="nksp.html#string_variables">string variables</a> in your final
20 production sounds.
21 You may use <a href="nksp.html#preprocessor_statements">preprocessor statements</a>
22 to handle this effectively.
23 </note>
24 <p>
25 Since it is a common requirement to switch a script between a development
26 version and a production version, with either debug messages turned on or
27 off, there is a dedicated built-in preprocessor condition to handle this
28 conveniently for all <code>message()</code> calls: By simply adding
29 <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> to your script, all subsequent
30 <code>message()</code> calls will be filtered out by the parser on
31 preprocessor level. You can also revert that behavior at a subsequent
32 section in your script by adding <code>RESET_CONDITION(NKSP_NO_MESSAGE)</code>,
33 so all subsequent calls to <code>message()</code> will be processed again.
34 This way you can easily also just disable <code>message()</code> calls in
35 certain sections of your script.
36 </p>
37
38 <h3>Function Prototype</h3>
39 <p/>
40 <code lang="nksp">
41 message(??text??)
42 </code>
43
44 <h3>Arguments</h3>
45 <table>
46 <tr>
47 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
48 </tr>
49 <tr>
50 <td><code>??text??</code></td>
51 <td>String</td>
52 <td>The text to be printed to the terminal.<br>
53 [required]</td>
54 </tr>
55 </table>
56
57 <h3>Return Value</h3>
58 <p>None.</p>
59
60 <h3>Examples</h3>
61 <p/>
62 <code>
63 on note
64 message("Note " & $EVENT_NOTE & " was triggered with velocity " & $EVENT_VELOCITY)
65 end on
66
67 on release
68 message("Note " & $EVENT_NOTE & " was released with release velocity " & $EVENT_VELOCITY)
69 end on
70
71 on controller
72 message("MIDI Controller " & $CC_NUM " changed its value to " & %CC[$CC_NUM])
73 end on
74 </code>
75
76 </body>
77 </html>

  ViewVC Help
Powered by ViewVC