/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3297 by schoenebeck, Wed Jun 28 10:48:30 2017 UTC revision 3396 by schoenebeck, Wed Dec 6 18:53:32 2017 UTC
# Line 11  Line 11 
11      <p>      <p>
12        This document gives you an overview of all built-in functions and built-in        This document gives you an overview of all built-in functions and built-in
13        variables provided by the NKSP real-time instrument script language.        variables provided by the NKSP real-time instrument script language.
14          If you are new to NKSP, then you may want to read the
15          <a href="01_nksp.html">NKSP language tour</a> first.
16      </p>      </p>
17    
18      <h2>Built-In Functions</h2>      <h2>Built-In Functions</h2>
# Line 131  Line 133 
133          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
134        </tr>        </tr>
135        <tr>        <tr>
136            <td><code>change_pan_time()</code></td>
137            <td>Changes the duration of panning (stereo balance) changes.</td>
138          </tr>
139          <tr>
140            <td><code>change_pan_curve()</code></td>
141            <td>Changes the curve type of panning (stereo balance) changes.</td>
142          </tr>
143          <tr>
144          <td><code>change_play_pos()</code></td>          <td><code>change_play_pos()</code></td>
145          <td>Change the sample playback position.</td>          <td>Change the sample playback position.</td>
146        </tr>        </tr>
# Line 168  Line 178 
178        </tr>        </tr>
179        <tr>        <tr>
180          <td><code>change_attack()</code></td>          <td><code>change_attack()</code></td>
181          <td>Modifies the attack time of voices.</td>          <td>Modifies the amplitude attack time of voices.</td>
182        </tr>        </tr>
183        <tr>        <tr>
184          <td><code>change_decay()</code></td>          <td><code>change_decay()</code></td>
185          <td>Modifies the decay time of voices.</td>          <td>Modifies the amplitude decay time of voices.</td>
186          </tr>
187          <tr>
188            <td><code>change_sustain()</code></td>
189            <td>Modifies the amplitude sustain level of voices.</td>
190        </tr>        </tr>
191        <tr>        <tr>
192          <td><code>change_release()</code></td>          <td><code>change_release()</code></td>
193          <td>Modifies the release time of voices.</td>          <td>Modifies the amplitude release time of voices.</td>
194        </tr>        </tr>
195    
196          <tr>
197            <td><code>change_cutoff_attack()</code></td>
198            <td>Modifies the filter cutoff attack time of voices.</td>
199          </tr>
200          <tr>
201            <td><code>change_cutoff_decay()</code></td>
202            <td>Modifies the filter cutoff decay time of voices.</td>
203          </tr>
204          <tr>
205            <td><code>change_cutoff_sustain()</code></td>
206            <td>Modifies the filter cutoff sustain level of voices.</td>
207          </tr>
208          <tr>
209            <td><code>change_cutoff_release()</code></td>
210            <td>Modifies the filter cutoff release time of voices.</td>
211          </tr>
212    
213        <tr>        <tr>
214          <td><code>change_amp_lfo_depth()</code></td>          <td><code>change_amp_lfo_depth()</code></td>
215          <td>Modifies the amplitude LFO depth.</td>          <td>Modifies the amplitude LFO depth.</td>
# Line 186  Line 218 
218          <td><code>change_amp_lfo_freq()</code></td>          <td><code>change_amp_lfo_freq()</code></td>
219          <td>Modifies the amplitude LFO frequency.</td>          <td>Modifies the amplitude LFO frequency.</td>
220        </tr>        </tr>
221    
222          <tr>
223            <td><code>change_cutoff_lfo_depth()</code></td>
224            <td>Modifies the filter cutoff LFO depth.</td>
225          </tr>
226          <tr>
227            <td><code>change_cutoff_lfo_freq()</code></td>
228            <td>Modifies the filter cutoff LFO frequency.</td>
229          </tr>
230    
231        <tr>        <tr>
232          <td><code>change_pitch_lfo_depth()</code></td>          <td><code>change_pitch_lfo_depth()</code></td>
233          <td>Modifies the pitch LFO depth.</td>          <td>Modifies the pitch LFO depth.</td>
# Line 727  Line 769 
769          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
770        </tr>        </tr>
771      </table>      </table>
772    
773            <h2>Built-In Preprocessor Conditions</h2>
774        <p>
775          These are the built-in preprocessor conditions available with the NKSP realt-time
776          instrument script language.
777        </p>
778            
779        <h3>Core Language Preprocessor Conditions</h3>
780        <p>
781          Most fundamental NKSP built-in preprocessor conditions, independent from
782          any purpose of being used in a sampler.
783        </p>
784        <table>
785          <tr>
786            <th>Condition</th> <th>Description</th>
787          </tr>
788          <tr>
789            <td><code>NKSP_NO_MESSAGE</code></td>
790            <td>
791              By default this condition is not set. By explicitly enabling this
792              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
793              causes all subsequent <code>message()</code> calls to be ignored
794              and filtered out on preprocessor level. See function <code>message()</code>
795              for details.
796            </td>
797          </tr>
798        </table>
799    
800    </body>    </body>
801  </html>  </html>
Legend:
Removed from v.3297  
changed lines
  Added in v.3396
  ViewVC Help
Powered by ViewVC