14 |
they can cause any sound to be changed. |
they can cause any sound to be changed. |
15 |
</p> |
</p> |
16 |
<p> |
<p> |
17 |
|
The argument this function takes is optional. If you omit passing an |
18 |
|
argument to this function, then the event ID will be used that |
19 |
|
caused this current event handler to be executed |
20 |
|
(which is <code>$EVENT_ID</code>). |
21 |
|
</p> |
22 |
|
<p> |
23 |
Dropping events with this function only succeeds if the event just |
Dropping events with this function only succeeds if the event just |
24 |
"recently" occurred. That effectively means you should drop the event in |
"recently" occurred. That effectively means you should drop the event in |
25 |
the respective event handler before any <code lang="nksp">wait()</code> calls, and before |
the respective event handler before any <code lang="nksp">wait()</code> calls, and before |
40 |
<h3>Function Prototype</h3> |
<h3>Function Prototype</h3> |
41 |
<p/> |
<p/> |
42 |
<code> |
<code> |
43 |
ignore_event(??event-id??) |
ignore_event([??event-id??]) |
44 |
</code> |
</code> |
45 |
|
|
46 |
<h3>Arguments</h3> |
<h3>Arguments</h3> |
52 |
<td><code>??event-id??</code></td> |
<td><code>??event-id??</code></td> |
53 |
<td>Event ID Number or Event ID Array</td> |
<td>Event ID Number or Event ID Array</td> |
54 |
<td>Event ID(s) of the MIDI event(s) to be dropped.<br> |
<td>Event ID(s) of the MIDI event(s) to be dropped.<br> |
55 |
[required]</td> |
[optional, default: ID of the event handler's event]</td> |
56 |
</tr> |
</tr> |
57 |
</table> |
</table> |
58 |
|
|
101 |
<note> |
<note> |
102 |
Passing an array of event IDs is only supported by NKSP. If you want |
Passing an array of event IDs is only supported by NKSP. If you want |
103 |
to keep compatibility to KSP, then you should only pass a single |
to keep compatibility to KSP, then you should only pass a single |
104 |
event ID to this function. |
event ID to this function.<br> |
105 |
|
<br> |
106 |
|
Same applies to the optional argument: Dynamic, optional arguments are |
107 |
|
only supported by NKSP. If you want to retain compatibility to KSP, |
108 |
|
then you should always pass a parameter to this function. |
109 |
</note> |
</note> |
110 |
|
|
111 |
</body> |
</body> |