reference/functions/nksp_note_off_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>note_off() function</title>
    <meta name="description" content="Releases the requested note.">
  </head>
  <body>
    <h1>note_off()</h1>
    <p>
      Releases a note by passing the note's event ID to this function.
      This is almost like sending a MIDI note off event programmatically, however
      a call to this function will only affect one single note instead.
    </p>
    <p>
      The argument this function takes is optional. If you omit passing an
      argument to this function, then the controller event ID will be used that
      caused this current <code>controller</code> event handler to be executed.
    </p>
    <p>
      There is also an <code>ignore_event()</code> function. With
      NKSP the two functions are both doing the same thing though.
      The two exist merely due to compatibility reasons with KSP.
    </p>

    <h3>Function Prototype</h3>
    <p/>
    <code>
note_off(??event-id??, [??velocity??])
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??event-id??</code></td>
        <td>Event ID Number or Event ID Array</td>
        <td>Event ID(s) of the note(s) to be released.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??velocity??</code></td>
        <td>Integer Number</td>
        <td>MIDI note off velocity value.<br>
            [optional, default: 127]</td>
      </tr>
    </table>
    
    <h3>Return Value</h3>
    <p>None.</p>
    
    <h3>Examples</h3>
    <p>None yet.<p>

    <note>
      Passing an array of event IDs is only supported by NKSP. If you want
      to keep compatibility to KSP, then you should only pass a single
      event ID to this function.
    </note>
    
    <note>
      The second argument of this function <code>??velocity??</code> is only
      supported by NKSP. If you want to keep compatibility with KSP, then you
      should only pass one argument to this function.
    </note>

  </body>
</html>
1	<html>
2	<head>
3	<meta name="author" content="Christian Schoenebeck">
4	<title>note_off() function</title>
5	<meta name="description" content="Releases the requested note.">
6	</head>
7	<body>
8	<h1>note_off()</h1>
9	<p>
10	Releases a note by passing the note's event ID to this function.
11	This is almost like sending a MIDI note off event programmatically, however
12	a call to this function will only affect one single note instead.
13	</p>
14	<p>
15	The argument this function takes is optional. If you omit passing an
16	argument to this function, then the controller event ID will be used that
17	caused this current <code>controller</code> event handler to be executed.
18	</p>
19	<p>
20	There is also an <code>ignore_event()</code> function. With
21	NKSP the two functions are both doing the same thing though.
22	The two exist merely due to compatibility reasons with KSP.
23	</p>
24
25	<h3>Function Prototype</h3>
26	<p/>
27	<code>
28	note_off(??event-id??, [??velocity??])
29	</code>
30
31	<h3>Arguments</h3>
32	<table>
33	<tr>
34	<th>Argument Name</th> <th>Data Type</th> <th>Description</th>
35	</tr>
36	<tr>
37	<td><code>??event-id??</code></td>
38	<td>Event ID Number or Event ID Array</td>
39	<td>Event ID(s) of the note(s) to be released.<br>
40	[required]</td>
41	</tr>
42	<tr>
43	<td><code>??velocity??</code></td>
44	<td>Integer Number</td>
45	<td>MIDI note off velocity value.<br>
46	[optional, default: 127]</td>
47	</tr>
48	</table>
49
50	<h3>Return Value</h3>
51	<p>None.</p>
52
53	<h3>Examples</h3>
54	<p>None yet.<p>
55
56	<note>
57	Passing an array of event IDs is only supported by NKSP. If you want
58	to keep compatibility to KSP, then you should only pass a single
59	event ID to this function.
60	</note>
61
62	<note>
63	The second argument of this function <code>??velocity??</code> is only
64	supported by NKSP. If you want to keep compatibility with KSP, then you
65	should only pass one argument to this function.
66	</note>
67
68	</body>
69	</html>