reference/functions/nksp_ignore_controller_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>ignore_controller() function</title>
    <meta name="description" content="Drops the given MIDI control change event.">
  </head>
  <body>
    <h1>ignore_controller()</h1>
    <p>
      Drops the given MIDI control change event and thus prevents the supplied
      event to be further processed by the sampler. You can use this function
      i.e. to filter out MIDI control change events, before they are causing
      the sound to be changed.
    </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 lang="nksp">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>
ignore_controller([??event-id??])
    </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</td>
        <td>MIDI control change event to be dropped.<br>
            [optional, default: ID of the event handler's event]</td>
      </tr>
    </table>
    
    <h3>Return Value</h3>
    <p>None.</p>
    
    <h3>Examples</h3>
    <p>None yet.<p>

    <note>
      Dynamic, optional arguments are only supported by NKSP. If you want to
      retain compatibility to KSP, then you should always pass a parameter
      to this function.
    </note>

  </body>
</html>
1	schoenebeck	2732	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>ignore_controller() function</title>
5			<meta name="description" content="Drops the given MIDI control change event.">
6			</head>
7			<body>
8			<h1>ignore_controller()</h1>
9			<p>
10			Drops the given MIDI control change event and thus prevents the supplied
11			event to be further processed by the sampler. You can use this function
12			i.e. to filter out MIDI control change events, before they are causing
13			the sound to be changed.
14			</p>
15			<p>
16			The argument this function takes is optional. If you omit passing an
17			argument to this function, then the controller event ID will be used that
18	schoenebeck	2742	caused this current <code lang="nksp">controller</code> event handler to be executed.
19	schoenebeck	2732	</p>
20			<p>
21			There is also an <code>ignore_event()</code> function. With
22			NKSP the two functions are both doing the same thing though.
23			The two exist merely due to compatibility reasons with KSP.
24			</p>
25
26			<h3>Function Prototype</h3>
27			<p/>
28			<code>
29			ignore_controller([??event-id??])
30			</code>
31
32			<h3>Arguments</h3>
33			<table>
34			<tr>
35			<th>Argument Name</th> <th>Data Type</th> <th>Description</th>
36			</tr>
37			<tr>
38			<td><code>??event-id??</code></td>
39			<td>Event ID Number</td>
40			<td>MIDI control change event to be dropped.<br>
41			[optional, default: ID of the event handler's event]</td>
42			</tr>
43			</table>
44
45			<h3>Return Value</h3>
46			<p>None.</p>
47
48			<h3>Examples</h3>
49			<p>None yet.<p>
50
51			<note>
52			Dynamic, optional arguments are only supported by NKSP. If you want to
53			retain compatibility to KSP, then you should always pass a parameter
54			to this function.
55			</note>
56
57			</body>
58			</html>