lua_api_master.html

<!DOCTYPE html>

<h1>_G</h1>
<pre><code class="language-lua">_G
</code></pre>
<hr>
<h1>_G</h1>
<hr>
<h1>_VERSION</h1>
<pre><code class="language-lua">string
</code></pre>
<hr>
<h1>accelerometer_event</h1>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>z</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>accelerometer_event</h1>
<pre><code class="language-lua">accelerometer_event
</code></pre>
<pre><code class="language-lua">accelerometer_event
</code></pre>
<hr>
<h1>affectorObj</h1>
<hr>
<h1>affector_color_step</h1>
<pre><code class="language-lua">affector_color_step
</code></pre>
<pre><code class="language-lua">affector_color_step
</code></pre>
<hr>
<h1>affector_color_step</h1>
<h2>[1]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Age</p>
<h2>[2]</h2>
<pre><code class="language-lua">ncine.color
</code></pre>
<p>Color</p>
<hr>
<h1>affector_position_step</h1>
<h2>[1]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Age</p>
<h2>[2]</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>position</p>
<hr>
<h1>affector_position_step</h1>
<pre><code class="language-lua">affector_position_step
</code></pre>
<pre><code class="language-lua">affector_position_step
</code></pre>
<hr>
<h1>affector_rotation_step</h1>
<h2>[1]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Age</p>
<h2>[2]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Angle</p>
<hr>
<h1>affector_rotation_step</h1>
<pre><code class="language-lua">affector_rotation_step
</code></pre>
<pre><code class="language-lua">affector_rotation_step
</code></pre>
<hr>
<h1>affector_size_step</h1>
<h2>[1]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Age</p>
<h2>[2]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Scale</p>
<hr>
<h1>affector_size_step_factor</h1>
<pre><code class="language-lua">affector_size_step
</code></pre>
<pre><code class="language-lua">affector_size_step
</code></pre>
<hr>
<h1>affector_size_step_vector</h1>
<pre><code class="language-lua">affector_size_step
</code></pre>
<pre><code class="language-lua">affector_size_step
</code></pre>
<hr>
<h1>affector_velocity_step</h1>
<pre><code class="language-lua">affector_velocity_step
</code></pre>
<pre><code class="language-lua">affector_velocity_step
</code></pre>
<hr>
<h1>affector_velocity_step</h1>
<h2>[1]</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Age</p>
<h2>[2]</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>Velocity</p>
<hr>
<h1>animatedspriteObj</h1>
<hr>
<h1>any</h1>
<hr>
<h1>arg</h1>
<pre><code class="language-lua">string[]
</code></pre>
<hr>
<h1>assert</h1>
<pre><code class="language-lua">function assert(v?: &lt;T&gt;, message?: any, ...any)
  -&gt; &lt;T&gt;
  2. ...any
</code></pre>
<hr>
<h1>audio_auto_wah_properties</h1>
<pre><code class="language-lua">audio_auto_wah_properties
</code></pre>
<pre><code class="language-lua">audio_auto_wah_properties
</code></pre>
<hr>
<h1>audio_auto_wah_properties</h1>
<h2>attack_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>peak_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>release_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>resonance</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_chorus_properties</h1>
<h2>delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>depth</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>feedback</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>phase</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>rate</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>waveform</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>0 for sinusoid, 1 for triangle</p>
<hr>
<h1>audio_chorus_properties</h1>
<pre><code class="language-lua">audio_chorus_properties
</code></pre>
<pre><code class="language-lua">audio_chorus_properties
</code></pre>
<hr>
<h1>audio_compressor_properties</h1>
<h2>on_off</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>0 or 1</p>
<hr>
<h1>audio_compressor_properties</h1>
<pre><code class="language-lua">audio_compressor_properties
</code></pre>
<pre><code class="language-lua">audio_compressor_properties
</code></pre>
<hr>
<h1>audio_distortion_properties</h1>
<h2>edge</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>eq_bandwidth</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>eq_center</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>lowpass_cutoff</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_distortion_properties</h1>
<pre><code class="language-lua">audio_distortion_properties
</code></pre>
<pre><code class="language-lua">audio_distortion_properties
</code></pre>
<hr>
<h1>audio_eax_reverb_properties</h1>
<h2>air_absorption_gain_hf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>decay_hf_limit</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>decay_hf_ratio</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>decay_lf_ratio</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>decay_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>density</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>diffusion</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>echo_depth</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>echo_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain_hf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain_lf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>hf_reference</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>late_reverb_delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>late_reverb_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>late_reverb_pan</h2>
<pre><code class="language-lua">ncine.vec3
</code></pre>
<p>A three component vector</p>
<h2>lf_reference</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>modulation_depth</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>modulation_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>reflections_delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>reflections_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>reflections_pan</h2>
<pre><code class="language-lua">ncine.vec3
</code></pre>
<p>A three component vector</p>
<h2>room_rolloff_factor</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_eax_reverb_properties</h1>
<pre><code class="language-lua">audio_eax_reverb_properties
</code></pre>
<pre><code class="language-lua">audio_eax_reverb_properties
</code></pre>
<hr>
<h1>audio_echo_properties</h1>
<h2>damping</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>feedback</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>lr_delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>spread</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_echo_properties</h1>
<pre><code class="language-lua">audio_echo_properties
</code></pre>
<pre><code class="language-lua">audio_echo_properties
</code></pre>
<hr>
<h1>audio_equalizer_properties</h1>
<pre><code class="language-lua">audio_equalizer_properties
</code></pre>
<pre><code class="language-lua">audio_equalizer_properties
</code></pre>
<hr>
<h1>audio_equalizer_properties</h1>
<h2>high_cutoff</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>high_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>low_cutoff</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>low_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid1_center</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid1_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid1_width</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid2_center</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid2_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>mid2_width</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_filter_properties</h1>
<h2>gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain_hf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain_lf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>type</h2>
<pre><code class="language-lua">ncine.audio_filter_type
</code></pre>
<p>Audio filter types</p>
<hr>
<h1>audio_filter_properties</h1>
<pre><code class="language-lua">audio_filter_properties
</code></pre>
<pre><code class="language-lua">audio_filter_properties
</code></pre>
<hr>
<h1>audio_flanger_properties</h1>
<h2>delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>depth</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>feedback</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>phase</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>rate</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>waveform</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>0 for sinusoid, 1 for triangle</p>
<hr>
<h1>audio_flanger_properties</h1>
<pre><code class="language-lua">audio_flanger_properties
</code></pre>
<pre><code class="language-lua">audio_flanger_properties
</code></pre>
<hr>
<h1>audio_frequency_shifter_properties</h1>
<pre><code class="language-lua">audio_frequency_shifter_properties
</code></pre>
<pre><code class="language-lua">audio_frequency_shifter_properties
</code></pre>
<hr>
<h1>audio_frequency_shifter_properties</h1>
<h2>frequency</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>left_direction</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From 0 to 2</p>
<h2>right_direction</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From 0 to 2</p>
<hr>
<h1>audio_pitch_shifter_properties</h1>
<h2>coarse_tune</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From -12 to 12</p>
<h2>fineTune</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From -50 to 50</p>
<hr>
<h1>audio_pitch_shifter_properties</h1>
<pre><code class="language-lua">audio_pitch_shifter_properties
</code></pre>
<pre><code class="language-lua">audio_pitch_shifter_properties
</code></pre>
<hr>
<h1>audio_reverb_properties</h1>
<pre><code class="language-lua">audio_reverb_properties
</code></pre>
<pre><code class="language-lua">audio_reverb_properties
</code></pre>
<hr>
<h1>audio_reverb_properties</h1>
<h2>air_absorption_gain_hf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>decay_hf_limit</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>decay_hf_ratio</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>decay_time</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>density</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>diffusion</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>gain_hf</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>late_reverb_delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>late_reverb_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>reflections_delay</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>reflections_gain</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>room_rolloff_factor</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>audio_ring_modulator_properties</h1>
<pre><code class="language-lua">audio_ring_modulator_properties
</code></pre>
<pre><code class="language-lua">audio_ring_modulator_properties
</code></pre>
<hr>
<h1>audio_ring_modulator_properties</h1>
<h2>frequency</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>highpass_cutoff</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>waveform</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>0 for sinusoid, 1 for sawtooth, 2 for square</p>
<hr>
<h1>audio_vocal_morpher_properties</h1>
<h2>phoneme_a</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From 0 to 29 (A to Z)</p>
<h2>phoneme_a_coarse_tuning</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From -24 to 24</p>
<h2>phoneme_b</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From 0 to 29 (A to Z)</p>
<h2>phoneme_b_coarse_tuning</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>From -24 to 24</p>
<h2>rate</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>waveform</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>0 for sinusoid, 1 for triangle, 2 for sawtooth</p>
<hr>
<h1>audio_vocal_morpher_properties</h1>
<pre><code class="language-lua">audio_vocal_morpher_properties
</code></pre>
<pre><code class="language-lua">audio_vocal_morpher_properties
</code></pre>
<hr>
<h1>audiobufferObj</h1>
<hr>
<h1>audiobufferplayerObj</h1>
<hr>
<h1>audioeffectObj</h1>
<hr>
<h1>audioeffectpropertiesObj</h1>
<hr>
<h1>audioeffectslotObj</h1>
<hr>
<h1>audiofilterObj</h1>
<hr>
<h1>audioplayerObj</h1>
<hr>
<h1>audiostreamplayerObj</h1>
<hr>
<h1>basespriteObj</h1>
<hr>
<h1>boolean</h1>
<hr>
<h1>cameraObj</h1>
<hr>
<h1>camera_projection_values</h1>
<h2>bottom</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>left</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>right</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>top</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>camera_view_values</h1>
<h2>rotation</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>scale</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>collectgarbage</h1>
<pre><code class="language-lua">function collectgarbage(opt?: &quot;collect&quot;|&quot;count&quot;|&quot;generational&quot;|&quot;incremental&quot;|&quot;isrunning&quot;...(+3), ...any)
  -&gt; any
</code></pre>
<hr>
<h1>coroutine</h1>
<pre><code class="language-lua">coroutinelib
</code></pre>
<hr>
<h1>coroutine.close</h1>
<pre><code class="language-lua">function coroutine.close(co: thread)
  -&gt; noerror: boolean
  2. errorobject: any
</code></pre>
<hr>
<h1>coroutine.create</h1>
<pre><code class="language-lua">function coroutine.create(f: fun(...any):...unknown)
  -&gt; thread
</code></pre>
<hr>
<h1>coroutine.isyieldable</h1>
<pre><code class="language-lua">function coroutine.isyieldable(co?: thread)
  -&gt; boolean
</code></pre>
<hr>
<h1>coroutine.resume</h1>
<pre><code class="language-lua">function coroutine.resume(co: thread, val1?: any, ...any)
  -&gt; success: boolean
  2. ...any
</code></pre>
<hr>
<h1>coroutine.running</h1>
<pre><code class="language-lua">function coroutine.running()
  -&gt; running: thread
  2. ismain: boolean
</code></pre>
<hr>
<h1>coroutine.status</h1>
<pre><code class="language-lua">function coroutine.status(co: thread)
  -&gt; &quot;dead&quot;|&quot;normal&quot;|&quot;running&quot;|&quot;suspended&quot;
</code></pre>
<hr>
<h1>coroutine.wrap</h1>
<pre><code class="language-lua">function coroutine.wrap(f: fun(...any):...unknown)
  -&gt; fun(...any):...unknown
</code></pre>
<hr>
<h1>coroutine.yield</h1>
<pre><code class="language-lua">(async) function coroutine.yield(...any)
  -&gt; ...any
</code></pre>
<hr>
<h1>coroutinelib</h1>
<h2>close</h2>
<pre><code class="language-lua">function coroutine.close(co: thread)
  -&gt; noerror: boolean
  2. errorobject: any
</code></pre>
<p>Closes coroutine <code>co</code> , closing all its pending to-be-closed variables and putting the coroutine in a dead state.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.close&quot;]">View documents</a></p>
<h2>create</h2>
<pre><code class="language-lua">function coroutine.create(f: fun(...any):...unknown)
  -&gt; thread
</code></pre>
<p>Creates a new coroutine, with body <code>f</code>. <code>f</code> must be a function. Returns this new coroutine, an object with type <code>"thread"</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.create&quot;]">View documents</a></p>
<h2>isyieldable</h2>
<pre><code class="language-lua">function coroutine.isyieldable(co?: thread)
  -&gt; boolean
</code></pre>
<p>Returns true when the coroutine <code>co</code> can yield. The default for <code>co</code> is the running coroutine.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.isyieldable&quot;]">View documents</a></p>
<h2>resume</h2>
<pre><code class="language-lua">function coroutine.resume(co: thread, val1?: any, ...any)
  -&gt; success: boolean
  2. ...any
</code></pre>
<p>Starts or continues the execution of coroutine <code>co</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.resume&quot;]">View documents</a></p>
<h2>running</h2>
<pre><code class="language-lua">function coroutine.running()
  -&gt; running: thread
  2. ismain: boolean
</code></pre>
<p>Returns the running coroutine plus a boolean, true when the running coroutine is the main one.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.running&quot;]">View documents</a></p>
<h2>status</h2>
<pre><code class="language-lua">function coroutine.status(co: thread)
  -&gt; &quot;dead&quot;|&quot;normal&quot;|&quot;running&quot;|&quot;suspended&quot;
</code></pre>
<p>Returns the status of coroutine <code>co</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.status&quot;]">View documents</a></p>
<pre><code class="language-lua">return #1:
    | &quot;running&quot; -- Is running.
    | &quot;suspended&quot; -- Is suspended or not started.
    | &quot;normal&quot; -- Is active but not running.
    | &quot;dead&quot; -- Has finished or stopped with an error.
</code></pre>
<h2>wrap</h2>
<pre><code class="language-lua">function coroutine.wrap(f: fun(...any):...unknown)
  -&gt; fun(...any):...unknown
</code></pre>
<p>Creates a new coroutine, with body <code>f</code>; <code>f</code> must be a function. Returns a function that resumes the coroutine each time it is called.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.wrap&quot;]">View documents</a></p>
<h2>yield</h2>
<pre><code class="language-lua">(async) function coroutine.yield(...any)
  -&gt; ...any
</code></pre>
<p>Suspends the execution of the calling coroutine.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-coroutine.yield&quot;]">View documents</a></p>
<hr>
<h1>debug</h1>
<pre><code class="language-lua">debuglib
</code></pre>
<hr>
<h1>debug.debug</h1>
<pre><code class="language-lua">function debug.debug()
</code></pre>
<hr>
<h1>debug.getfenv</h1>
<pre><code class="language-lua">function debug.getfenv(o: any)
  -&gt; table
</code></pre>
<hr>
<h1>debug.gethook</h1>
<pre><code class="language-lua">function debug.gethook(co?: thread)
  -&gt; hook: function
  2. mask: string
  3. count: integer
</code></pre>
<hr>
<h1>debug.getinfo</h1>
<pre><code class="language-lua">function debug.getinfo(thread: thread, f: integer|fun(...any):...unknown, what?: string|&quot;L&quot;|&quot;S&quot;|&quot;f&quot;|&quot;l&quot;...(+4))
  -&gt; debuginfo
</code></pre>
<hr>
<h1>debug.getlocal</h1>
<pre><code class="language-lua">function debug.getlocal(thread: thread, f: integer|fun(...any):...unknown, index: integer)
  -&gt; name: string
  2. value: any
</code></pre>
<hr>
<h1>debug.getmetatable</h1>
<pre><code class="language-lua">function debug.getmetatable(object: any)
  -&gt; metatable: table
</code></pre>
<hr>
<h1>debug.getregistry</h1>
<pre><code class="language-lua">function debug.getregistry()
  -&gt; table
</code></pre>
<hr>
<h1>debug.getupvalue</h1>
<pre><code class="language-lua">function debug.getupvalue(f: fun(...any):...unknown, up: integer)
  -&gt; name: string
  2. value: any
</code></pre>
<hr>
<h1>debug.getuservalue</h1>
<pre><code class="language-lua">function debug.getuservalue(u: userdata, n?: integer)
  -&gt; any
  2. boolean
</code></pre>
<hr>
<h1>debug.setcstacklimit</h1>
<pre><code class="language-lua">function debug.setcstacklimit(limit: integer)
  -&gt; boolean|integer
</code></pre>
<hr>
<h1>debug.setfenv</h1>
<pre><code class="language-lua">function debug.setfenv(object: &lt;T&gt;, env: table)
  -&gt; object: &lt;T&gt;
</code></pre>
<hr>
<h1>debug.sethook</h1>
<pre><code class="language-lua">function debug.sethook(thread: thread, hook: fun(...any):...unknown, mask: string|&quot;c&quot;|&quot;l&quot;|&quot;r&quot;, count?: integer)
</code></pre>
<hr>
<h1>debug.setlocal</h1>
<pre><code class="language-lua">function debug.setlocal(thread: thread, level: integer, index: integer, value: any)
  -&gt; name: string
</code></pre>
<hr>
<h1>debug.setmetatable</h1>
<pre><code class="language-lua">function debug.setmetatable(value: &lt;T&gt;, meta?: table)
  -&gt; value: &lt;T&gt;
</code></pre>
<hr>
<h1>debug.setupvalue</h1>
<pre><code class="language-lua">function debug.setupvalue(f: fun(...any):...unknown, up: integer, value: any)
  -&gt; name: string
</code></pre>
<hr>
<h1>debug.setuservalue</h1>
<pre><code class="language-lua">function debug.setuservalue(udata: userdata, value: any, n?: integer)
  -&gt; udata: userdata
</code></pre>
<hr>
<h1>debug.traceback</h1>
<pre><code class="language-lua">function debug.traceback(thread: thread, message?: any, level?: integer)
  -&gt; message: string
</code></pre>
<hr>
<h1>debug.upvalueid</h1>
<pre><code class="language-lua">function debug.upvalueid(f: fun(...any):...unknown, n: integer)
  -&gt; id: lightuserdata
</code></pre>
<hr>
<h1>debug.upvaluejoin</h1>
<pre><code class="language-lua">function debug.upvaluejoin(f1: fun(...any):...unknown, n1: integer, f2: fun(...any):...unknown, n2: integer)
</code></pre>
<hr>
<h1>debug_overlay_settings</h1>
<h2>info_text</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if showing the information text</p>
<h2>interface</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if showing the debug interface</p>
<h2>profiler_graphs</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if showing the profiler graphs</p>
<hr>
<h1>debug_overlay_settings</h1>
<pre><code class="language-lua">debug_overlay_settings
</code></pre>
<pre><code class="language-lua">debug_overlay_settings
</code></pre>
<hr>
<h1>debuginfo</h1>
<h2>activelines</h2>
<pre><code class="language-lua">table
</code></pre>
<h2>currentline</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>ftransfer</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>func</h2>
<pre><code class="language-lua">function
</code></pre>
<h2>istailcall</h2>
<pre><code class="language-lua">boolean
</code></pre>
<h2>isvararg</h2>
<pre><code class="language-lua">boolean
</code></pre>
<h2>lastlinedefined</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>linedefined</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>name</h2>
<pre><code class="language-lua">string
</code></pre>
<h2>namewhat</h2>
<pre><code class="language-lua">string
</code></pre>
<h2>nparams</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>ntransfer</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>nups</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>short_src</h2>
<pre><code class="language-lua">string
</code></pre>
<h2>source</h2>
<pre><code class="language-lua">string
</code></pre>
<h2>what</h2>
<pre><code class="language-lua">string
</code></pre>
<hr>
<h1>debuglib</h1>
<h2>debug</h2>
<pre><code class="language-lua">function debug.debug()
</code></pre>
<p>Enters an interactive mode with the user, running each string that the user enters.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.debug&quot;]">View documents</a></p>
<h2>getfenv</h2>
<pre><code class="language-lua">function debug.getfenv(o: any)
  -&gt; table
</code></pre>
<p>Returns the environment of object <code>o</code> .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getfenv&quot;]">View documents</a></p>
<h2>gethook</h2>
<pre><code class="language-lua">function debug.gethook(co?: thread)
  -&gt; hook: function
  2. mask: string
  3. count: integer
</code></pre>
<p>Returns the current hook settings of the thread.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.gethook&quot;]">View documents</a></p>
<h2>getinfo</h2>
<pre><code class="language-lua">function debug.getinfo(thread: thread, f: integer|fun(...any):...unknown, what?: string|&quot;L&quot;|&quot;S&quot;|&quot;f&quot;|&quot;l&quot;...(+4))
  -&gt; debuginfo
</code></pre>
<p>Returns a table with information about a function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getinfo&quot;]">View documents</a></p>
<hr>
<pre><code class="language-lua">what:
   +&gt; &quot;n&quot; -- `name` and `namewhat`
   +&gt; &quot;S&quot; -- `source`, `short_src`, `linedefined`, `lastlinedefined`, and `what`
   +&gt; &quot;l&quot; -- `currentline`
   +&gt; &quot;t&quot; -- `istailcall`
   +&gt; &quot;u&quot; -- `nups`, `nparams`, and `isvararg`
   +&gt; &quot;f&quot; -- `func`
   +&gt; &quot;r&quot; -- `ftransfer` and `ntransfer`
   +&gt; &quot;L&quot; -- `activelines`
</code></pre>
<h2>getlocal</h2>
<pre><code class="language-lua">function debug.getlocal(thread: thread, f: integer|fun(...any):...unknown, index: integer)
  -&gt; name: string
  2. value: any
</code></pre>
<p>Returns the name and the value of the local variable with index <code>local</code> of the function at level <code>f</code> of the stack.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getlocal&quot;]">View documents</a></p>
<h2>getmetatable</h2>
<pre><code class="language-lua">function debug.getmetatable(object: any)
  -&gt; metatable: table
</code></pre>
<p>Returns the metatable of the given value.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getmetatable&quot;]">View documents</a></p>
<h2>getregistry</h2>
<pre><code class="language-lua">function debug.getregistry()
  -&gt; table
</code></pre>
<p>Returns the registry table.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getregistry&quot;]">View documents</a></p>
<h2>getupvalue</h2>
<pre><code class="language-lua">function debug.getupvalue(f: fun(...any):...unknown, up: integer)
  -&gt; name: string
  2. value: any
</code></pre>
<p>Returns the name and the value of the upvalue with index <code>up</code> of the function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getupvalue&quot;]">View documents</a></p>
<h2>getuservalue</h2>
<pre><code class="language-lua">function debug.getuservalue(u: userdata, n?: integer)
  -&gt; any
  2. boolean
</code></pre>
<p>Returns the <code>n</code>-th user value associated
to the userdata <code>u</code> plus a boolean,
<code>false</code> if the userdata does not have that value.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.getuservalue&quot;]">View documents</a></p>
<h2>setcstacklimit</h2>
<pre><code class="language-lua">function debug.setcstacklimit(limit: integer)
  -&gt; boolean|integer
</code></pre>
<h3><strong>Deprecated in <code>Lua 5.4.2</code></strong></h3>
<p>Sets a new limit for the C stack. This limit controls how deeply nested calls can go in Lua, with the intent of avoiding a stack overflow.</p>
<p>In case of success, this function returns the old limit. In case of error, it returns <code>false</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setcstacklimit&quot;]">View documents</a></p>
<h2>setfenv</h2>
<pre><code class="language-lua">function debug.setfenv(object: &lt;T&gt;, env: table)
  -&gt; object: &lt;T&gt;
</code></pre>
<p>Sets the environment of the given <code>object</code> to the given <code>table</code> .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setfenv&quot;]">View documents</a></p>
<h2>sethook</h2>
<pre><code class="language-lua">function debug.sethook(thread: thread, hook: fun(...any):...unknown, mask: string|&quot;c&quot;|&quot;l&quot;|&quot;r&quot;, count?: integer)
</code></pre>
<p>Sets the given function as a hook.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.sethook&quot;]">View documents</a></p>
<hr>
<pre><code class="language-lua">mask:
   +&gt; &quot;c&quot; -- Calls hook when Lua calls a function.
   +&gt; &quot;r&quot; -- Calls hook when Lua returns from a function.
   +&gt; &quot;l&quot; -- Calls hook when Lua enters a new line of code.
</code></pre>
<h2>setlocal</h2>
<pre><code class="language-lua">function debug.setlocal(thread: thread, level: integer, index: integer, value: any)
  -&gt; name: string
</code></pre>
<p>Assigns the <code>value</code> to the local variable with index <code>local</code> of the function at <code>level</code> of the stack.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setlocal&quot;]">View documents</a></p>
<h2>setmetatable</h2>
<pre><code class="language-lua">function debug.setmetatable(value: &lt;T&gt;, meta?: table)
  -&gt; value: &lt;T&gt;
</code></pre>
<p>Sets the metatable for the given value to the given table (which can be <code>nil</code>).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setmetatable&quot;]">View documents</a></p>
<h2>setupvalue</h2>
<pre><code class="language-lua">function debug.setupvalue(f: fun(...any):...unknown, up: integer, value: any)
  -&gt; name: string
</code></pre>
<p>Assigns the <code>value</code> to the upvalue with index <code>up</code> of the function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setupvalue&quot;]">View documents</a></p>
<h2>setuservalue</h2>
<pre><code class="language-lua">function debug.setuservalue(udata: userdata, value: any, n?: integer)
  -&gt; udata: userdata
</code></pre>
<p>Sets the given <code>value</code> as
the <code>n</code>-th user value associated to the given <code>udata</code>.
<code>udata</code> must be a full userdata.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.setuservalue&quot;]">View documents</a></p>
<h2>traceback</h2>
<pre><code class="language-lua">function debug.traceback(thread: thread, message?: any, level?: integer)
  -&gt; message: string
</code></pre>
<p>Returns a string with a traceback of the call stack. The optional message string is appended at the beginning of the traceback.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.traceback&quot;]">View documents</a></p>
<h2>upvalueid</h2>
<pre><code class="language-lua">function debug.upvalueid(f: fun(...any):...unknown, n: integer)
  -&gt; id: lightuserdata
</code></pre>
<p>Returns a unique identifier (as a light userdata) for the upvalue numbered <code>n</code> from the given function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.upvalueid&quot;]">View documents</a></p>
<h2>upvaluejoin</h2>
<pre><code class="language-lua">function debug.upvaluejoin(f1: fun(...any):...unknown, n1: integer, f2: fun(...any):...unknown, n2: integer)
</code></pre>
<p>Make the <code>n1</code>-th upvalue of the Lua closure <code>f1</code> refer to the <code>n2</code>-th upvalue of the Lua closure <code>f2</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-debug.upvaluejoin&quot;]">View documents</a></p>
<hr>
<h1>dofile</h1>
<pre><code class="language-lua">function dofile(filename?: string)
  -&gt; ...any
</code></pre>
<hr>
<h1>drawablenodeObj</h1>
<hr>
<h1>error</h1>
<pre><code class="language-lua">function error(message: any, level?: integer)
</code></pre>
<hr>
<h1>exitcode</h1>
<hr>
<h1>false</h1>
<hr>
<h1>file*</h1>
<h2>close</h2>
<pre><code class="language-lua">(method) file*:close()
  -&gt; suc: boolean?
  2. exitcode: (&quot;exit&quot;|&quot;signal&quot;)?
  3. code: integer?
</code></pre>
<p>Close <code>file</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:close&quot;]">View documents</a></p>
<pre><code class="language-lua">exitcode:
    | &quot;exit&quot;
    | &quot;signal&quot;
</code></pre>
<h2>flush</h2>
<pre><code class="language-lua">(method) file*:flush()
</code></pre>
<p>Saves any written data to <code>file</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:flush&quot;]">View documents</a></p>
<h2>lines</h2>
<pre><code class="language-lua">(method) file*:lines(...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; fun():any, ...unknown
</code></pre>
<hr>
<pre><code class="language-lua">for c in file:lines(...) do
    body
end
</code></pre>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:lines&quot;]">View documents</a></p>
<pre><code class="language-lua">...(param):
    | &quot;n&quot; -- Reads a numeral and returns it as number.
    | &quot;a&quot; -- Reads the whole file.
   -&gt; &quot;l&quot; -- Reads the next line skipping the end of line.
    | &quot;L&quot; -- Reads the next line keeping the end of line.
</code></pre>
<h2>read</h2>
<pre><code class="language-lua">(method) file*:read(...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; any
  2. ...any
</code></pre>
<p>Reads the <code>file</code>, according to the given formats, which specify what to read.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:read&quot;]">View documents</a></p>
<pre><code class="language-lua">...(param):
    | &quot;n&quot; -- Reads a numeral and returns it as number.
    | &quot;a&quot; -- Reads the whole file.
   -&gt; &quot;l&quot; -- Reads the next line skipping the end of line.
    | &quot;L&quot; -- Reads the next line keeping the end of line.
</code></pre>
<h2>seek</h2>
<pre><code class="language-lua">(method) file*:seek(whence?: &quot;cur&quot;|&quot;end&quot;|&quot;set&quot;, offset?: integer)
  -&gt; offset: integer
  2. errmsg: string?
</code></pre>
<p>Sets and gets the file position, measured from the beginning of the file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:seek&quot;]">View documents</a></p>
<pre><code class="language-lua">whence:
    | &quot;set&quot; -- Base is beginning of the file.
   -&gt; &quot;cur&quot; -- Base is current position.
    | &quot;end&quot; -- Base is end of file.
</code></pre>
<h2>setvbuf</h2>
<pre><code class="language-lua">(method) file*:setvbuf(mode: &quot;full&quot;|&quot;line&quot;|&quot;no&quot;, size?: integer)
</code></pre>
<p>Sets the buffering mode for an output file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:setvbuf&quot;]">View documents</a></p>
<pre><code class="language-lua">mode:
    | &quot;no&quot; -- Output operation appears immediately.
    | &quot;full&quot; -- Performed only when the buffer is full.
    | &quot;line&quot; -- Buffered until a newline is output.
</code></pre>
<h2>write</h2>
<pre><code class="language-lua">(method) file*:write(...string|number)
  -&gt; file*?
  2. errmsg: string?
</code></pre>
<p>Writes the value of each of its arguments to <code>file</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-file:write&quot;]">View documents</a></p>
<hr>
<h1>file_date</h1>
<h2>day</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>hour</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>minute</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>month</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>second</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>week_day</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>year</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>filetype</h1>
<hr>
<h1>fontObj</h1>
<hr>
<h1>function</h1>
<hr>
<h1>gcoptions</h1>
<hr>
<h1>getfenv</h1>
<pre><code class="language-lua">function getfenv(f?: integer|fun(...any):...unknown)
  -&gt; table
</code></pre>
<hr>
<h1>getmetatable</h1>
<pre><code class="language-lua">function getmetatable(object: any)
  -&gt; metatable: table
</code></pre>
<hr>
<h1>gui_settings</h1>
<pre><code class="language-lua">gui_settings
</code></pre>
<pre><code class="language-lua">gui_settings
</code></pre>
<hr>
<h1>gui_settings</h1>
<h2>imgui_layer</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>ImGui drawable node layer</p>
<h2>imgui_viewport</h2>
<pre><code class="language-lua">viewportObj
</code></pre>
<p>ImGui viewport</p>
<h2>nuklearLayer</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Nuklear drawable node layer</p>
<h2>nuklear_viewport</h2>
<pre><code class="language-lua">viewportObj
</code></pre>
<p>Nuklear viewport</p>
<hr>
<h1>hookmask</h1>
<hr>
<h1>infowhat</h1>
<hr>
<h1>integer</h1>
<hr>
<h1>io</h1>
<pre><code class="language-lua">iolib
</code></pre>
<hr>
<h1>io.close</h1>
<pre><code class="language-lua">function io.close(file?: file*)
  -&gt; suc: boolean?
  2. exitcode: (&quot;exit&quot;|&quot;signal&quot;)?
  3. code: integer?
</code></pre>
<hr>
<h1>io.flush</h1>
<pre><code class="language-lua">function io.flush()
</code></pre>
<hr>
<h1>io.input</h1>
<pre><code class="language-lua">function io.input(file: string|file*)
</code></pre>
<hr>
<h1>io.lines</h1>
<pre><code class="language-lua">function io.lines(filename?: string, ...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; fun():any, ...unknown
</code></pre>
<hr>
<h1>io.open</h1>
<pre><code class="language-lua">function io.open(filename: string, mode?: &quot;a&quot;|&quot;a+&quot;|&quot;a+b&quot;|&quot;ab&quot;|&quot;r&quot;...(+7))
  -&gt; file*?
  2. errmsg: string?
</code></pre>
<hr>
<h1>io.output</h1>
<pre><code class="language-lua">function io.output(file: string|file*)
</code></pre>
<hr>
<h1>io.popen</h1>
<pre><code class="language-lua">function io.popen(prog: string, mode?: &quot;r&quot;|&quot;w&quot;)
  -&gt; file*?
  2. errmsg: string?
</code></pre>
<hr>
<h1>io.read</h1>
<pre><code class="language-lua">function io.read(...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; any
  2. ...any
</code></pre>
<hr>
<h1>io.tmpfile</h1>
<pre><code class="language-lua">function io.tmpfile()
  -&gt; file*
</code></pre>
<hr>
<h1>io.type</h1>
<pre><code class="language-lua">function io.type(file: file*)
  -&gt; &quot;closed file&quot;|&quot;file&quot;|`nil`
</code></pre>
<hr>
<h1>io.write</h1>
<pre><code class="language-lua">function io.write(...any)
  -&gt; file*
  2. errmsg: string?
</code></pre>
<hr>
<h1>iolib</h1>
<h2>close</h2>
<pre><code class="language-lua">function io.close(file?: file*)
  -&gt; suc: boolean?
  2. exitcode: (&quot;exit&quot;|&quot;signal&quot;)?
  3. code: integer?
</code></pre>
<p>Close <code>file</code> or default output file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.close&quot;]">View documents</a></p>
<pre><code class="language-lua">exitcode:
    | &quot;exit&quot;
    | &quot;signal&quot;
</code></pre>
<h2>flush</h2>
<pre><code class="language-lua">function io.flush()
</code></pre>
<p>Saves any written data to default output file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.flush&quot;]">View documents</a></p>
<h2>input</h2>
<pre><code class="language-lua">function io.input(file: string|file*)
</code></pre>
<p>Sets <code>file</code> as the default input file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.input&quot;]">View documents</a></p>
<h2>lines</h2>
<pre><code class="language-lua">function io.lines(filename?: string, ...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; fun():any, ...unknown
</code></pre>
<hr>
<pre><code class="language-lua">for c in io.lines(filename, ...) do
    body
end
</code></pre>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.lines&quot;]">View documents</a></p>
<pre><code class="language-lua">...(param):
    | &quot;n&quot; -- Reads a numeral and returns it as number.
    | &quot;a&quot; -- Reads the whole file.
   -&gt; &quot;l&quot; -- Reads the next line skipping the end of line.
    | &quot;L&quot; -- Reads the next line keeping the end of line.
</code></pre>
<h2>open</h2>
<pre><code class="language-lua">function io.open(filename: string, mode?: &quot;a&quot;|&quot;a+&quot;|&quot;a+b&quot;|&quot;ab&quot;|&quot;r&quot;...(+7))
  -&gt; file*?
  2. errmsg: string?
</code></pre>
<p>Opens a file, in the mode specified in the string <code>mode</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.open&quot;]">View documents</a></p>
<pre><code class="language-lua">mode:
   -&gt; &quot;r&quot; -- Read mode.
    | &quot;w&quot; -- Write mode.
    | &quot;a&quot; -- Append mode.
    | &quot;r+&quot; -- Update mode, all previous data is preserved.
    | &quot;w+&quot; -- Update mode, all previous data is erased.
    | &quot;a+&quot; -- Append update mode, previous data is preserved, writing is only allowed at the end of file.
    | &quot;rb&quot; -- Read mode. (in binary mode.)
    | &quot;wb&quot; -- Write mode. (in binary mode.)
    | &quot;ab&quot; -- Append mode. (in binary mode.)
    | &quot;r+b&quot; -- Update mode, all previous data is preserved. (in binary mode.)
    | &quot;w+b&quot; -- Update mode, all previous data is erased. (in binary mode.)
    | &quot;a+b&quot; -- Append update mode, previous data is preserved, writing is only allowed at the end of file. (in binary mode.)
</code></pre>
<h2>output</h2>
<pre><code class="language-lua">function io.output(file: string|file*)
</code></pre>
<p>Sets <code>file</code> as the default output file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.output&quot;]">View documents</a></p>
<h2>popen</h2>
<pre><code class="language-lua">function io.popen(prog: string, mode?: &quot;r&quot;|&quot;w&quot;)
  -&gt; file*?
  2. errmsg: string?
</code></pre>
<p>Starts program prog in a separated process.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.popen&quot;]">View documents</a></p>
<pre><code class="language-lua">mode:
    | &quot;r&quot; -- Read data from this program by `file`.
    | &quot;w&quot; -- Write data to this program by `file`.
</code></pre>
<h2>read</h2>
<pre><code class="language-lua">function io.read(...string|integer|&quot;L&quot;|&quot;a&quot;|&quot;l&quot;...(+1))
  -&gt; any
  2. ...any
</code></pre>
<p>Reads the <code>file</code>, according to the given formats, which specify what to read.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.read&quot;]">View documents</a></p>
<pre><code class="language-lua">...(param):
    | &quot;n&quot; -- Reads a numeral and returns it as number.
    | &quot;a&quot; -- Reads the whole file.
   -&gt; &quot;l&quot; -- Reads the next line skipping the end of line.
    | &quot;L&quot; -- Reads the next line keeping the end of line.
</code></pre>
<h2>stderr</h2>
<pre><code class="language-lua">file*
</code></pre>
<p>standard error.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.stderr&quot;]">View documents</a></p>
<h2>stdin</h2>
<pre><code class="language-lua">file*
</code></pre>
<p>standard input.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.stdin&quot;]">View documents</a></p>
<h2>stdout</h2>
<pre><code class="language-lua">file*
</code></pre>
<p>standard output.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.stdout&quot;]">View documents</a></p>
<h2>tmpfile</h2>
<pre><code class="language-lua">function io.tmpfile()
  -&gt; file*
</code></pre>
<p>In case of success, returns a handle for a temporary file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.tmpfile&quot;]">View documents</a></p>
<h2>type</h2>
<pre><code class="language-lua">function io.type(file: file*)
  -&gt; &quot;closed file&quot;|&quot;file&quot;|`nil`
</code></pre>
<p>Checks whether <code>obj</code> is a valid file handle.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.type&quot;]">View documents</a></p>
<pre><code class="language-lua">return #1:
    | &quot;file&quot; -- Is an open file handle.
    | &quot;closed file&quot; -- Is a closed file handle.
    | `nil` -- Is not a file handle.
</code></pre>
<h2>write</h2>
<pre><code class="language-lua">function io.write(...any)
  -&gt; file*
  2. errmsg: string?
</code></pre>
<p>Writes the value of each of its arguments to default output file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-io.write&quot;]">View documents</a></p>
<hr>
<h1>ipairs</h1>
<pre><code class="language-lua">function ipairs(t: &lt;T:table&gt;)
  -&gt; fun(table: &lt;V&gt;[], i?: integer):integer, &lt;V&gt;
  2. &lt;T:table&gt;
  3. i: integer
</code></pre>
<hr>
<h1>is_gui_hidden</h1>
<pre><code class="language-lua">function is_gui_hidden()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function is_gui_hidden()
  -&gt; boolean
</code></pre>
<hr>
<h1>joy_axis_event</h1>
<h2>axis_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>norm_value</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>value</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>joy_axis_event</h1>
<pre><code class="language-lua">joy_axis_event
</code></pre>
<pre><code class="language-lua">joy_axis_event
</code></pre>
<hr>
<h1>joy_button_event</h1>
<pre><code class="language-lua">joy_button_event
</code></pre>
<pre><code class="language-lua">joy_button_event
</code></pre>
<hr>
<h1>joy_button_event</h1>
<h2>button_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>joy_connection_event</h1>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>joy_connection_event</h1>
<pre><code class="language-lua">joy_connection_event
</code></pre>
<pre><code class="language-lua">joy_connection_event
</code></pre>
<hr>
<h1>joy_hat_event</h1>
<pre><code class="language-lua">joy_hat_event
</code></pre>
<pre><code class="language-lua">joy_hat_event
</code></pre>
<hr>
<h1>joy_hat_event</h1>
<h2>hat_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>hat_state</h2>
<pre><code class="language-lua">ncine.joy_hat_state
</code></pre>
<p>Joystick hat states</p>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>joy_mapped_axis_event</h1>
<pre><code class="language-lua">joymapped_axis_event
</code></pre>
<pre><code class="language-lua">joymapped_axis_event
</code></pre>
<hr>
<h1>joy_mapped_button_event</h1>
<pre><code class="language-lua">joymapped_button_event
</code></pre>
<pre><code class="language-lua">joymapped_button_event
</code></pre>
<hr>
<h1>joymapped_axis_event</h1>
<h2>axis</h2>
<pre><code class="language-lua">ncine.joy_axis
</code></pre>
<p>Joystick axis names</p>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>value</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>joymapped_button_event</h1>
<h2>button</h2>
<pre><code class="language-lua">ncine.joy_button
</code></pre>
<p>Joystick button names</p>
<h2>joy_id</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>joymappedstateObj</h1>
<hr>
<h1>joystickstateObj</h1>
<hr>
<h1>keyboard_event</h1>
<h2>mod</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>scancode</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>sym</h2>
<pre><code class="language-lua">integer
</code></pre>
<hr>
<h1>keyboard_event</h1>
<pre><code class="language-lua">keyboard_event
</code></pre>
<pre><code class="language-lua">keyboard_event
</code></pre>
<hr>
<h1>keystateObj</h1>
<hr>
<h1>lightuserdata</h1>
<hr>
<h1>load</h1>
<pre><code class="language-lua">function load(chunk: string|function, chunkname?: string, mode?: &quot;b&quot;|&quot;bt&quot;|&quot;t&quot;, env?: table)
  -&gt; function?
  2. error_message: string?
</code></pre>
<hr>
<h1>loadfile</h1>
<pre><code class="language-lua">function loadfile(filename?: string, mode?: &quot;b&quot;|&quot;bt&quot;|&quot;t&quot;, env?: table)
  -&gt; function?
  2. error_message: string?
</code></pre>
<hr>
<h1>loadmode</h1>
<hr>
<h1>loadstring</h1>
<pre><code class="language-lua">function loadstring(text: string, chunkname?: string)
  -&gt; function?
  2. error_message: string?
</code></pre>
<hr>
<h1>localecategory</h1>
<hr>
<h1>math</h1>
<pre><code class="language-lua">mathlib
</code></pre>
<hr>
<h1>math.abs</h1>
<pre><code class="language-lua">function math.abs(x: &lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<hr>
<h1>math.acos</h1>
<pre><code class="language-lua">function math.acos(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.asin</h1>
<pre><code class="language-lua">function math.asin(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.atan</h1>
<pre><code class="language-lua">function math.atan(y: number, x?: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.atan2</h1>
<pre><code class="language-lua">function math.atan2(y: number, x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.ceil</h1>
<pre><code class="language-lua">function math.ceil(x: number)
  -&gt; integer
</code></pre>
<hr>
<h1>math.cos</h1>
<pre><code class="language-lua">function math.cos(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.cosh</h1>
<pre><code class="language-lua">function math.cosh(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.deg</h1>
<pre><code class="language-lua">function math.deg(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.exp</h1>
<pre><code class="language-lua">function math.exp(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.floor</h1>
<pre><code class="language-lua">function math.floor(x: number)
  -&gt; integer
</code></pre>
<hr>
<h1>math.fmod</h1>
<pre><code class="language-lua">function math.fmod(x: number, y: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.frexp</h1>
<pre><code class="language-lua">function math.frexp(x: number)
  -&gt; m: number
  2. e: number
</code></pre>
<hr>
<h1>math.ldexp</h1>
<pre><code class="language-lua">function math.ldexp(m: number, e: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.log</h1>
<pre><code class="language-lua">function math.log(x: number, base?: integer)
  -&gt; number
</code></pre>
<hr>
<h1>math.log10</h1>
<pre><code class="language-lua">function math.log10(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.max</h1>
<pre><code class="language-lua">function math.max(x: &lt;Number:number&gt;, ...&lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<hr>
<h1>math.min</h1>
<pre><code class="language-lua">function math.min(x: &lt;Number:number&gt;, ...&lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<hr>
<h1>math.modf</h1>
<pre><code class="language-lua">function math.modf(x: number)
  -&gt; integer
  2. number
</code></pre>
<hr>
<h1>math.pow</h1>
<pre><code class="language-lua">function math.pow(x: number, y: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.rad</h1>
<pre><code class="language-lua">function math.rad(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.random</h1>
<pre><code class="language-lua">function math.random(m: integer, n: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>math.randomseed</h1>
<pre><code class="language-lua">function math.randomseed(x?: integer, y?: integer)
</code></pre>
<hr>
<h1>math.sin</h1>
<pre><code class="language-lua">function math.sin(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.sinh</h1>
<pre><code class="language-lua">function math.sinh(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.sqrt</h1>
<pre><code class="language-lua">function math.sqrt(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.tan</h1>
<pre><code class="language-lua">function math.tan(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.tanh</h1>
<pre><code class="language-lua">function math.tanh(x: number)
  -&gt; number
</code></pre>
<hr>
<h1>math.tointeger</h1>
<pre><code class="language-lua">function math.tointeger(x: any)
  -&gt; integer?
</code></pre>
<hr>
<h1>math.type</h1>
<pre><code class="language-lua">function math.type(x: any)
  -&gt; &quot;float&quot;|&quot;integer&quot;|'nil'
</code></pre>
<hr>
<h1>math.ult</h1>
<pre><code class="language-lua">function math.ult(m: integer, n: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>mathlib</h1>
<h2>abs</h2>
<pre><code class="language-lua">function math.abs(x: &lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<p>Returns the absolute value of <code>x</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.abs&quot;]">View documents</a></p>
<h2>acos</h2>
<pre><code class="language-lua">function math.acos(x: number)
  -&gt; number
</code></pre>
<p>Returns the arc cosine of <code>x</code> (in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.acos&quot;]">View documents</a></p>
<h2>asin</h2>
<pre><code class="language-lua">function math.asin(x: number)
  -&gt; number
</code></pre>
<p>Returns the arc sine of <code>x</code> (in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.asin&quot;]">View documents</a></p>
<h2>atan</h2>
<pre><code class="language-lua">function math.atan(y: number, x?: number)
  -&gt; number
</code></pre>
<p>Returns the arc tangent of <code>y/x</code> (in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.atan&quot;]">View documents</a></p>
<h2>atan2</h2>
<pre><code class="language-lua">function math.atan2(y: number, x: number)
  -&gt; number
</code></pre>
<p>Returns the arc tangent of <code>y/x</code> (in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.atan2&quot;]">View documents</a></p>
<h2>ceil</h2>
<pre><code class="language-lua">function math.ceil(x: number)
  -&gt; integer
</code></pre>
<p>Returns the smallest integral value larger than or equal to <code>x</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.ceil&quot;]">View documents</a></p>
<h2>cos</h2>
<pre><code class="language-lua">function math.cos(x: number)
  -&gt; number
</code></pre>
<p>Returns the cosine of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.cos&quot;]">View documents</a></p>
<h2>cosh</h2>
<pre><code class="language-lua">function math.cosh(x: number)
  -&gt; number
</code></pre>
<p>Returns the hyperbolic cosine of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.cosh&quot;]">View documents</a></p>
<h2>deg</h2>
<pre><code class="language-lua">function math.deg(x: number)
  -&gt; number
</code></pre>
<p>Converts the angle <code>x</code> from radians to degrees.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.deg&quot;]">View documents</a></p>
<h2>exp</h2>
<pre><code class="language-lua">function math.exp(x: number)
  -&gt; number
</code></pre>
<p>Returns the value <code>e^x</code> (where <code>e</code> is the base of natural logarithms).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.exp&quot;]">View documents</a></p>
<h2>floor</h2>
<pre><code class="language-lua">function math.floor(x: number)
  -&gt; integer
</code></pre>
<p>Returns the largest integral value smaller than or equal to <code>x</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.floor&quot;]">View documents</a></p>
<h2>fmod</h2>
<pre><code class="language-lua">function math.fmod(x: number, y: number)
  -&gt; number
</code></pre>
<p>Returns the remainder of the division of <code>x</code> by <code>y</code> that rounds the quotient towards zero.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.fmod&quot;]">View documents</a></p>
<h2>frexp</h2>
<pre><code class="language-lua">function math.frexp(x: number)
  -&gt; m: number
  2. e: number
</code></pre>
<p>Decompose <code>x</code> into tails and exponents. Returns <code>m</code> and <code>e</code> such that <code>x = m * (2 ^ e)</code>, <code>e</code> is an integer and the absolute value of <code>m</code> is in the range [0.5, 1) (or zero when <code>x</code> is zero).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.frexp&quot;]">View documents</a></p>
<h2>huge</h2>
<pre><code class="language-lua">number
</code></pre>
<p>A value larger than any other numeric value.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.huge&quot;]">View documents</a></p>
<h2>ldexp</h2>
<pre><code class="language-lua">function math.ldexp(m: number, e: number)
  -&gt; number
</code></pre>
<p>Returns <code>m * (2 ^ e)</code> .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.ldexp&quot;]">View documents</a></p>
<h2>log</h2>
<pre><code class="language-lua">function math.log(x: number, base?: integer)
  -&gt; number
</code></pre>
<p>Returns the logarithm of <code>x</code> in the given base.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.log&quot;]">View documents</a></p>
<h2>log10</h2>
<pre><code class="language-lua">function math.log10(x: number)
  -&gt; number
</code></pre>
<p>Returns the base-10 logarithm of x.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.log10&quot;]">View documents</a></p>
<h2>max</h2>
<pre><code class="language-lua">function math.max(x: &lt;Number:number&gt;, ...&lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<p>Returns the argument with the maximum value, according to the Lua operator <code>&lt;</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.max&quot;]">View documents</a></p>
<h2>maxinteger</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Miss locale <math.maxinteger></p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.maxinteger&quot;]">View documents</a></p>
<h2>min</h2>
<pre><code class="language-lua">function math.min(x: &lt;Number:number&gt;, ...&lt;Number:number&gt;)
  -&gt; &lt;Number:number&gt;
</code></pre>
<p>Returns the argument with the minimum value, according to the Lua operator <code>&lt;</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.min&quot;]">View documents</a></p>
<h2>mininteger</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Miss locale <math.mininteger></p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.mininteger&quot;]">View documents</a></p>
<h2>modf</h2>
<pre><code class="language-lua">function math.modf(x: number)
  -&gt; integer
  2. number
</code></pre>
<p>Returns the integral part of <code>x</code> and the fractional part of <code>x</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.modf&quot;]">View documents</a></p>
<h2>pi</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The value of <em>π</em>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.pi&quot;]">View documents</a></p>
<h2>pow</h2>
<pre><code class="language-lua">function math.pow(x: number, y: number)
  -&gt; number
</code></pre>
<p>Returns <code>x ^ y</code> .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.pow&quot;]">View documents</a></p>
<h2>rad</h2>
<pre><code class="language-lua">function math.rad(x: number)
  -&gt; number
</code></pre>
<p>Converts the angle <code>x</code> from degrees to radians.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.rad&quot;]">View documents</a></p>
<h2>random</h2>
<pre><code class="language-lua">function math.random(m: integer, n: integer)
  -&gt; integer
</code></pre>
<ul>
<li><code>math.random()</code>: Returns a float in the range [0,1).</li>
<li><code>math.random(n)</code>: Returns a integer in the range [1, n].</li>
<li><code>math.random(m, n)</code>: Returns a integer in the range [m, n].</li>
</ul>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.random&quot;]">View documents</a></p>
<h2>randomseed</h2>
<pre><code class="language-lua">function math.randomseed(x?: integer, y?: integer)
</code></pre>
<ul>
<li><code>math.randomseed(x, y)</code>: Concatenate <code>x</code> and <code>y</code> into a 128-bit <code>seed</code> to reinitialize the pseudo-random generator.</li>
<li><code>math.randomseed(x)</code>: Equate to <code>math.randomseed(x, 0)</code> .</li>
<li><code>math.randomseed()</code>: Generates a seed with a weak attempt for randomness.</li>
</ul>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.randomseed&quot;]">View documents</a></p>
<h2>sin</h2>
<pre><code class="language-lua">function math.sin(x: number)
  -&gt; number
</code></pre>
<p>Returns the sine of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.sin&quot;]">View documents</a></p>
<h2>sinh</h2>
<pre><code class="language-lua">function math.sinh(x: number)
  -&gt; number
</code></pre>
<p>Returns the hyperbolic sine of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.sinh&quot;]">View documents</a></p>
<h2>sqrt</h2>
<pre><code class="language-lua">function math.sqrt(x: number)
  -&gt; number
</code></pre>
<p>Returns the square root of <code>x</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.sqrt&quot;]">View documents</a></p>
<h2>tan</h2>
<pre><code class="language-lua">function math.tan(x: number)
  -&gt; number
</code></pre>
<p>Returns the tangent of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.tan&quot;]">View documents</a></p>
<h2>tanh</h2>
<pre><code class="language-lua">function math.tanh(x: number)
  -&gt; number
</code></pre>
<p>Returns the hyperbolic tangent of <code>x</code> (assumed to be in radians).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.tanh&quot;]">View documents</a></p>
<h2>tointeger</h2>
<pre><code class="language-lua">function math.tointeger(x: any)
  -&gt; integer?
</code></pre>
<p>Miss locale <math.tointeger></p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.tointeger&quot;]">View documents</a></p>
<h2>type</h2>
<pre><code class="language-lua">function math.type(x: any)
  -&gt; &quot;float&quot;|&quot;integer&quot;|'nil'
</code></pre>
<p>Miss locale <math.type></p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.type&quot;]">View documents</a></p>
<pre><code class="language-lua">return #1:
    | &quot;integer&quot;
    | &quot;float&quot;
    | 'nil'
</code></pre>
<h2>ult</h2>
<pre><code class="language-lua">function math.ult(m: integer, n: integer)
  -&gt; boolean
</code></pre>
<p>Miss locale <math.ult></p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-math.ult&quot;]">View documents</a></p>
<hr>
<h1>mesh_sprite_vertex</h1>
<h2>u</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>v</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>mesh_sprite_vertex</h1>
<pre><code class="language-lua">mesh_sprite_vertex
</code></pre>
<pre><code class="language-lua">mesh_sprite_vertex
</code></pre>
<hr>
<h1>mesh_sprite_vertex_notexture</h1>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>mesh_sprite_vertex_notexture</h1>
<pre><code class="language-lua">mesh_sprite_vertex_notexture
</code></pre>
<pre><code class="language-lua">mesh_sprite_vertex_notexture
</code></pre>
<hr>
<h1>meshspriteObj</h1>
<hr>
<h1>metatable</h1>
<h2>__add</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__band</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__bnot</h2>
<pre><code class="language-lua">fun(t: any):any|nil
</code></pre>
<h2>__bor</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__bxor</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__call</h2>
<pre><code class="language-lua">fun(t: any, ...any):...unknown|nil
</code></pre>
<h2>__close</h2>
<pre><code class="language-lua">fun(t: any, errobj: any):any|nil
</code></pre>
<h2>__concat</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__div</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__eq</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):boolean|nil
</code></pre>
<h2>__gc</h2>
<pre><code class="language-lua">fun(t: any)|nil
</code></pre>
<h2>__idiv</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__index</h2>
<pre><code class="language-lua">table|fun(t: any, k: any):any|nil
</code></pre>
<h2>__le</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):boolean|nil
</code></pre>
<h2>__len</h2>
<pre><code class="language-lua">fun(t: any):integer|nil
</code></pre>
<h2>__lt</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):boolean|nil
</code></pre>
<h2>__metatable</h2>
<pre><code class="language-lua">any
</code></pre>
<h2>__mod</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__mode</h2>
<pre><code class="language-lua">'k'|'kv'|'v'|nil
</code></pre>
<h2>__mul</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__newindex</h2>
<pre><code class="language-lua">table|fun(t: any, k: any, v: any)|nil
</code></pre>
<h2>__pairs</h2>
<pre><code class="language-lua">fun(t: any):fun(t: any, k: any, v: any):any, any, any, any|nil
</code></pre>
<h2>__pow</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__shl</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__shr</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__sub</h2>
<pre><code class="language-lua">fun(t1: any, t2: any):any|nil
</code></pre>
<h2>__tostring</h2>
<pre><code class="language-lua">fun(t: any):string|nil
</code></pre>
<h2>__unm</h2>
<pre><code class="language-lua">fun(t: any):any|nil
</code></pre>
<hr>
<h1>module</h1>
<pre><code class="language-lua">function module(name: string, ...any)
</code></pre>
<hr>
<h1>monitor</h1>
<h2>dpi</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>The horizontal and vertical dots per inch</p>
<h2>name</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The monitor name</p>
<h2>num_video_modes</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of video modes in the array</p>
<h2>position</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>The position of the monitor's viewport on the virtual screen</p>
<h2>scale</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>The content scale factor</p>
<h2>video_modes</h2>
<pre><code class="language-lua">video_mode[]
</code></pre>
<p>The array of supported video modes</p>
<hr>
<h1>monitor</h1>
<pre><code class="language-lua">monitor
</code></pre>
<pre><code class="language-lua">monitor
</code></pre>
<hr>
<h1>mouse_event</h1>
<pre><code class="language-lua">mouse_event
</code></pre>
<pre><code class="language-lua">mouse_event
</code></pre>
<hr>
<h1>mouse_event</h1>
<h2>button</h2>
<pre><code class="language-lua">ncine.mouse_button
</code></pre>
<p>Mouse buttons</p>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>mouse_state</h1>
<pre><code class="language-lua">mouse_state
</code></pre>
<pre><code class="language-lua">mouse_state
</code></pre>
<hr>
<h1>mouse_state</h1>
<h2>fifth_pressed</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>It is <code>true</code> if the fifth mouse button is pressed</p>
<h2>fourth_pressed</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>It is <code>true</code> if the fourth mouse button is pressed</p>
<h2>left_pressed</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>It is <code>true</code> if the left mouse button is pressed</p>
<h2>middle_pressed</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>It is <code>true</code> if the middle mouse button is pressed</p>
<h2>right_pressed</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>TIt is <code>true</code> if the right mouse button is pressed</p>
<h2>x</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Pointer position on the X axis</p>
<h2>y</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Pointer position on the Y axis</p>
<hr>
<h1>ncine</h1>
<h2>ANDROID</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on Android</p>
<h2>DEBUG</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if linked with a debug build of the nCine library</p>
<h2>EMSCRIPTEN</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on the web via Emscripten</p>
<h2>LINUX</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on Linux</p>
<h2>MACOS</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on macOS</p>
<h2>MINGW</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on MinGW</p>
<h2>WINDOWS</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if running on Windows</p>
<h2>_GITBRANCH</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The git branch</p>
<h2>_GITLATCOMMITDATE</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The git last commit date</p>
<h2>_GITREVCOUNT</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The git revision count</p>
<h2>_GITSHORTHASH</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The git short hash</p>
<h2>_GITTAG</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The git tag</p>
<h2>_VERSION</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The version string</p>
<h2>affector_type</h2>
<pre><code class="language-lua">enum ncine.affector_type
</code></pre>
<h2>animated_sprite</h2>
<pre><code class="language-lua">ncine.animated_sprite
</code></pre>
<p>The table containing animated sprite related functions</p>
<h2>app_onfiguration</h2>
<pre><code class="language-lua">ncine.app_configuration
</code></pre>
<p>The application configuration table</p>
<h2>application</h2>
<pre><code class="language-lua">ncine.application
</code></pre>
<p>The table containing application related functions</p>
<h2>audio_device</h2>
<pre><code class="language-lua">ncine.audio_device
</code></pre>
<p>The table containing the audio device related functions</p>
<h2>audio_effect</h2>
<pre><code class="language-lua">ncine.audio_effect
</code></pre>
<p>The table containing audio effect related functions</p>
<h2>audio_effect_properties</h2>
<pre><code class="language-lua">ncine.audio_effect_properties
</code></pre>
<p>The table containing audio effect properties related functions</p>
<h2>audio_effect_slot</h2>
<pre><code class="language-lua">ncine.audio_effect_slot
</code></pre>
<p>The table containing audio effect slot related functions</p>
<h2>audio_effect_type</h2>
<pre><code class="language-lua">enum ncine.audio_effect_type
</code></pre>
<h2>audio_filter</h2>
<pre><code class="language-lua">ncine.audio_filter
</code></pre>
<p>The table containing audio filter related functions</p>
<h2>audio_filter_type</h2>
<pre><code class="language-lua">enum ncine.audio_filter_type
</code></pre>
<h2>audio_player</h2>
<pre><code class="language-lua">ncine.audio_player
</code></pre>
<p>The table containing audio player related functions</p>
<h2>audiobuffer</h2>
<pre><code class="language-lua">ncine.audiobuffer
</code></pre>
<p>The table containing audio buffer related functions</p>
<h2>audiobuffer_player</h2>
<pre><code class="language-lua">ncine.audiobuffer_player
</code></pre>
<p>The table containing audio buffer player related functions</p>
<h2>audiostream_player</h2>
<pre><code class="language-lua">ncine.audiostream_player
</code></pre>
<p>The table containing audio stream player related functions</p>
<h2>base_sprite</h2>
<pre><code class="language-lua">ncine.base_sprite
</code></pre>
<p>The table containing base sprite related functions</p>
<h2>blending_factor</h2>
<pre><code class="language-lua">enum ncine.blending_factor
</code></pre>
<h2>blending_preset</h2>
<pre><code class="language-lua">enum ncine.blending_preset
</code></pre>
<h2>camera</h2>
<pre><code class="language-lua">ncine.camera
</code></pre>
<p>The table containing camera related functions</p>
<h2>clear_mode</h2>
<pre><code class="language-lua">enum ncine.clear_mode
</code></pre>
<h2>color</h2>
<pre><code class="language-lua">ncine.color
</code></pre>
<p>A RGBA color</p>
<h2>colors</h2>
<pre><code class="language-lua">table
</code></pre>
<h2>depth_stencil_format</h2>
<pre><code class="language-lua">enum ncine.depth_stencil_format
</code></pre>
<h2>drawable_node</h2>
<pre><code class="language-lua">ncine.drawable_node
</code></pre>
<p>The table containing drawable node related functions</p>
<h2>efx_reverb_presets</h2>
<pre><code class="language-lua">enum ncine.efx_reverb_presets
</code></pre>
<h2>font</h2>
<pre><code class="language-lua">ncine.font
</code></pre>
<p>The table containing font related functions</p>
<h2>font_render_mode</h2>
<pre><code class="language-lua">enum ncine.font_render_mode
</code></pre>
<h2>frame_timer</h2>
<pre><code class="language-lua">ncine.frame_timer
</code></pre>
<p>The table containing frame timer related functions</p>
<h2>fs</h2>
<pre><code class="language-lua">ncine.fs
</code></pre>
<p>The table containing filesystem related functions</p>
<h2>gfx_device</h2>
<pre><code class="language-lua">ncine.gfx_device
</code></pre>
<p>The table containing the graphics device related functions</p>
<h2>hash64</h2>
<pre><code class="language-lua">table
</code></pre>
<p>Utility methods to calculate a 64bit hash from strings or files</p>
<h2>input</h2>
<pre><code class="language-lua">ncine.input
</code></pre>
<p>The table containing the input manager related functions</p>
<h2>joy_axis</h2>
<pre><code class="language-lua">enum ncine.joy_axis
</code></pre>
<h2>joy_button</h2>
<pre><code class="language-lua">enum ncine.joy_button
</code></pre>
<h2>joy_dead_zone</h2>
<pre><code class="language-lua">table
</code></pre>
<p>Joystick dead zone values for various axes</p>
<p>From <code>XInput.h</code> in DirectX SDK</p>
<h2>joy_hat_state</h2>
<pre><code class="language-lua">enum ncine.joy_hat_state
</code></pre>
<h2>keymod</h2>
<pre><code class="language-lua">enum ncine.keymod
</code></pre>
<h2>keysym</h2>
<pre><code class="language-lua">enum ncine.keysym
</code></pre>
<h2>log</h2>
<pre><code class="language-lua">ncine.log
</code></pre>
<p>The logging class</p>
<h2>log_level</h2>
<pre><code class="language-lua">enum ncine.log_level
</code></pre>
<h2>loop_mode</h2>
<pre><code class="language-lua">enum ncine.loop_mode
</code></pre>
<h2>mesh_sprite</h2>
<pre><code class="language-lua">ncine.mesh_sprite
</code></pre>
<p>The table containing mesh sprite related functions</p>
<h2>mouse_button</h2>
<pre><code class="language-lua">enum ncine.mouse_button
</code></pre>
<h2>mouse_cursor_mode</h2>
<pre><code class="language-lua">enum ncine.mouse_cursor_mode
</code></pre>
<h2>on_acceleration</h2>
<pre><code class="language-lua">function ncine.on_acceleration(event: accelerometer_event)
</code></pre>
<p>Callback function called at fixed time with the updated reading from the accelerometer sensor</p>
<h2>on_change_scaling_factor</h2>
<pre><code class="language-lua">function ncine.on_change_scaling_factor(factor: number)
</code></pre>
<p>A callback that is called every time the window scaling factor changes</p>
<p>@<em>param</em> <code>factor</code> — The new scaling factor</p>
<h2>on_draw_viewport</h2>
<pre><code class="language-lua">function ncine.on_draw_viewport(viewport: viewportObj)
</code></pre>
<p>A callback that is called every time a viewport is going to be drawn</p>
<p>@<em>param</em> <code>viewport</code> — The viewport currently being drawn</p>
<h2>on_frame_end</h2>
<pre><code class="language-lua">function ncine.on_frame_end()
</code></pre>
<p>A callback that is called at the end of each frame, just before swapping drawing buffers</p>
<h2>on_frame_start</h2>
<pre><code class="language-lua">function ncine.on_frame_start()
</code></pre>
<p>A callback that is called every time a new frame starts</p>
<h2>on_init</h2>
<pre><code class="language-lua">function ncine.on_init()
</code></pre>
<p>A callback that is called once, after the nCine has been initialized.</p>
<p>It can be used to construct the object required by the scene.</p>
<h2>on_joy_axis_moved</h2>
<pre><code class="language-lua">function ncine.on_joy_axis_moved(event: joy_axis_event)
</code></pre>
<p>Callback function called every time a joystick axis is moved</p>
<h2>on_joy_button_pressed</h2>
<pre><code class="language-lua">function ncine.on_joy_button_pressed(event: joy_button_event)
</code></pre>
<p>Callback function called every time a joystick button is pressed</p>
<h2>on_joy_button_released</h2>
<pre><code class="language-lua">function ncine.on_joy_button_released(event: joy_button_event)
</code></pre>
<p>Callback function called every time a joystick button is released</p>
<h2>on_joy_connected</h2>
<pre><code class="language-lua">function ncine.on_joy_connected(event: joy_connection_event)
</code></pre>
<p>Callback function called every time a joystick is connected</p>
<h2>on_joy_disconnected</h2>
<pre><code class="language-lua">function ncine.on_joy_disconnected(event: joy_connection_event)
</code></pre>
<p>Callback function called every time a joystick is disconnected</p>
<h2>on_joy_hat_moved</h2>
<pre><code class="language-lua">function ncine.on_joy_hat_moved(event: joy_hat_event)
</code></pre>
<p>Callback function called every time a joystick hat is moved</p>
<h2>on_joymapped_axis_moved</h2>
<pre><code class="language-lua">function ncine.on_joymapped_axis_moved(event: joymapped_axis_event)
</code></pre>
<p>Callback function called every time an axis of a joystick with mapping is moved</p>
<h2>on_joymapped_button_pressed</h2>
<pre><code class="language-lua">function ncine.on_joymapped_button_pressed(event: joymapped_button_event)
</code></pre>
<p>Callback function called every time a button of a joystick with mapping is pressed</p>
<h2>on_joymapped_button_released</h2>
<pre><code class="language-lua">function ncine.on_joymapped_button_released(event: joymapped_button_event)
</code></pre>
<p>Callback function called every time a button of a joystick with mapping is released</p>
<h2>on_key_pressed</h2>
<pre><code class="language-lua">function ncine.on_key_pressed(event: keyboard_event)
</code></pre>
<p>Callback function called every time a key is pressed</p>
<h2>on_key_released</h2>
<pre><code class="language-lua">function ncine.on_key_released(event: keyboard_event)
</code></pre>
<p>Callback function called every time a key is released</p>
<h2>on_mouse_button_pressed</h2>
<pre><code class="language-lua">function ncine.on_mouse_button_pressed(event: mouse_event)
</code></pre>
<p>Callback function called every time a mouse button is pressed</p>
<h2>on_mouse_button_released</h2>
<pre><code class="language-lua">function ncine.on_mouse_button_released(event: mouse_event)
</code></pre>
<p>Callback function called every time a mouse button is released</p>
<h2>on_mouse_moved</h2>
<pre><code class="language-lua">function ncine.on_mouse_moved(event: mouse_state)
</code></pre>
<p>Callback function called every time the mouse is moved</p>
<h2>on_pointer_down</h2>
<pre><code class="language-lua">function ncine.on_pointer_down(event: touch_event)
</code></pre>
<p>Callback function called every time a screen touch different than the first one is made</p>
<h2>on_pointer_up</h2>
<pre><code class="language-lua">function ncine.on_pointer_up(event: touch_event)
</code></pre>
<p>Callback function called every time a screen touch different than the last one is released</p>
<h2>on_post_update</h2>
<pre><code class="language-lua">function ncine.on_post_update()
</code></pre>
<p>A callback that is called every time the scenegraph has been traversed and all nodes have been transformed</p>
<h2>on_pre_init</h2>
<pre><code class="language-lua">function ncine.on_pre_init(cfg: ncine.app_configuration)
</code></pre>
<p>A callback that is called once, before the nCine is initialized.</p>
<p>It can be used to change the initialization settings.</p>
<p>@<em>param</em> <code>cfg</code> — The configuration table</p>
<h2>on_quit_request</h2>
<pre><code class="language-lua">function ncine.on_quit_request()
  -&gt; boolean
</code></pre>
<p>Callback function called when the system sends a quit event, for example when the user clicks the window close button</p>
<p>Returns <code>true</code> if the application should quit</p>
<h2>on_resize_window</h2>
<pre><code class="language-lua">function ncine.on_resize_window(width: integer, height: integer)
</code></pre>
<p>A callback that is called every time the window is resized (by the system or the user)</p>
<p>@<em>param</em> <code>width</code> — The new width of the window</p>
<p>@<em>param</em> <code>height</code> — The new height of the window</p>
<h2>on_resume</h2>
<pre><code class="language-lua">function ncine.on_resume()
</code></pre>
<p>A callback that is called every time the application resumes from suspension</p>
<h2>on_scroll_input</h2>
<pre><code class="language-lua">function ncine.on_scroll_input(event: scroll_event)
</code></pre>
<p>Callback function called every time a scroll input occurs (mouse wheel, touchpad gesture, etc.)</p>
<h2>on_shutdown</h2>
<pre><code class="language-lua">function ncine.on_shutdown()
</code></pre>
<p>A callback that is called once, before the nCine shuts down</p>
<p>It can be used to destroy objects constructed in <code>ncine.on_init()</code></p>
<h2>on_suspend</h2>
<pre><code class="language-lua">function ncine.on_suspend()
</code></pre>
<p>A callback that is called every time the application needs to be suspended</p>
<h2>on_text_input</h2>
<pre><code class="language-lua">function ncine.on_text_input(event: text_input_event)
</code></pre>
<p>Callback function called every time a text input is generated</p>
<h2>on_touch_down</h2>
<pre><code class="language-lua">function ncine.on_touch_down(event: touch_event)
</code></pre>
<p>Callback function called every time the first screen touch is made</p>
<h2>on_touch_move</h2>
<pre><code class="language-lua">function ncine.on_touch_move(event: touch_event)
</code></pre>
<p>Callback function called every time a screen touch is moved</p>
<h2>on_touch_up</h2>
<pre><code class="language-lua">function ncine.on_touch_up(event: touch_event)
</code></pre>
<p>Callback function called every time the last screen touch is released</p>
<h2>particle_affector</h2>
<pre><code class="language-lua">ncine.particle_affector
</code></pre>
<p>The table containing particle affectors related functions</p>
<h2>particle_system</h2>
<pre><code class="language-lua">ncine.particle_system
</code></pre>
<p>The table containing particle system related functions</p>
<h2>permission</h2>
<pre><code class="language-lua">enum ncine.permission
</code></pre>
<h2>rect</h2>
<pre><code class="language-lua">ncine.rect
</code></pre>
<p>A rectangle in 2D</p>
<h2>rect_animation</h2>
<pre><code class="language-lua">ncine.rect_animation
</code></pre>
<p>A rectangle based animation data table</p>
<h2>rewind_mode</h2>
<pre><code class="language-lua">enum ncine.rewind_mode
</code></pre>
<h2>scenenode</h2>
<pre><code class="language-lua">ncine.scenenode
</code></pre>
<p>The table containing scenenode related functions.</p>
<p>A scene node is the base class for many other classes that can be organized in a scene graph.</p>
<h2>shader</h2>
<pre><code class="language-lua">ncine.shader
</code></pre>
<p>The table containing shader related functions</p>
<h2>shader_default_fragment</h2>
<pre><code class="language-lua">enum ncine.shader_default_fragment
</code></pre>
<h2>shader_default_vertex</h2>
<pre><code class="language-lua">enum ncine.shader_default_vertex
</code></pre>
<h2>shader_introspection</h2>
<pre><code class="language-lua">enum ncine.shader_introspection
</code></pre>
<h2>shaderstate</h2>
<pre><code class="language-lua">ncine.shaderstate
</code></pre>
<p>The table containing shader state related functions</p>
<h2>sprite</h2>
<pre><code class="language-lua">ncine.sprite
</code></pre>
<p>The table containing sprite related functions</p>
<h2>start</h2>
<pre><code class="language-lua">function ncine.start()
</code></pre>
<p>Starts the application game loop</p>
<p>This function should be called after defining the required callback functions, and only if launching the script from the stand-alone <code>lua</code> interpreter.</p>
<p>For example:</p>
<pre><code class="language-lua">if ncine == nil then
    local names = { &quot;ncine&quot;, &quot;ncine_d&quot;, &quot;libncine&quot;, &quot;libncine_d&quot; }
    for i, name in ipairs(names) do
        local ok, mod = pcall(require, name)
        if ok then
            break
        end
    end
    needs_start = true
end

function nc.on_init()
    [...]
end

function nc.on_frame_start()
    [...]
end

if needs_start then
    nc.start()
end
</code></pre>
<h2>tex_filtering</h2>
<pre><code class="language-lua">enum ncine.tex_filtering
</code></pre>
<h2>tex_format</h2>
<pre><code class="language-lua">enum ncine.tex_format
</code></pre>
<h2>tex_wrap</h2>
<pre><code class="language-lua">enum ncine.tex_wrap
</code></pre>
<h2>text_alignment</h2>
<pre><code class="language-lua">enum ncine.text_alignment
</code></pre>
<h2>textnode</h2>
<pre><code class="language-lua">ncine.textnode
</code></pre>
<p>The table containing textnode related functions</p>
<h2>texture</h2>
<pre><code class="language-lua">ncine.texture
</code></pre>
<p>The table containing texture related functions</p>
<h2>texture_cut_mode</h2>
<pre><code class="language-lua">enum ncine.texture_cut_mode
</code></pre>
<h2>timestamp</h2>
<pre><code class="language-lua">table
</code></pre>
<p>Timestamping related functions</p>
<h2>vec2</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>A two component vector</p>
<h2>vec3</h2>
<pre><code class="language-lua">ncine.vec3
</code></pre>
<p>A three component vector</p>
<h2>vec4</h2>
<pre><code class="language-lua">ncine.vec4
</code></pre>
<p>A four component vector</p>
<h2>viewport</h2>
<pre><code class="language-lua">ncine.viewport
</code></pre>
<p>The table containing viewport related functions</p>
<h2>viewport_type</h2>
<pre><code class="language-lua">enum ncine.viewport_type
</code></pre>
<h2>visit_order_state</h2>
<pre><code class="language-lua">enum ncine.visit_order_state
</code></pre>
<hr>
<h1>ncine</h1>
<pre><code class="language-lua">ncine
</code></pre>
<pre><code class="language-lua">ncine
</code></pre>
<hr>
<h1>ncine.affector_type</h1>
<pre><code class="language-lua">enum ncine.affector_type
</code></pre>
<pre><code class="language-lua">enum ncine.affector_type
</code></pre>
<hr>
<h1>ncine.animated_sprite</h1>
<h2>add_animation</h2>
<pre><code class="language-lua">function ncine.animated_sprite.add_animation(sprite: animatedspriteObj, anim: ncine.rect_animation)
</code></pre>
<p>Adds a new animation</p>
<p>An example of a valid animation table is the following:</p>
<pre><code class="language-lua">local animation = {
    frame_duration = 0.5, -- half a second
    loop_mode = nc.loop_mode.ENABLED,
    rewind_mode = nc.rewind_mode.FROM_START,
    rect_size = { x = 32, y = 32 },
    source_rect = { x = 0, y = 0, w = 96, h = 48 },
    num_rectangles_to_skip = 0, -- default is 0 if the field is not specified
    padding = { x = 0, y = 0 }, -- default is {x = 0, y = 0} if the field is not specified
}
</code></pre>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>clear_animations</h2>
<pre><code class="language-lua">function ncine.animated_sprite.clear_animations(sprite: animatedspriteObj)
</code></pre>
<p>Deletes all animations</p>
<h2>clone</h2>
<pre><code class="language-lua">function ncine.animated_sprite.clone(sprite: animatedspriteObj)
  -&gt; animatedspriteObj
</code></pre>
<p>Constructs a new animated sprite object as a clone of the specified one</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/animated_sprite.lua#41">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>sprite</code> — The sprite object to be cloned</p>
<p>@<em>return</em> — The cloned animated sprite object</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.animated_sprite.delete(sprite: animatedspriteObj)
</code></pre>
<p>Destroys an animated sprite object and releases its memory</p>
<p>@<em>param</em> <code>sprite</code> — The animated sprite object to be destroyed</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_animation_index</h2>
<pre><code class="language-lua">function ncine.animated_sprite.get_animation_index(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the current animation index</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_frame</h2>
<pre><code class="language-lua">function ncine.animated_sprite.get_frame(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the frame number in current animation</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of the node area</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the texture source rectangle for blitting</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture object</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of the node area</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>is_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is horizontally flipped</p>
<h2>is_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is vertically flipped</p>
<h2>is_paused</h2>
<pre><code class="language-lua">function ncine.animated_sprite.is_paused(sprite: animatedspriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the current animation is paused</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.animated_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; animatedspriteObj
</code></pre>
<p>Constructs an animated sprite object with a parent scene node, a texture, and position components</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/animated_sprite.lua#41">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>parent</code> — The parent scenenode</p>
<p>@<em>param</em> <code>texture</code> — The texture object</p>
<p>@<em>param</em> <code>x</code> — The X component of the position</p>
<p>@<em>param</em> <code>y</code> — The Y component of the position</p>
<p>@<em>return</em> — A new animated sprite object</p>
<h2>num_animations</h2>
<pre><code class="language-lua">function ncine.animated_sprite.num_animations(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the number of animations</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>num_frames</h2>
<pre><code class="language-lua">function ncine.animated_sprite.num_frames(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the number of frames in current animation</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>reset_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<p>Triggers a texture update without setting a new texture</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_animation_index</h2>
<pre><code class="language-lua">function ncine.animated_sprite.set_animation_index(sprite: animatedspriteObj, index: integer)
</code></pre>
<p>Sets the current animation index</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<p>Flips the texture rect horizontally</p>
<h2>set_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<p>Flips the texture rect vertically</p>
<h2>set_frame</h2>
<pre><code class="language-lua">function ncine.animated_sprite.set_frame(sprite: animatedspriteObj, frame: integer)
</code></pre>
<p>Sets current animation to a specified frame number</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_paused</h2>
<pre><code class="language-lua">function ncine.animated_sprite.set_paused(sprite: animatedspriteObj, paused: boolean)
</code></pre>
<p>Sets the pause state for the animation</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_size</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<p>Sets the sprite size</p>
<h2>set_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<p>Sets the texture source rectangle for blitting</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<p>Sets the texture object</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.animated_sprite</h1>
<pre><code class="language-lua">ncine.animated_sprite
</code></pre>
<pre><code class="language-lua">ncine.animated_sprite
</code></pre>
<hr>
<h1>ncine.animated_sprite.add_animation</h1>
<pre><code class="language-lua">function ncine.animated_sprite.add_animation(sprite: animatedspriteObj, anim: ncine.rect_animation)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.add_animation(sprite: animatedspriteObj, anim: ncine.rect_animation)
</code></pre>
<hr>
<h1>ncine.animated_sprite.clear_animations</h1>
<pre><code class="language-lua">function ncine.animated_sprite.clear_animations(sprite: animatedspriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.clear_animations(sprite: animatedspriteObj)
</code></pre>
<hr>
<h1>ncine.animated_sprite.clone</h1>
<pre><code class="language-lua">function ncine.animated_sprite.clone(sprite: animatedspriteObj)
  -&gt; animatedspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.clone(sprite: animatedspriteObj)
  -&gt; animatedspriteObj
</code></pre>
<hr>
<h1>ncine.animated_sprite.delete</h1>
<pre><code class="language-lua">function ncine.animated_sprite.delete(sprite: animatedspriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.delete(sprite: animatedspriteObj)
</code></pre>
<hr>
<h1>ncine.animated_sprite.get_animation_index</h1>
<pre><code class="language-lua">function ncine.animated_sprite.get_animation_index(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.get_animation_index(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.animated_sprite.get_frame</h1>
<pre><code class="language-lua">function ncine.animated_sprite.get_frame(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.get_frame(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.animated_sprite.is_paused</h1>
<pre><code class="language-lua">function ncine.animated_sprite.is_paused(sprite: animatedspriteObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.is_paused(sprite: animatedspriteObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.animated_sprite.new</h1>
<pre><code class="language-lua">function ncine.animated_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; animatedspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; animatedspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; animatedspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; animatedspriteObj
</code></pre>
<hr>
<h1>ncine.animated_sprite.num_animations</h1>
<pre><code class="language-lua">function ncine.animated_sprite.num_animations(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.num_animations(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.animated_sprite.num_frames</h1>
<pre><code class="language-lua">function ncine.animated_sprite.num_frames(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.num_frames(sprite: animatedspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.animated_sprite.set_animation_index</h1>
<pre><code class="language-lua">function ncine.animated_sprite.set_animation_index(sprite: animatedspriteObj, index: integer)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.set_animation_index(sprite: animatedspriteObj, index: integer)
</code></pre>
<hr>
<h1>ncine.animated_sprite.set_frame</h1>
<pre><code class="language-lua">function ncine.animated_sprite.set_frame(sprite: animatedspriteObj, frame: integer)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.set_frame(sprite: animatedspriteObj, frame: integer)
</code></pre>
<hr>
<h1>ncine.animated_sprite.set_paused</h1>
<pre><code class="language-lua">function ncine.animated_sprite.set_paused(sprite: animatedspriteObj, paused: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.animated_sprite.set_paused(sprite: animatedspriteObj, paused: boolean)
</code></pre>
<hr>
<h1>ncine.app_configuration</h1>
<h2>argc</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of arguments passed on the command line</p>
<h2>argv</h2>
<pre><code class="language-lua">string[]
</code></pre>
<p>The array of arguments passed on the command line</p>
<h2>audio</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the audio subsystem is enabled</p>
<h2>binary_shader_cache</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the shader cache is enabled to load and save binary shader programs</p>
<h2>buffer_mapping</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if mapping is used to update OpenGL buffers</p>
<h2>compile_batched_shaders_twice</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if, on devices with UBOs smaller than 64 KB, batched shaders will be compiled twice to identify their maximum batch size</p>
<h2>console_colors</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if console log messages should use colors</p>
<h2>console_log_level</h2>
<pre><code class="language-lua">ncine.log_level
</code></pre>
<p>ncine.log_level # The minimum level that a log message needs to have to be printed in the console</p>
<h2>data_path</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The data path</p>
<h2>debug_overlay</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the debug overlay is enabled</p>
<h2>defer_shader_queries</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> when error checking and introspection of shader programs are deferred to first use</p>
<h2>file_log_level</h2>
<pre><code class="language-lua">ncine.log_level
</code></pre>
<p>The minimum level that a log message needs to have to be written to the log file</p>
<h2>fixed_batch_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Fixed size of render commands to be collected for batching on Emscripten and ANGLE</p>
<h2>frame_limit</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The maximum number of frames to render per second or 0 for no limit</p>
<h2>full_screen</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the application is going to be in full screen mode</p>
<h2>gl_debug_context</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the OpenGL debug context is enabled</p>
<h2>ibo_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The maximum size in bytes for each IBO collecting index data</p>
<h2>log_file</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The file used when logging to file is enabled</p>
<h2>log_interval</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The interval for frame timer accumulation average and log</p>
<h2>mono_audio_sources</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of mono audio sources</p>
<h2>opengl_core_profile</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if the OpenGL profile is going to be core (read-only)</p>
<h2>opengl_forward_compatible</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if the OpenGL context is going to be forward compatible (read-only)</p>
<h2>opengl_major_version</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The major version number of the OpenGL context (read-only)</p>
<h2>opengl_minor_version</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The minor version number of the OpenGL context (read-only)</p>
<h2>output_audio_frequency</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The output frequency of the audio system</p>
<h2>profile_text_update_time</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The update time in seconds for the profile text nodes (read-only)</p>
<h2>refresh_rate</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The refresh rate of the screen mode used to go in full screen.<br>If it is zero or negative, when requesting a full screen mode the current refresh rate will not be changed.</p>
<h2>rendercommand_pool_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The initial size for the pool of render commands</p>
<h2>resizable</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the window is going to be resizable</p>
<h2>resolution</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>The window size or the resolution of the closest video mode if going full screen.<br>If either <code>x</code> or <code>y</code> are zero or negative, the application will go in full screen at the current screen resolution.</p>
<h2>scenegraph</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the scenegraph based rendering is enabled</p>
<h2>shader_cache_dirname</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The directory name (not the complete path) for the binary shaders cache</p>
<h2>stereo_audio_sources</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of stereo audio sources</p>
<h2>threads</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the threading subsystem is enabled</p>
<h2>vao_pool_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The maximum size for the pool of VAOs</p>
<h2>vbo_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The maximum size in bytes for each VBO collecting geometry data</p>
<h2>vsync</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the vertical synchronization is enabled</p>
<h2>window_icon</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The window icon filename</p>
<h2>window_position</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>The window position coordinates in the virtual screen made of all the connected monitors</p>
<h2>window_scaling</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>The flag is <code>true</code> if the window size is automatically scaled according to the display factor</p>
<h2>window_title</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The window title</p>
<hr>
<h1>ncine.app_onfiguration</h1>
<pre><code class="language-lua">ncine.app_configuration
</code></pre>
<pre><code class="language-lua">ncine.app_configuration
</code></pre>
<hr>
<h1>ncine.application</h1>
<pre><code class="language-lua">ncine.application
</code></pre>
<pre><code class="language-lua">ncine.application
</code></pre>
<hr>
<h1>ncine.application</h1>
<h2>get_app_configuration</h2>
<pre><code class="language-lua">function ncine.application.get_app_configuration()
  -&gt; ncine.app_configuration
</code></pre>
<p>Returns the configuration used to initialize the application</p>
<h2>get_auto_suspension</h2>
<pre><code class="language-lua">function ncine.application.get_auto_suspension()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the application should auto-suspend when it loses focus</p>
<h2>get_debugoverlay_settings</h2>
<pre><code class="language-lua">function ncine.application.get_debugoverlay_settings()
  -&gt; debug_overlay_settings
</code></pre>
<p>Returns the run-time debug overlay settings, if debug overlay is available</p>
<h2>get_gui_settings</h2>
<pre><code class="language-lua">function ncine.application.get_gui_settings()
  -&gt; gui_settings
</code></pre>
<p>Returns the run-time GUI settings</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.application.get_height()
  -&gt; number
</code></pre>
<p>Returns the drawable screen height</p>
<h2>get_interval</h2>
<pre><code class="language-lua">function ncine.application.get_interval()
  -&gt; number
</code></pre>
<p>Returns the time in seconds that last frame took to complete</p>
<h2>get_num_frames</h2>
<pre><code class="language-lua">function ncine.application.get_num_frames()
  -&gt; integer
</code></pre>
<p>Returns the total number of frames already rendered</p>
<h2>get_rendering_settings</h2>
<pre><code class="language-lua">function ncine.application.get_rendering_settings()
  -&gt; rendering_settings
</code></pre>
<p>Returns the run-time rendering settings</p>
<h2>get_resolution</h2>
<pre><code class="language-lua">function ncine.application.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<p>Returns the drawable screen resolution vector</p>
<h2>get_rootnode</h2>
<pre><code class="language-lua">function ncine.application.get_rootnode()
  -&gt; scenenodeObj
</code></pre>
<p>Returns the root node of the transformation graph</p>
<h2>get_screen_viewport</h2>
<pre><code class="language-lua">function ncine.application.get_screen_viewport()
  -&gt; viewportObj
</code></pre>
<p>Returns the screen viewport</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.application.get_width()
  -&gt; number
</code></pre>
<p>Returns the drawable screen width</p>
<h2>is_suspended</h2>
<pre><code class="language-lua">function ncine.application.is_suspended()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the application is suspended.</p>
<p>A suspended application will not update nor receive events.</p>
<h2>quit</h2>
<pre><code class="language-lua">function ncine.application.quit()
</code></pre>
<p>Asks the application to quit as soon as possible</p>
<h2>set_auto_suspension</h2>
<pre><code class="language-lua">function ncine.application.set_auto_suspension(flag: boolean)
</code></pre>
<p>Sets a new value for the auto-suspension flag</p>
<h2>set_debugoverlay_settings</h2>
<pre><code class="language-lua">function ncine.application.set_debugoverlay_settings(settings: debug_overlay_settings)
</code></pre>
<p>Sets the run-time debug overlay settings</p>
<h2>set_gui_settings</h2>
<pre><code class="language-lua">function ncine.application.set_gui_settings(settings: gui_settings)
</code></pre>
<p>Sets the run-time GUI settings</p>
<h2>set_rendering_settings</h2>
<pre><code class="language-lua">function ncine.application.set_rendering_settings(settings: rendering_settings)
</code></pre>
<p>Sets the run-time rendering settings</p>
<h2>set_suspended</h2>
<pre><code class="language-lua">function ncine.application.set_suspended(flag: boolean)
</code></pre>
<p>Sets a new value for the suspension flag</p>
<hr>
<h1>ncine.application.get_app_configuration</h1>
<pre><code class="language-lua">function ncine.application.get_app_configuration()
  -&gt; ncine.app_configuration
</code></pre>
<pre><code class="language-lua">function ncine.application.get_app_configuration()
  -&gt; ncine.app_configuration
</code></pre>
<hr>
<h1>ncine.application.get_auto_suspension</h1>
<pre><code class="language-lua">function ncine.application.get_auto_suspension()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.application.get_auto_suspension()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.application.get_debugoverlay_settings</h1>
<pre><code class="language-lua">function ncine.application.get_debugoverlay_settings()
  -&gt; debug_overlay_settings
</code></pre>
<pre><code class="language-lua">function ncine.application.get_debugoverlay_settings()
  -&gt; debug_overlay_settings
</code></pre>
<hr>
<h1>ncine.application.get_gui_settings</h1>
<pre><code class="language-lua">function ncine.application.get_gui_settings()
  -&gt; gui_settings
</code></pre>
<pre><code class="language-lua">function ncine.application.get_gui_settings()
  -&gt; gui_settings
</code></pre>
<hr>
<h1>ncine.application.get_height</h1>
<pre><code class="language-lua">function ncine.application.get_height()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.application.get_height()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.application.get_interval</h1>
<pre><code class="language-lua">function ncine.application.get_interval()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.application.get_interval()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.application.get_num_frames</h1>
<pre><code class="language-lua">function ncine.application.get_num_frames()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.application.get_num_frames()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.application.get_rendering_settings</h1>
<pre><code class="language-lua">function ncine.application.get_rendering_settings()
  -&gt; rendering_settings
</code></pre>
<pre><code class="language-lua">function ncine.application.get_rendering_settings()
  -&gt; rendering_settings
</code></pre>
<hr>
<h1>ncine.application.get_resolution</h1>
<pre><code class="language-lua">function ncine.application.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.application.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.application.get_rootnode</h1>
<pre><code class="language-lua">function ncine.application.get_rootnode()
  -&gt; scenenodeObj
</code></pre>
<pre><code class="language-lua">function ncine.application.get_rootnode()
  -&gt; scenenodeObj
</code></pre>
<hr>
<h1>ncine.application.get_screen_viewport</h1>
<pre><code class="language-lua">function ncine.application.get_screen_viewport()
  -&gt; viewportObj
</code></pre>
<pre><code class="language-lua">function ncine.application.get_screen_viewport()
  -&gt; viewportObj
</code></pre>
<hr>
<h1>ncine.application.get_width</h1>
<pre><code class="language-lua">function ncine.application.get_width()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.application.get_width()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.application.is_suspended</h1>
<pre><code class="language-lua">function ncine.application.is_suspended()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.application.is_suspended()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.application.quit</h1>
<pre><code class="language-lua">function ncine.application.quit()
</code></pre>
<pre><code class="language-lua">function ncine.application.quit()
</code></pre>
<hr>
<h1>ncine.application.set_auto_suspension</h1>
<pre><code class="language-lua">function ncine.application.set_auto_suspension(flag: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.application.set_auto_suspension(flag: boolean)
</code></pre>
<hr>
<h1>ncine.application.set_debugoverlay_settings</h1>
<pre><code class="language-lua">function ncine.application.set_debugoverlay_settings(settings: debug_overlay_settings)
</code></pre>
<pre><code class="language-lua">function ncine.application.set_debugoverlay_settings(settings: debug_overlay_settings)
</code></pre>
<hr>
<h1>ncine.application.set_gui_settings</h1>
<pre><code class="language-lua">function ncine.application.set_gui_settings(settings: gui_settings)
</code></pre>
<pre><code class="language-lua">function ncine.application.set_gui_settings(settings: gui_settings)
</code></pre>
<hr>
<h1>ncine.application.set_rendering_settings</h1>
<pre><code class="language-lua">function ncine.application.set_rendering_settings(settings: rendering_settings)
</code></pre>
<pre><code class="language-lua">function ncine.application.set_rendering_settings(settings: rendering_settings)
</code></pre>
<hr>
<h1>ncine.application.set_suspended</h1>
<pre><code class="language-lua">function ncine.application.set_suspended(flag: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.application.set_suspended(flag: boolean)
</code></pre>
<hr>
<h1>ncine.audio_device</h1>
<h2>get_gain</h2>
<pre><code class="language-lua">function ncine.audio_device.get_gain()
  -&gt; number
</code></pre>
<p>Returns the listener gain value</p>
<h2>get_max_num_sources</h2>
<pre><code class="language-lua">function ncine.audio_device.get_max_num_sources()
  -&gt; integer
</code></pre>
<p>Returns the maximum number of audio sources</p>
<h2>get_num_available_sources</h2>
<pre><code class="language-lua">function ncine.audio_device.get_num_available_sources()
  -&gt; integer
</code></pre>
<p>Returns the number of available audio sources</p>
<h2>get_num_players</h2>
<pre><code class="language-lua">function ncine.audio_device.get_num_players()
  -&gt; integer
</code></pre>
<p>Returns the number of active players</p>
<h2>get_player</h2>
<pre><code class="language-lua">function ncine.audio_device.get_player(index: integer)
  -&gt; audioplayerObj?
</code></pre>
<p>Returns the specified active player object</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.audio_device.get_position()
  -&gt; ncine.vec3
</code></pre>
<p>Returns the listener position vector</p>
<h2>get_velocity</h2>
<pre><code class="language-lua">function ncine.audio_device.get_velocity()
  -&gt; ncine.vec3
</code></pre>
<p>Returns the listener velocity vector</p>
<h2>has_efx_extension</h2>
<pre><code class="language-lua">function ncine.audio_device.has_efx_extension()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the OpenAL EFX extension is available</p>
<h2>name</h2>
<pre><code class="language-lua">function ncine.audio_device.name()
  -&gt; string
</code></pre>
<p>Returns the name of the audio device</p>
<h2>pause_device</h2>
<pre><code class="language-lua">function ncine.audio_device.pause_device()
</code></pre>
<p>Pauses all audio device activities using an OpenAL-soft extension (if available)</p>
<p>If the extension is not available, all players are paused.</p>
<h2>pause_players</h2>
<pre><code class="language-lua">function ncine.audio_device.pause_players()
</code></pre>
<p>Pauses every player currently playing</p>
<p>Paused players can be resumed with <code>resume_players()</code>.</p>
<h2>resume_device</h2>
<pre><code class="language-lua">function ncine.audio_device.resume_device()
</code></pre>
<p>Resumes all audio device activities using an OpenAL-soft extension (if available)</p>
<p>If the extension is not available, all paused players resume playing.</p>
<h2>resume_players</h2>
<pre><code class="language-lua">function ncine.audio_device.resume_players()
</code></pre>
<p>Resumes all and only the players that were paused by a <code>pause_players()</code> call</p>
<h2>set_gain</h2>
<pre><code class="language-lua">function ncine.audio_device.set_gain(gain: number)
</code></pre>
<p>Sets the listener gain value</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.audio_device.set_position(position: ncine.vec3)
</code></pre>
<p>Sets the listener position vector</p>
<h2>set_velocity</h2>
<pre><code class="language-lua">function ncine.audio_device.set_velocity(velocity: ncine.vec3)
</code></pre>
<p>Sets the listener velocity vector</p>
<h2>stop_players</h2>
<pre><code class="language-lua">function ncine.audio_device.stop_players()
</code></pre>
<p>Stops every player currently playing</p>
<hr>
<h1>ncine.audio_device</h1>
<pre><code class="language-lua">ncine.audio_device
</code></pre>
<pre><code class="language-lua">ncine.audio_device
</code></pre>
<hr>
<h1>ncine.audio_device.get_gain</h1>
<pre><code class="language-lua">function ncine.audio_device.get_gain()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_gain()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_device.get_max_num_sources</h1>
<pre><code class="language-lua">function ncine.audio_device.get_max_num_sources()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_max_num_sources()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_device.get_num_available_sources</h1>
<pre><code class="language-lua">function ncine.audio_device.get_num_available_sources()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_num_available_sources()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_device.get_num_players</h1>
<pre><code class="language-lua">function ncine.audio_device.get_num_players()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_num_players()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_device.get_player</h1>
<pre><code class="language-lua">function ncine.audio_device.get_player(index: integer)
  -&gt; audioplayerObj?
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_player(index: integer)
  -&gt; audioplayerObj?
</code></pre>
<hr>
<h1>ncine.audio_device.get_position</h1>
<pre><code class="language-lua">function ncine.audio_device.get_position()
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_position()
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.audio_device.get_velocity</h1>
<pre><code class="language-lua">function ncine.audio_device.get_velocity()
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.get_velocity()
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.audio_device.has_efx_extension</h1>
<pre><code class="language-lua">function ncine.audio_device.has_efx_extension()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.has_efx_extension()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_device.name</h1>
<pre><code class="language-lua">function ncine.audio_device.name()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.name()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.audio_device.pause_device</h1>
<pre><code class="language-lua">function ncine.audio_device.pause_device()
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.pause_device()
</code></pre>
<hr>
<h1>ncine.audio_device.pause_players</h1>
<pre><code class="language-lua">function ncine.audio_device.pause_players()
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.pause_players()
</code></pre>
<hr>
<h1>ncine.audio_device.resume_device</h1>
<pre><code class="language-lua">function ncine.audio_device.resume_device()
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.resume_device()
</code></pre>
<hr>
<h1>ncine.audio_device.resume_players</h1>
<pre><code class="language-lua">function ncine.audio_device.resume_players()
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.resume_players()
</code></pre>
<hr>
<h1>ncine.audio_device.set_gain</h1>
<pre><code class="language-lua">function ncine.audio_device.set_gain(gain: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_gain(gain: number)
</code></pre>
<hr>
<h1>ncine.audio_device.set_position</h1>
<pre><code class="language-lua">function ncine.audio_device.set_position(position: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_position(position_x: number, position_y: number, position_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_position(velocity_x: number, velocity_y: number, velocity_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_position(position: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_position(position_x: number, position_y: number, position_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_position(velocity_x: number, velocity_y: number, velocity_z: number)
</code></pre>
<hr>
<h1>ncine.audio_device.set_velocity</h1>
<pre><code class="language-lua">function ncine.audio_device.set_velocity(velocity: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.set_velocity(velocity: ncine.vec3)
</code></pre>
<hr>
<h1>ncine.audio_device.stop_players</h1>
<pre><code class="language-lua">function ncine.audio_device.stop_players()
</code></pre>
<pre><code class="language-lua">function ncine.audio_device.stop_players()
</code></pre>
<hr>
<h1>ncine.audio_effect</h1>
<h2>apply_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect.apply_properties(audio_effect: audioeffectObj, properties: audioeffectpropertiesObj)
</code></pre>
<p>Sets an effect type with all of its properties</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audio_effect.delete(audio_effect: audioeffectObj)
</code></pre>
<p>Destroys an audio effect object and releases its memory</p>
<p>@<em>param</em> <code>audio_effect</code> — The audio effect object to be destroyed</p>
<h2>get_effect_id</h2>
<pre><code class="language-lua">function ncine.audio_effect.get_effect_id(audio_effect: audioeffectObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL effect id</p>
<h2>get_type</h2>
<pre><code class="language-lua">function ncine.audio_effect.get_type(audio_effect: audioeffectObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<p>Returns the effect type</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audio_effect.new()
  -&gt; audioeffectObj
</code></pre>
<p>Constructs an audio effect object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/audio_effect.lua#38">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new audio effect object</p>
<hr>
<h1>ncine.audio_effect</h1>
<pre><code class="language-lua">ncine.audio_effect
</code></pre>
<pre><code class="language-lua">ncine.audio_effect
</code></pre>
<hr>
<h1>ncine.audio_effect.apply_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect.apply_properties(audio_effect: audioeffectObj, properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect.apply_properties(audio_effect: audioeffectObj, properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect.delete</h1>
<pre><code class="language-lua">function ncine.audio_effect.delete(audio_effect: audioeffectObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect.delete(audio_effect: audioeffectObj)
</code></pre>
<hr>
<h1>ncine.audio_effect.get_effect_id</h1>
<pre><code class="language-lua">function ncine.audio_effect.get_effect_id(audio_effect: audioeffectObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect.get_effect_id(audio_effect: audioeffectObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_effect.get_type</h1>
<pre><code class="language-lua">function ncine.audio_effect.get_type(audio_effect: audioeffectObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect.get_type(audio_effect: audioeffectObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<hr>
<h1>ncine.audio_effect.new</h1>
<pre><code class="language-lua">function ncine.audio_effect.new()
  -&gt; audioeffectObj
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect.new()
  -&gt; audioeffectObj
</code></pre>
<hr>
<h1>ncine.audio_effect_properties</h1>
<pre><code class="language-lua">ncine.audio_effect_properties
</code></pre>
<pre><code class="language-lua">ncine.audio_effect_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties</h1>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.delete(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Destroys an audio effect properties object and releases its memory</p>
<p>@<em>param</em> <code>audio_effect_properties</code> — The audio effect properties object to be destroyed</p>
<h2>get_auto_wah_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<p>Returns the current values for the auto wah effect properties</p>
<h2>get_chorus_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<p>Returns the current values for the chorus effect properties</p>
<h2>get_compressor_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<p>Returns the current values for the compressor effect properties</p>
<h2>get_distortion_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<p>Returns the current values for the distortion effect properties</p>
<h2>get_eax_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<p>Returns the current values for the EAX reverb effect properties</p>
<h2>get_echo_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<p>Returns the current values for the echo effect properties</p>
<h2>get_equalizer_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<p>Returns the current values for the equalizer effect properties</p>
<h2>get_flanger_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<p>Returns the current values for the flanger effect properties</p>
<h2>get_frequency_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<p>Returns the current values for the frequency shifter effect properties</p>
<h2>get_max_auto_wah_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<p>Returns the maximum values for the auto wah effect properties</p>
<h2>get_max_chorus_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<p>Returns the maximum values for the chorus effect properties</p>
<h2>get_max_compressor_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<p>Returns the maximum values for the compressor effect properties</p>
<h2>get_max_distortion_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<p>Returns the maximum values for the distortion effect properties</p>
<h2>get_max_eax_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<p>Returns the maximum values for the EAX reverb effect properties</p>
<h2>get_max_echo_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<p>Returns the maximum values for the echo effect properties</p>
<h2>get_max_equalizer_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<p>Returns the maximum values for the equalizer effect properties</p>
<h2>get_max_flanger_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<p>Returns the maximum values for the flanger effect properties</p>
<h2>get_max_frequency_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<p>Returns the maximum values for the frequency shifter effect properties</p>
<h2>get_max_pitch_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<p>Returns the maximum values for the pitch shifter effect properties</p>
<h2>get_max_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<p>Returns the maximum values for the reverb effect properties</p>
<h2>get_max_ring_modulator_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<p>Returns the maximum values for the ring modulator effect properties</p>
<h2>get_max_vocal_morpher_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<p>Returns the maximum values for the vocal morpher effect properties</p>
<h2>get_min_auto_wah_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<p>Returns the minimum values for the auto wah effect properties</p>
<h2>get_min_chorus_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<p>Returns the minimum values for the chorus effect properties</p>
<h2>get_min_compressor_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<p>Returns the minimum values for the compressor effect properties</p>
<h2>get_min_distortion_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<p>Returns the minimum values for the distortion effect properties</p>
<h2>get_min_eax_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<p>Returns the minimum values for the EAX reverb effect properties</p>
<h2>get_min_echo_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<p>Returns the minimum values for the echo effect properties</p>
<h2>get_min_equalizer_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<p>Returns the minimum values for the equalizer effect properties</p>
<h2>get_min_flanger_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<p>Returns the minimum values for the flanger effect properties</p>
<h2>get_min_frequency_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<p>Returns the minimum values for the frequency shifter effect properties</p>
<h2>get_min_pitch_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<p>Returns the minimum values for the pitch shifter effect properties</p>
<h2>get_min_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<p>Returns the minimum values for the reverb effect properties</p>
<h2>get_min_ring_modulator_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<p>Returns the minimum values for the ring modulator effect properties</p>
<h2>get_min_vocal_morpher_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<p>Returns the minimum values for the vocal morpher effect properties</p>
<h2>get_pitch_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<p>Returns the current values for the pitch shifter effect properties</p>
<h2>get_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<p>Returns the current values for the reverb effect properties</p>
<h2>get_ring_modulator_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<p>Returns the current values for the ring modulator effect properties</p>
<h2>get_type</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_type(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<p>Returns the effect properties type</p>
<h2>get_vocal_morpher_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<p>Returns the current values for the vocal morpher effect properties</p>
<h2>load_efx_reverb_preset</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.load_efx_reverb_preset(audio_effect_properties: audioeffectpropertiesObj, preset: ncine.efx_reverb_presets)
</code></pre>
<p>Loads and sets the effect properties from an EFX reverb preset</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.new()
  -&gt; audioeffectpropertiesObj
</code></pre>
<p>Constructs an audio effect properties object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/audio_effect_properties.lua#19">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new audio effect properties object</p>
<h2>reset_auto_wah_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the auto wah effect to thir default</p>
<h2>reset_chorus_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the chorus effect to thir default</p>
<h2>reset_compressor_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the compressor effect to thir default</p>
<h2>reset_distortion_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the distortion effect to thir default</p>
<h2>reset_eax_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the EAX reverb effect to thir default</p>
<h2>reset_echo_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the echo effect to thir default</p>
<h2>reset_equalizer_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the equalizer effect to thir default</p>
<h2>reset_flanger_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the flanger effect to thir default</p>
<h2>reset_frequency_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the frequency shifter effect to thir default</p>
<h2>reset_pitch_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the pitch shifter effect to thir default</p>
<h2>reset_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the reverb effect to thir default</p>
<h2>reset_ring_modulator_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the ring modulator effect to thir default</p>
<h2>reset_vocal_morpher_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<p>Resets all property values for the vocal morpher effect to thir default</p>
<h2>set_auto_wah_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_auto_wah_properties)
</code></pre>
<p>Sets all values for the auto wah effect properties</p>
<h2>set_chorus_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_chorus_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_chorus_properties)
</code></pre>
<p>Sets all values for the chorus effect properties</p>
<h2>set_compressor_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_compressor_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_compressor_properties)
</code></pre>
<p>Sets all values for the compressor effect properties</p>
<h2>set_distortion_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_distortion_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_distortion_properties)
</code></pre>
<p>Sets all values for the distortion effect properties</p>
<h2>set_eax_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_eax_reverb_properties)
</code></pre>
<p>Sets all values for the EAX reverb effect properties</p>
<h2>set_echo_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_echo_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_echo_properties)
</code></pre>
<p>Sets all values for the echo effect properties</p>
<h2>set_equalizer_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_equalizer_properties)
</code></pre>
<p>Sets all values for the equalizer effect properties</p>
<h2>set_flanger_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_flanger_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_flanger_properties)
</code></pre>
<p>Sets all values for the flanger effect properties</p>
<h2>set_frequency_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_frequency_shifter_properties)
</code></pre>
<p>Sets all values for the frequency shifter effect properties</p>
<h2>set_pitch_shifter_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_pitch_shifter_properties)
</code></pre>
<p>Sets all values for the pitch shifter effect properties</p>
<h2>set_reverb_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_reverb_properties)
</code></pre>
<p>Sets all values for the reverb effect properties</p>
<h2>set_ring_modulator_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_ring_modulator_properties)
</code></pre>
<p>Sets all values for the ring modulator effect properties</p>
<h2>set_type</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_type(audio_effect_properties: audioeffectpropertiesObj, audio_effect_type: ncine.audio_effect_type)
</code></pre>
<p>Sets the effect properties type</p>
<h2>set_vocal_morpher_properties</h2>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_vocal_morpher_properties)
</code></pre>
<p>Sets all values for the vocal morpher effect properties</p>
<hr>
<h1>ncine.audio_effect_properties.delete</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.delete(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.delete(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_auto_wah_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_chorus_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_compressor_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_distortion_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_eax_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_echo_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_equalizer_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_flanger_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_frequency_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_auto_wah_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_chorus_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_compressor_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_distortion_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_eax_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_echo_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_equalizer_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_flanger_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_frequency_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_pitch_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_ring_modulator_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_max_vocal_morpher_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_max_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_auto_wah_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_auto_wah_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_chorus_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_chorus_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_compressor_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_compressor_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_distortion_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_distortion_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_eax_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_eax_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_echo_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_echo_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_equalizer_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_equalizer_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_flanger_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_flanger_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_frequency_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_frequency_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_pitch_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_ring_modulator_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_min_vocal_morpher_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_min_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_pitch_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_pitch_shifter_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_reverb_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_ring_modulator_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_ring_modulator_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_type</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_type(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_type(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; ncine.audio_effect_type
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.get_vocal_morpher_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.get_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
  -&gt; audio_vocal_morpher_properties
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.load_efx_reverb_preset</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.load_efx_reverb_preset(audio_effect_properties: audioeffectpropertiesObj, preset: ncine.efx_reverb_presets)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.load_efx_reverb_preset(audio_effect_properties: audioeffectpropertiesObj, preset: ncine.efx_reverb_presets)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.new</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.new()
  -&gt; audioeffectpropertiesObj
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.new()
  -&gt; audioeffectpropertiesObj
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_auto_wah_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_chorus_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_chorus_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_compressor_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_compressor_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_distortion_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_distortion_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_eax_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_echo_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_echo_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_equalizer_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_flanger_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_flanger_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_frequency_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_pitch_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_reverb_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_ring_modulator_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.reset_vocal_morpher_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.reset_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_auto_wah_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_auto_wah_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_auto_wah_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_auto_wah_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_chorus_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_chorus_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_chorus_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_chorus_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_chorus_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_compressor_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_compressor_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_compressor_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_compressor_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_compressor_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_distortion_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_distortion_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_distortion_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_distortion_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_distortion_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_eax_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_eax_reverb_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_eax_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_eax_reverb_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_echo_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_echo_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_echo_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_echo_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_echo_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_equalizer_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_equalizer_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_equalizer_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_equalizer_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_flanger_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_flanger_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_flanger_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_flanger_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_flanger_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_frequency_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_frequency_shifter_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_frequency_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_frequency_shifter_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_pitch_shifter_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_pitch_shifter_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_pitch_shifter_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_pitch_shifter_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_reverb_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_reverb_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_reverb_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_reverb_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_ring_modulator_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_ring_modulator_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_ring_modulator_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_ring_modulator_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_type</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_type(audio_effect_properties: audioeffectpropertiesObj, audio_effect_type: ncine.audio_effect_type)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_type(audio_effect_properties: audioeffectpropertiesObj, audio_effect_type: ncine.audio_effect_type)
</code></pre>
<hr>
<h1>ncine.audio_effect_properties.set_vocal_morpher_properties</h1>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_vocal_morpher_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_properties.set_vocal_morpher_properties(audio_effect_properties: audioeffectpropertiesObj, properties: audio_vocal_morpher_properties)
</code></pre>
<hr>
<h1>ncine.audio_effect_slot</h1>
<h2>apply_effect</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.apply_effect(audio_effect_slot: audioeffectslotObj, audio_effect: audioeffectObj)
</code></pre>
<p>Applies the effect parameters from an effect object</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.delete(audio_effect_slot: audioeffectslotObj)
</code></pre>
<p>Destroys an audio effect slot object and releases its memory</p>
<p>@<em>param</em> <code>audio_effect_slot</code> — The audio effect slot object to be destroyed</p>
<h2>get_aux_send_auto</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_aux_send_auto(audio_effect_slot: audioeffectslotObj)
  -&gt; boolean
</code></pre>
<p>Returns the state of the auxilary slot send auto flag</p>
<p>The property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener.</p>
<h2>get_effect_slot_id</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_effect_slot_id(audio_effect_slot: audioeffectslotObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL auxilary effect slot id</p>
<h2>get_gain</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_gain(audio_effect_slot: audioeffectslotObj)
  -&gt; number
</code></pre>
<p>Returns the gain output level of the auxilary effect slot</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.new()
  -&gt; audioeffectslotObj
</code></pre>
<p>Constructs an audio effect slot object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/audio_effect_slot.lua#19">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new audio effect slot object</p>
<h2>set_aux_send_auto</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_aux_send_auto(audio_effect_slot: audioeffectslotObj, aux_send_auto: boolean)
</code></pre>
<p>Sets the state of the auxilary slot send auto flag</p>
<p>The property is used to enable or disable automatic send adjustments based on the physical positions of the sources and the listener.</p>
<h2>set_gain</h2>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_gain(audio_effect_slot: audioeffectslotObj, gain: number)
</code></pre>
<p>Sets the gain output level of the auxilary effect slot</p>
<hr>
<h1>ncine.audio_effect_slot</h1>
<pre><code class="language-lua">ncine.audio_effect_slot
</code></pre>
<pre><code class="language-lua">ncine.audio_effect_slot
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.apply_effect</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.apply_effect(audio_effect_slot: audioeffectslotObj, audio_effect: audioeffectObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.apply_effect(audio_effect_slot: audioeffectslotObj, audio_effect: audioeffectObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.delete</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.delete(audio_effect_slot: audioeffectslotObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.delete(audio_effect_slot: audioeffectslotObj)
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.get_aux_send_auto</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_aux_send_auto(audio_effect_slot: audioeffectslotObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_aux_send_auto(audio_effect_slot: audioeffectslotObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.get_effect_slot_id</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_effect_slot_id(audio_effect_slot: audioeffectslotObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_effect_slot_id(audio_effect_slot: audioeffectslotObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.get_gain</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_gain(audio_effect_slot: audioeffectslotObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.get_gain(audio_effect_slot: audioeffectslotObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.new</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.new()
  -&gt; audioeffectslotObj
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.new()
  -&gt; audioeffectslotObj
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.set_aux_send_auto</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_aux_send_auto(audio_effect_slot: audioeffectslotObj, aux_send_auto: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_aux_send_auto(audio_effect_slot: audioeffectslotObj, aux_send_auto: boolean)
</code></pre>
<hr>
<h1>ncine.audio_effect_slot.set_gain</h1>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_gain(audio_effect_slot: audioeffectslotObj, gain: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_effect_slot.set_gain(audio_effect_slot: audioeffectslotObj, gain: number)
</code></pre>
<hr>
<h1>ncine.audio_effect_type</h1>
<pre><code class="language-lua">enum ncine.audio_effect_type
</code></pre>
<pre><code class="language-lua">enum ncine.audio_effect_type
</code></pre>
<hr>
<h1>ncine.audio_filter</h1>
<h2>apply_properties</h2>
<pre><code class="language-lua">function ncine.audio_filter.apply_properties(audio_filter: audiofilterObj, properties: audio_filter_properties)
</code></pre>
<p>Sets the filter type and all of its properties</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audio_filter.delete(audio_filter: audiofilterObj)
</code></pre>
<p>Destroys an audio filter object and releases its memory</p>
<p>@<em>param</em> <code>audio_filter</code> — The audio filter object to be destroyed</p>
<h2>get_default_properties</h2>
<pre><code class="language-lua">function ncine.audio_filter.get_default_properties()
  -&gt; audio_filter_properties
</code></pre>
<p>Returns a table with the default filter type and properties</p>
<p>The table is only returned as a reference.</p>
<h2>get_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_filter.get_filter_id(audio_filter: audiofilterObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL filter id</p>
<h2>get_type</h2>
<pre><code class="language-lua">function ncine.audio_filter.get_type(audio_filter: audiofilterObj)
  -&gt; ncine.audio_filter_type
</code></pre>
<p>Returns the filter type</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audio_filter.new()
  -&gt; audiofilterObj
</code></pre>
<p>Constructs an audio filter object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/audio_filter.lua#36">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new audio filter object</p>
<hr>
<h1>ncine.audio_filter</h1>
<pre><code class="language-lua">ncine.audio_filter
</code></pre>
<pre><code class="language-lua">ncine.audio_filter
</code></pre>
<hr>
<h1>ncine.audio_filter.apply_properties</h1>
<pre><code class="language-lua">function ncine.audio_filter.apply_properties(audio_filter: audiofilterObj, properties: audio_filter_properties)
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.apply_properties(audio_filter: audiofilterObj, properties: audio_filter_properties)
</code></pre>
<hr>
<h1>ncine.audio_filter.delete</h1>
<pre><code class="language-lua">function ncine.audio_filter.delete(audio_filter: audiofilterObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.delete(audio_filter: audiofilterObj)
</code></pre>
<hr>
<h1>ncine.audio_filter.get_default_properties</h1>
<pre><code class="language-lua">function ncine.audio_filter.get_default_properties()
  -&gt; audio_filter_properties
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.get_default_properties()
  -&gt; audio_filter_properties
</code></pre>
<hr>
<h1>ncine.audio_filter.get_filter_id</h1>
<pre><code class="language-lua">function ncine.audio_filter.get_filter_id(audio_filter: audiofilterObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.get_filter_id(audio_filter: audiofilterObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_filter.get_type</h1>
<pre><code class="language-lua">function ncine.audio_filter.get_type(audio_filter: audiofilterObj)
  -&gt; ncine.audio_filter_type
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.get_type(audio_filter: audiofilterObj)
  -&gt; ncine.audio_filter_type
</code></pre>
<hr>
<h1>ncine.audio_filter.new</h1>
<pre><code class="language-lua">function ncine.audio_filter.new()
  -&gt; audiofilterObj
</code></pre>
<pre><code class="language-lua">function ncine.audio_filter.new()
  -&gt; audiofilterObj
</code></pre>
<hr>
<h1>ncine.audio_filter_type</h1>
<pre><code class="language-lua">enum ncine.audio_filter_type
</code></pre>
<pre><code class="language-lua">enum ncine.audio_filter_type
</code></pre>
<hr>
<h1>ncine.audio_player</h1>
<pre><code class="language-lua">ncine.audio_player
</code></pre>
<pre><code class="language-lua">ncine.audio_player
</code></pre>
<hr>
<h1>ncine.audio_player</h1>
<h2>buffer_id</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the currently playing buffer</p>
<h2>buffer_size</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_size(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>bytes_per_sample</h2>
<pre><code class="language-lua">function ncine.audio_player.bytes_per_sample(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of bytes per sample</p>
<h2>duration</h2>
<pre><code class="language-lua">function ncine.audio_player.duration(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the duration in seconds</p>
<h2>frequency</h2>
<pre><code class="language-lua">function ncine.audio_player.frequency(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the samples frequency of the currently playing buffer</p>
<h2>get_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_air_absorption_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player air absorption factor</p>
<h2>get_aux_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_aux_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the auxiliary filter</p>
<h2>get_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_inner_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player inside angle of the sound cone in degrees</p>
<h2>get_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player outside angle of the sound cone in degrees</p>
<h2>get_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player multiplication factor to determine the gain outside the cone</p>
<h2>get_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain_hf(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player cone outer gain HF value</p>
<h2>get_direct_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direct_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the direct filter</p>
<h2>get_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direction(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player direction vector</p>
<h2>get_effect_slot_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_effect_slot_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the effect slot</p>
<h2>get_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player gain value</p>
<h2>get_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.get_pitch(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player pitch value</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.audio_player.get_position(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player position vector</p>
<h2>get_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_room_rolloff_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player room rolloff factor</p>
<h2>get_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.get_sample_offset(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>get_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.get_velocity(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player velocity vector</p>
<h2>has_aux_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_aux_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL auxiliary filter is currently assigned to the player</p>
<h2>has_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_direct_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL direct filter is currently assigned to the player</p>
<h2>has_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.has_effect_slot(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL effect slot is currently assigned to the player</p>
<h2>has_source</h2>
<pre><code class="language-lua">function ncine.audio_player.has_source(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL source is currently assigned to the player</p>
<h2>is_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.is_looping(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns the looping property of the player</p>
<h2>is_paused</h2>
<pre><code class="language-lua">function ncine.audio_player.is_paused(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is paused</p>
<h2>is_playing</h2>
<pre><code class="language-lua">function ncine.audio_player.is_playing(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is playing</p>
<h2>is_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.is_source_locked(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the OpenAL source is locked</p>
<h2>is_stopped</h2>
<pre><code class="language-lua">function ncine.audio_player.is_stopped(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is stopped</p>
<h2>num_channels</h2>
<pre><code class="language-lua">function ncine.audio_player.num_channels(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of audio channels of the currently playing buffer</p>
<h2>num_samples</h2>
<pre><code class="language-lua">function ncine.audio_player.num_samples(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of samples</p>
<h2>pause</h2>
<pre><code class="language-lua">function ncine.audio_player.pause(player: audioplayerObj)
</code></pre>
<p>Pauses playing</p>
<h2>play</h2>
<pre><code class="language-lua">function ncine.audio_player.play(player: audioplayerObj)
</code></pre>
<p>Starts playing</p>
<h2>set_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_air_absorption_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player air absorption factor</p>
<h2>set_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_inner_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player inside angle of the sound cone in degrees</p>
<h2>set_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player outside angle of the sound cone in degrees</p>
<h2>set_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player multiplication factor to determine the gain outside the cone</p>
<h2>set_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain_hf(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player cone outer gain HF value</p>
<h2>set_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direct_filter(player: audioplayerObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes the filter parameters from a filter object to the direct signal</p>
<h2>set_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction: ncine.vec3)
</code></pre>
<p>Sets the player direction vector</p>
<h2>set_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.set_effect_slot(player: audioplayerObj, audio_effect_slot?: audioeffectslotObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes an affect slot, with an optional auxiliary filter, to the player</p>
<h2>set_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player gain value</p>
<h2>set_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.set_looping(player: audioplayerObj, looping: boolean)
</code></pre>
<p>Sets the looping property of the player</p>
<h2>set_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.set_pitch(player: audioplayerObj, pitch: number)
</code></pre>
<p>Sets the player pitch value</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position: ncine.vec3)
</code></pre>
<p>Sets the player position vector</p>
<h2>set_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_room_rolloff_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player room rolloff factor</p>
<h2>set_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.set_sample_offset(player: audioplayerObj, offset: integer)
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>set_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.set_source_locked(player: audioplayerObj, locked: boolean)
</code></pre>
<p>Locks an OpenAL source so it is not released to the pool when the player stops</p>
<h2>set_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity: ncine.vec3)
</code></pre>
<p>Sets the player velocity vector</p>
<h2>source_id</h2>
<pre><code class="language-lua">function ncine.audio_player.source_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the player source</p>
<h2>stop</h2>
<pre><code class="language-lua">function ncine.audio_player.stop(player: audioplayerObj)
</code></pre>
<p>Stops playing and rewinds</p>
<hr>
<h1>ncine.audio_player.buffer_id</h1>
<pre><code class="language-lua">function ncine.audio_player.buffer_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.buffer_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.buffer_size</h1>
<pre><code class="language-lua">function ncine.audio_player.buffer_size(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.buffer_size(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.bytes_per_sample</h1>
<pre><code class="language-lua">function ncine.audio_player.bytes_per_sample(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.bytes_per_sample(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.duration</h1>
<pre><code class="language-lua">function ncine.audio_player.duration(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.duration(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.frequency</h1>
<pre><code class="language-lua">function ncine.audio_player.frequency(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.frequency(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.get_air_absorption_factor</h1>
<pre><code class="language-lua">function ncine.audio_player.get_air_absorption_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_air_absorption_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_aux_filter_id</h1>
<pre><code class="language-lua">function ncine.audio_player.get_aux_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_aux_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.get_cone_inner_angle</h1>
<pre><code class="language-lua">function ncine.audio_player.get_cone_inner_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_cone_inner_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_cone_outer_angle</h1>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_cone_outer_gain</h1>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_cone_outer_gain_hf</h1>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain_hf(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain_hf(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_direct_filter_id</h1>
<pre><code class="language-lua">function ncine.audio_player.get_direct_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_direct_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.get_direction</h1>
<pre><code class="language-lua">function ncine.audio_player.get_direction(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_direction(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.audio_player.get_effect_slot_id</h1>
<pre><code class="language-lua">function ncine.audio_player.get_effect_slot_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_effect_slot_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.get_gain</h1>
<pre><code class="language-lua">function ncine.audio_player.get_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_pitch</h1>
<pre><code class="language-lua">function ncine.audio_player.get_pitch(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_pitch(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_position</h1>
<pre><code class="language-lua">function ncine.audio_player.get_position(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_position(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.audio_player.get_room_rolloff_factor</h1>
<pre><code class="language-lua">function ncine.audio_player.get_room_rolloff_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_room_rolloff_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audio_player.get_sample_offset</h1>
<pre><code class="language-lua">function ncine.audio_player.get_sample_offset(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_sample_offset(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.get_velocity</h1>
<pre><code class="language-lua">function ncine.audio_player.get_velocity(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.get_velocity(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.audio_player.has_aux_filter</h1>
<pre><code class="language-lua">function ncine.audio_player.has_aux_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.has_aux_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.has_direct_filter</h1>
<pre><code class="language-lua">function ncine.audio_player.has_direct_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.has_direct_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.has_effect_slot</h1>
<pre><code class="language-lua">function ncine.audio_player.has_effect_slot(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.has_effect_slot(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.has_source</h1>
<pre><code class="language-lua">function ncine.audio_player.has_source(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.has_source(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.is_looping</h1>
<pre><code class="language-lua">function ncine.audio_player.is_looping(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.is_looping(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.is_paused</h1>
<pre><code class="language-lua">function ncine.audio_player.is_paused(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.is_paused(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.is_playing</h1>
<pre><code class="language-lua">function ncine.audio_player.is_playing(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.is_playing(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.is_source_locked</h1>
<pre><code class="language-lua">function ncine.audio_player.is_source_locked(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.is_source_locked(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.is_stopped</h1>
<pre><code class="language-lua">function ncine.audio_player.is_stopped(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.is_stopped(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.audio_player.num_channels</h1>
<pre><code class="language-lua">function ncine.audio_player.num_channels(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.num_channels(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.num_samples</h1>
<pre><code class="language-lua">function ncine.audio_player.num_samples(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.num_samples(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.pause</h1>
<pre><code class="language-lua">function ncine.audio_player.pause(player: audioplayerObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.pause(player: audioplayerObj)
</code></pre>
<hr>
<h1>ncine.audio_player.play</h1>
<pre><code class="language-lua">function ncine.audio_player.play(player: audioplayerObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.play(player: audioplayerObj)
</code></pre>
<hr>
<h1>ncine.audio_player.set_air_absorption_factor</h1>
<pre><code class="language-lua">function ncine.audio_player.set_air_absorption_factor(player: audioplayerObj, factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_air_absorption_factor(player: audioplayerObj, factor: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_cone_inner_angle</h1>
<pre><code class="language-lua">function ncine.audio_player.set_cone_inner_angle(player: audioplayerObj, angle: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_cone_inner_angle(player: audioplayerObj, angle: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_cone_outer_angle</h1>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_angle(player: audioplayerObj, angle: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_angle(player: audioplayerObj, angle: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_cone_outer_gain</h1>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain(player: audioplayerObj, gain: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain(player: audioplayerObj, gain: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_cone_outer_gain_hf</h1>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain_hf(player: audioplayerObj, gain: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain_hf(player: audioplayerObj, gain: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_direct_filter</h1>
<pre><code class="language-lua">function ncine.audio_player.set_direct_filter(player: audioplayerObj, audio_filter?: audiofilterObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_direct_filter(player: audioplayerObj, audio_filter?: audiofilterObj)
</code></pre>
<hr>
<h1>ncine.audio_player.set_direction</h1>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction_x: number, direction_y: number, direction_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction_x: number, direction_y: number, direction_z: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_effect_slot</h1>
<pre><code class="language-lua">function ncine.audio_player.set_effect_slot(player: audioplayerObj, audio_effect_slot?: audioeffectslotObj, audio_filter?: audiofilterObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_effect_slot(player: audioplayerObj, audio_effect_slot?: audioeffectslotObj, audio_filter?: audiofilterObj)
</code></pre>
<hr>
<h1>ncine.audio_player.set_gain</h1>
<pre><code class="language-lua">function ncine.audio_player.set_gain(player: audioplayerObj, gain: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_gain(player: audioplayerObj, gain: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_looping</h1>
<pre><code class="language-lua">function ncine.audio_player.set_looping(player: audioplayerObj, looping: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_looping(player: audioplayerObj, looping: boolean)
</code></pre>
<hr>
<h1>ncine.audio_player.set_pitch</h1>
<pre><code class="language-lua">function ncine.audio_player.set_pitch(player: audioplayerObj, pitch: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_pitch(player: audioplayerObj, pitch: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_position</h1>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position_x: number, position_y: number, position_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position_x: number, position_y: number, position_z: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_room_rolloff_factor</h1>
<pre><code class="language-lua">function ncine.audio_player.set_room_rolloff_factor(player: audioplayerObj, factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_room_rolloff_factor(player: audioplayerObj, factor: number)
</code></pre>
<hr>
<h1>ncine.audio_player.set_sample_offset</h1>
<pre><code class="language-lua">function ncine.audio_player.set_sample_offset(player: audioplayerObj, offset: integer)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_sample_offset(player: audioplayerObj, offset: integer)
</code></pre>
<hr>
<h1>ncine.audio_player.set_source_locked</h1>
<pre><code class="language-lua">function ncine.audio_player.set_source_locked(player: audioplayerObj, locked: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_source_locked(player: audioplayerObj, locked: boolean)
</code></pre>
<hr>
<h1>ncine.audio_player.set_velocity</h1>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity_x: number, velocity_y: number, velocity_z: number)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity: ncine.vec3)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity_x: number, velocity_y: number, velocity_z: number)
</code></pre>
<hr>
<h1>ncine.audio_player.source_id</h1>
<pre><code class="language-lua">function ncine.audio_player.source_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.source_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audio_player.stop</h1>
<pre><code class="language-lua">function ncine.audio_player.stop(player: audioplayerObj)
</code></pre>
<pre><code class="language-lua">function ncine.audio_player.stop(player: audioplayerObj)
</code></pre>
<hr>
<h1>ncine.audiobuffer</h1>
<h2>buffer_id</h2>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_id(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL buffer id</p>
<h2>buffer_size</h2>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_size(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the buffer in bytes</p>
<h2>bytes_per_sample</h2>
<pre><code class="language-lua">function ncine.audiobuffer.bytes_per_sample(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns the number of bytes per sample</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audiobuffer.delete(audiobuffer: audiobufferObj)
</code></pre>
<p>Destroys an audio buffer object and releases its memory</p>
<p>@<em>param</em> <code>audiobuffer</code> — The audio buffer object to be destroyed</p>
<h2>duration</h2>
<pre><code class="language-lua">function ncine.audiobuffer.duration(audiobuffer: audiobufferObj)
  -&gt; number
</code></pre>
<p>Returns the duration in seconds</p>
<h2>frequency</h2>
<pre><code class="language-lua">function ncine.audiobuffer.frequency(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns the samples frequency</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audiobuffer.new(filename: string)
  -&gt; audiobufferObj
</code></pre>
<p>Constructs an audio buffer object from an audio file</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/audiobuffer.lua#20">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>filename</code> — The path to an audio file</p>
<p>@<em>return</em> — A new audio buffer object</p>
<h2>num_channels</h2>
<pre><code class="language-lua">function ncine.audiobuffer.num_channels(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns the number of audio channels</p>
<h2>num_samples</h2>
<pre><code class="language-lua">function ncine.audiobuffer.num_samples(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<p>Returns number of samples</p>
<hr>
<h1>ncine.audiobuffer</h1>
<pre><code class="language-lua">ncine.audiobuffer
</code></pre>
<pre><code class="language-lua">ncine.audiobuffer
</code></pre>
<hr>
<h1>ncine.audiobuffer.buffer_id</h1>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_id(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_id(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer.buffer_size</h1>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_size(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.buffer_size(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer.bytes_per_sample</h1>
<pre><code class="language-lua">function ncine.audiobuffer.bytes_per_sample(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.bytes_per_sample(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer.delete</h1>
<pre><code class="language-lua">function ncine.audiobuffer.delete(audiobuffer: audiobufferObj)
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.delete(audiobuffer: audiobufferObj)
</code></pre>
<hr>
<h1>ncine.audiobuffer.duration</h1>
<pre><code class="language-lua">function ncine.audiobuffer.duration(audiobuffer: audiobufferObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.duration(audiobuffer: audiobufferObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.audiobuffer.frequency</h1>
<pre><code class="language-lua">function ncine.audiobuffer.frequency(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.frequency(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer.new</h1>
<pre><code class="language-lua">function ncine.audiobuffer.new(filename: string)
  -&gt; audiobufferObj
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.new(filename: string)
  -&gt; audiobufferObj
</code></pre>
<hr>
<h1>ncine.audiobuffer.num_channels</h1>
<pre><code class="language-lua">function ncine.audiobuffer.num_channels(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.num_channels(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer.num_samples</h1>
<pre><code class="language-lua">function ncine.audiobuffer.num_samples(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer.num_samples(audiobuffer: audiobufferObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiobuffer_player</h1>
<pre><code class="language-lua">ncine.audiobuffer_player
</code></pre>
<pre><code class="language-lua">ncine.audiobuffer_player
</code></pre>
<hr>
<h1>ncine.audiobuffer_player</h1>
<h2>buffer_id</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the currently playing buffer</p>
<h2>buffer_size</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_size(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>bytes_per_sample</h2>
<pre><code class="language-lua">function ncine.audio_player.bytes_per_sample(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of bytes per sample</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audiobuffer_player.delete(player: audiobufferplayerObj)
</code></pre>
<p>Destroys an audio buffer player object and releases its memory</p>
<p>@<em>param</em> <code>player</code> — The audio buffer player object to be destroyed</p>
<h2>duration</h2>
<pre><code class="language-lua">function ncine.audio_player.duration(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the duration in seconds</p>
<h2>frequency</h2>
<pre><code class="language-lua">function ncine.audio_player.frequency(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the samples frequency of the currently playing buffer</p>
<h2>get_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_air_absorption_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player air absorption factor</p>
<h2>get_audiobuffer</h2>
<pre><code class="language-lua">function ncine.audiobuffer_player.get_audiobuffer(player: audiobufferplayerObj)
  -&gt; audiobufferObj
</code></pre>
<p>Gets the audio buffer used for playing</p>
<h2>get_aux_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_aux_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the auxiliary filter</p>
<h2>get_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_inner_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player inside angle of the sound cone in degrees</p>
<h2>get_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player outside angle of the sound cone in degrees</p>
<h2>get_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player multiplication factor to determine the gain outside the cone</p>
<h2>get_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain_hf(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player cone outer gain HF value</p>
<h2>get_direct_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direct_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the direct filter</p>
<h2>get_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direction(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player direction vector</p>
<h2>get_effect_slot_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_effect_slot_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the effect slot</p>
<h2>get_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player gain value</p>
<h2>get_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.get_pitch(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player pitch value</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.audio_player.get_position(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player position vector</p>
<h2>get_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_room_rolloff_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player room rolloff factor</p>
<h2>get_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.get_sample_offset(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>get_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.get_velocity(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player velocity vector</p>
<h2>has_aux_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_aux_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL auxiliary filter is currently assigned to the player</p>
<h2>has_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_direct_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL direct filter is currently assigned to the player</p>
<h2>has_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.has_effect_slot(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL effect slot is currently assigned to the player</p>
<h2>has_source</h2>
<pre><code class="language-lua">function ncine.audio_player.has_source(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL source is currently assigned to the player</p>
<h2>is_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.is_looping(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns the looping property of the player</p>
<h2>is_paused</h2>
<pre><code class="language-lua">function ncine.audio_player.is_paused(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is paused</p>
<h2>is_playing</h2>
<pre><code class="language-lua">function ncine.audio_player.is_playing(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is playing</p>
<h2>is_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.is_source_locked(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the OpenAL source is locked</p>
<h2>is_stopped</h2>
<pre><code class="language-lua">function ncine.audio_player.is_stopped(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is stopped</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audiobuffer_player.new(buffer: audiobufferObj)
  -&gt; audiobufferplayerObj
</code></pre>
<p>Constructs an audio buffer player object from an audio buffer</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/audiobuffer_player.lua#20">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new audio buffer player object</p>
<h2>num_channels</h2>
<pre><code class="language-lua">function ncine.audio_player.num_channels(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of audio channels of the currently playing buffer</p>
<h2>num_samples</h2>
<pre><code class="language-lua">function ncine.audio_player.num_samples(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of samples</p>
<h2>pause</h2>
<pre><code class="language-lua">function ncine.audio_player.pause(player: audioplayerObj)
</code></pre>
<p>Pauses playing</p>
<h2>play</h2>
<pre><code class="language-lua">function ncine.audio_player.play(player: audioplayerObj)
</code></pre>
<p>Starts playing</p>
<h2>set_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_air_absorption_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player air absorption factor</p>
<h2>set_audiobuffer</h2>
<pre><code class="language-lua">function ncine.audiobuffer_player.set_audiobuffer(player: audiobufferplayerObj, buffer: audiobufferObj)
</code></pre>
<p>Sets the audio buffer used for playing</p>
<h2>set_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_inner_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player inside angle of the sound cone in degrees</p>
<h2>set_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player outside angle of the sound cone in degrees</p>
<h2>set_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player multiplication factor to determine the gain outside the cone</p>
<h2>set_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain_hf(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player cone outer gain HF value</p>
<h2>set_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direct_filter(player: audioplayerObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes the filter parameters from a filter object to the direct signal</p>
<h2>set_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction: ncine.vec3)
</code></pre>
<p>Sets the player direction vector</p>
<h2>set_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.set_effect_slot(player: audioplayerObj, audio_effect_slot?: audioeffectslotObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes an affect slot, with an optional auxiliary filter, to the player</p>
<h2>set_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player gain value</p>
<h2>set_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.set_looping(player: audioplayerObj, looping: boolean)
</code></pre>
<p>Sets the looping property of the player</p>
<h2>set_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.set_pitch(player: audioplayerObj, pitch: number)
</code></pre>
<p>Sets the player pitch value</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position: ncine.vec3)
</code></pre>
<p>Sets the player position vector</p>
<h2>set_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_room_rolloff_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player room rolloff factor</p>
<h2>set_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.set_sample_offset(player: audioplayerObj, offset: integer)
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>set_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.set_source_locked(player: audioplayerObj, locked: boolean)
</code></pre>
<p>Locks an OpenAL source so it is not released to the pool when the player stops</p>
<h2>set_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity: ncine.vec3)
</code></pre>
<p>Sets the player velocity vector</p>
<h2>source_id</h2>
<pre><code class="language-lua">function ncine.audio_player.source_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the player source</p>
<h2>stop</h2>
<pre><code class="language-lua">function ncine.audio_player.stop(player: audioplayerObj)
</code></pre>
<p>Stops playing and rewinds</p>
<hr>
<h1>ncine.audiobuffer_player.delete</h1>
<pre><code class="language-lua">function ncine.audiobuffer_player.delete(player: audiobufferplayerObj)
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer_player.delete(player: audiobufferplayerObj)
</code></pre>
<hr>
<h1>ncine.audiobuffer_player.get_audiobuffer</h1>
<pre><code class="language-lua">function ncine.audiobuffer_player.get_audiobuffer(player: audiobufferplayerObj)
  -&gt; audiobufferObj
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer_player.get_audiobuffer(player: audiobufferplayerObj)
  -&gt; audiobufferObj
</code></pre>
<hr>
<h1>ncine.audiobuffer_player.new</h1>
<pre><code class="language-lua">function ncine.audiobuffer_player.new(buffer: audiobufferObj)
  -&gt; audiobufferplayerObj
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer_player.new(buffer: audiobufferObj)
  -&gt; audiobufferplayerObj
</code></pre>
<hr>
<h1>ncine.audiobuffer_player.set_audiobuffer</h1>
<pre><code class="language-lua">function ncine.audiobuffer_player.set_audiobuffer(player: audiobufferplayerObj, buffer: audiobufferObj)
</code></pre>
<pre><code class="language-lua">function ncine.audiobuffer_player.set_audiobuffer(player: audiobufferplayerObj, buffer: audiobufferObj)
</code></pre>
<hr>
<h1>ncine.audiostream_player</h1>
<pre><code class="language-lua">ncine.audiostream_player
</code></pre>
<pre><code class="language-lua">ncine.audiostream_player
</code></pre>
<hr>
<h1>ncine.audiostream_player</h1>
<h2>buffer_id</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the currently playing buffer</p>
<h2>buffer_size</h2>
<pre><code class="language-lua">function ncine.audio_player.buffer_size(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>bytes_per_sample</h2>
<pre><code class="language-lua">function ncine.audio_player.bytes_per_sample(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of bytes per sample</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.audiostream_player.delete(player: audiostreamplayerObj)
</code></pre>
<p>Destroys an audio stream player object and releases its memory</p>
<p>@<em>param</em> <code>player</code> — The audio stream player object to be destroyed</p>
<h2>duration</h2>
<pre><code class="language-lua">function ncine.audio_player.duration(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the duration in seconds</p>
<h2>frequency</h2>
<pre><code class="language-lua">function ncine.audio_player.frequency(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the samples frequency of the currently playing buffer</p>
<h2>get_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_air_absorption_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player air absorption factor</p>
<h2>get_aux_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_aux_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the auxiliary filter</p>
<h2>get_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_inner_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player inside angle of the sound cone in degrees</p>
<h2>get_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_angle(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player outside angle of the sound cone in degrees</p>
<h2>get_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player multiplication factor to determine the gain outside the cone</p>
<h2>get_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.get_cone_outer_gain_hf(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player cone outer gain HF value</p>
<h2>get_direct_filter_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direct_filter_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the direct filter</p>
<h2>get_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.get_direction(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player direction vector</p>
<h2>get_effect_slot_id</h2>
<pre><code class="language-lua">function ncine.audio_player.get_effect_slot_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the effect slot</p>
<h2>get_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.get_gain(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player gain value</p>
<h2>get_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.get_pitch(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player pitch value</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.audio_player.get_position(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player position vector</p>
<h2>get_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.get_room_rolloff_factor(player: audioplayerObj)
  -&gt; number
</code></pre>
<p>Returns the player room rolloff factor</p>
<h2>get_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.get_sample_offset(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>get_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.get_velocity(player: audioplayerObj)
  -&gt; ncine.vec3
</code></pre>
<p>Returns the player velocity vector</p>
<h2>has_aux_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_aux_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL auxiliary filter is currently assigned to the player</p>
<h2>has_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.has_direct_filter(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL direct filter is currently assigned to the player</p>
<h2>has_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.has_effect_slot(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL effect slot is currently assigned to the player</p>
<h2>has_source</h2>
<pre><code class="language-lua">function ncine.audio_player.has_source(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if a valid OpenAL source is currently assigned to the player</p>
<h2>is_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.is_looping(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns the looping property of the player</p>
<h2>is_paused</h2>
<pre><code class="language-lua">function ncine.audio_player.is_paused(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is paused</p>
<h2>is_playing</h2>
<pre><code class="language-lua">function ncine.audio_player.is_playing(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is playing</p>
<h2>is_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.is_source_locked(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the OpenAL source is locked</p>
<h2>is_stopped</h2>
<pre><code class="language-lua">function ncine.audio_player.is_stopped(player: audioplayerObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the player is stopped</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.audiostream_player.new(filename: string)
  -&gt; audiostreamplayerObj
</code></pre>
<p>Constructs an audio stream player object from an audio file</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/audiostream_player.lua#20">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>filename</code> — The path to an audio file</p>
<p>@<em>return</em> — A new audio stream player object</p>
<h2>num_channels</h2>
<pre><code class="language-lua">function ncine.audio_player.num_channels(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of audio channels of the currently playing buffer</p>
<h2>num_samples</h2>
<pre><code class="language-lua">function ncine.audio_player.num_samples(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of samples</p>
<h2>num_samples_in_streambuffer</h2>
<pre><code class="language-lua">function ncine.audiostream_player.num_samples_in_streambuffer(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the number of samples in the streaming buffer</p>
<h2>pause</h2>
<pre><code class="language-lua">function ncine.audio_player.pause(player: audioplayerObj)
</code></pre>
<p>Pauses playing</p>
<h2>play</h2>
<pre><code class="language-lua">function ncine.audio_player.play(player: audioplayerObj)
</code></pre>
<p>Starts playing</p>
<h2>sample_offset_in_stream</h2>
<pre><code class="language-lua">function ncine.audiostream_player.sample_offset_in_stream(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the sample offset relative to the whole stream</p>
<h2>set_air_absorption_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_air_absorption_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player air absorption factor</p>
<h2>set_cone_inner_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_inner_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player inside angle of the sound cone in degrees</p>
<h2>set_cone_outer_angle</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_angle(player: audioplayerObj, angle: number)
</code></pre>
<p>Sets the player outside angle of the sound cone in degrees</p>
<h2>set_cone_outer_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player multiplication factor to determine the gain outside the cone</p>
<h2>set_cone_outer_gain_hf</h2>
<pre><code class="language-lua">function ncine.audio_player.set_cone_outer_gain_hf(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player cone outer gain HF value</p>
<h2>set_direct_filter</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direct_filter(player: audioplayerObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes the filter parameters from a filter object to the direct signal</p>
<h2>set_direction</h2>
<pre><code class="language-lua">function ncine.audio_player.set_direction(player: audioplayerObj, direction: ncine.vec3)
</code></pre>
<p>Sets the player direction vector</p>
<h2>set_effect_slot</h2>
<pre><code class="language-lua">function ncine.audio_player.set_effect_slot(player: audioplayerObj, audio_effect_slot?: audioeffectslotObj, audio_filter?: audiofilterObj)
</code></pre>
<p>Sets or removes an affect slot, with an optional auxiliary filter, to the player</p>
<h2>set_gain</h2>
<pre><code class="language-lua">function ncine.audio_player.set_gain(player: audioplayerObj, gain: number)
</code></pre>
<p>Sets the player gain value</p>
<h2>set_looping</h2>
<pre><code class="language-lua">function ncine.audio_player.set_looping(player: audioplayerObj, looping: boolean)
</code></pre>
<p>Sets the looping property of the player</p>
<h2>set_pitch</h2>
<pre><code class="language-lua">function ncine.audio_player.set_pitch(player: audioplayerObj, pitch: number)
</code></pre>
<p>Sets the player pitch value</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.audio_player.set_position(player: audioplayerObj, position: ncine.vec3)
</code></pre>
<p>Sets the player position vector</p>
<h2>set_room_rolloff_factor</h2>
<pre><code class="language-lua">function ncine.audio_player.set_room_rolloff_factor(player: audioplayerObj, factor: number)
</code></pre>
<p>Sets the player room rolloff factor</p>
<h2>set_sample_offset</h2>
<pre><code class="language-lua">function ncine.audio_player.set_sample_offset(player: audioplayerObj, offset: integer)
</code></pre>
<p>Returns the size of the currently playing buffer in bytes</p>
<h2>set_source_locked</h2>
<pre><code class="language-lua">function ncine.audio_player.set_source_locked(player: audioplayerObj, locked: boolean)
</code></pre>
<p>Locks an OpenAL source so it is not released to the pool when the player stops</p>
<h2>set_velocity</h2>
<pre><code class="language-lua">function ncine.audio_player.set_velocity(player: audioplayerObj, velocity: ncine.vec3)
</code></pre>
<p>Sets the player velocity vector</p>
<h2>source_id</h2>
<pre><code class="language-lua">function ncine.audio_player.source_id(player: audioplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the OpenAL id of the player source</p>
<h2>stop</h2>
<pre><code class="language-lua">function ncine.audio_player.stop(player: audioplayerObj)
</code></pre>
<p>Stops playing and rewinds</p>
<h2>streambuffer_size</h2>
<pre><code class="language-lua">function ncine.audiostream_player.streambuffer_size(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<p>Returns the size of the streaming buffer in bytes</p>
<hr>
<h1>ncine.audiostream_player.delete</h1>
<pre><code class="language-lua">function ncine.audiostream_player.delete(player: audiostreamplayerObj)
</code></pre>
<pre><code class="language-lua">function ncine.audiostream_player.delete(player: audiostreamplayerObj)
</code></pre>
<hr>
<h1>ncine.audiostream_player.new</h1>
<pre><code class="language-lua">function ncine.audiostream_player.new(filename: string)
  -&gt; audiostreamplayerObj
</code></pre>
<pre><code class="language-lua">function ncine.audiostream_player.new(filename: string)
  -&gt; audiostreamplayerObj
</code></pre>
<hr>
<h1>ncine.audiostream_player.num_samples_in_streambuffer</h1>
<pre><code class="language-lua">function ncine.audiostream_player.num_samples_in_streambuffer(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiostream_player.num_samples_in_streambuffer(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiostream_player.sample_offset_in_stream</h1>
<pre><code class="language-lua">function ncine.audiostream_player.sample_offset_in_stream(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiostream_player.sample_offset_in_stream(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.audiostream_player.streambuffer_size</h1>
<pre><code class="language-lua">function ncine.audiostream_player.streambuffer_size(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.audiostream_player.streambuffer_size(player: audiostreamplayerObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.base_sprite</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of the node area</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the texture source rectangle for blitting</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture object</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of the node area</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>is_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is horizontally flipped</p>
<h2>is_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is vertically flipped</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>reset_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<p>Triggers a texture update without setting a new texture</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<p>Flips the texture rect horizontally</p>
<h2>set_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<p>Flips the texture rect vertically</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_size</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<p>Sets the sprite size</p>
<h2>set_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<p>Sets the texture source rectangle for blitting</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<p>Sets the texture object</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.base_sprite</h1>
<pre><code class="language-lua">ncine.base_sprite
</code></pre>
<pre><code class="language-lua">ncine.base_sprite
</code></pre>
<hr>
<h1>ncine.base_sprite.get_texrect</h1>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.base_sprite.get_texture</h1>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<hr>
<h1>ncine.base_sprite.is_flipped_x</h1>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.base_sprite.is_flipped_y</h1>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.base_sprite.reset_texture</h1>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<hr>
<h1>ncine.base_sprite.set_flipped_x</h1>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<hr>
<h1>ncine.base_sprite.set_flipped_y</h1>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<hr>
<h1>ncine.base_sprite.set_size</h1>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<hr>
<h1>ncine.base_sprite.set_texrect</h1>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<hr>
<h1>ncine.base_sprite.set_texture</h1>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<hr>
<h1>ncine.blending_factor</h1>
<pre><code class="language-lua">enum ncine.blending_factor
</code></pre>
<pre><code class="language-lua">enum ncine.blending_factor
</code></pre>
<hr>
<h1>ncine.blending_preset</h1>
<pre><code class="language-lua">enum ncine.blending_preset
</code></pre>
<pre><code class="language-lua">enum ncine.blending_preset
</code></pre>
<hr>
<h1>ncine.camera</h1>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.camera.delete(camera: cameraObj)
</code></pre>
<p>Destroys a camera object and releases its memory</p>
<p>@<em>param</em> <code>camera</code> — The camera object to be destroyed</p>
<h2>get_projection_values</h2>
<pre><code class="language-lua">function ncine.camera.get_projection_values(camera: cameraObj)
  -&gt; camera_projection_values
</code></pre>
<p>Returns the projection values that are used to create the projection matrix</p>
<h2>get_view_values</h2>
<pre><code class="language-lua">function ncine.camera.get_view_values(camera: cameraObj)
  -&gt; camera_view_values
</code></pre>
<p>Returns the view values that are used to create the model matrix</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.camera.new()
  -&gt; cameraObj
</code></pre>
<p>Constructs a camera object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/camera.lua#33">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new camera object</p>
<h2>set_ortho_projection</h2>
<pre><code class="language-lua">function ncine.camera.set_ortho_projection(camera: cameraObj, projection_values: camera_projection_values)
</code></pre>
<p>Updates the projection matrix using the projection values from the table</p>
<h2>set_view</h2>
<pre><code class="language-lua">function ncine.camera.set_view(camera: cameraObj, view_values: camera_view_values)
</code></pre>
<p>Updates the model matrix using the view values from the table</p>
<hr>
<h1>ncine.camera</h1>
<pre><code class="language-lua">ncine.camera
</code></pre>
<pre><code class="language-lua">ncine.camera
</code></pre>
<hr>
<h1>ncine.camera.delete</h1>
<pre><code class="language-lua">function ncine.camera.delete(camera: cameraObj)
</code></pre>
<pre><code class="language-lua">function ncine.camera.delete(camera: cameraObj)
</code></pre>
<hr>
<h1>ncine.camera.get_projection_values</h1>
<pre><code class="language-lua">function ncine.camera.get_projection_values(camera: cameraObj)
  -&gt; camera_projection_values
</code></pre>
<pre><code class="language-lua">function ncine.camera.get_projection_values(camera: cameraObj)
  -&gt; camera_projection_values
</code></pre>
<hr>
<h1>ncine.camera.get_view_values</h1>
<pre><code class="language-lua">function ncine.camera.get_view_values(camera: cameraObj)
  -&gt; camera_view_values
</code></pre>
<pre><code class="language-lua">function ncine.camera.get_view_values(camera: cameraObj)
  -&gt; camera_view_values
</code></pre>
<hr>
<h1>ncine.camera.new</h1>
<pre><code class="language-lua">function ncine.camera.new()
  -&gt; cameraObj
</code></pre>
<pre><code class="language-lua">function ncine.camera.new()
  -&gt; cameraObj
</code></pre>
<hr>
<h1>ncine.camera.set_ortho_projection</h1>
<pre><code class="language-lua">function ncine.camera.set_ortho_projection(camera: cameraObj, projection_values: camera_projection_values)
</code></pre>
<pre><code class="language-lua">function ncine.camera.set_ortho_projection(camera: cameraObj, projection_values: camera_projection_values)
</code></pre>
<hr>
<h1>ncine.camera.set_view</h1>
<pre><code class="language-lua">function ncine.camera.set_view(camera: cameraObj, view_values: camera_view_values)
</code></pre>
<pre><code class="language-lua">function ncine.camera.set_view(camera: cameraObj, view_values: camera_view_values)
</code></pre>
<hr>
<h1>ncine.clear_mode</h1>
<pre><code class="language-lua">enum ncine.clear_mode
</code></pre>
<pre><code class="language-lua">enum ncine.clear_mode
</code></pre>
<hr>
<h1>ncine.color</h1>
<pre><code class="language-lua">ncine.color
</code></pre>
<pre><code class="language-lua">ncine.color
</code></pre>
<hr>
<h1>ncine.color</h1>
<h2>a</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The alpha component</p>
<h2>add</h2>
<pre><code class="language-lua">function ncine.color.add(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<p>Adds two colors together, component-wise, clamping to 1.0</p>
<h2>b</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The blue component</p>
<h2>create</h2>
<pre><code class="language-lua">function ncine.color.create(r: number, g: number, b: number, a: number)
  -&gt; ncine.color
</code></pre>
<p>Creates a color table from its components</p>
<p>@<em>param</em> <code>r</code> — The red component</p>
<p>@<em>param</em> <code>g</code> — The green component</p>
<p>@<em>param</em> <code>b</code> — The blue component</p>
<p>@<em>param</em> <code>a</code> — The alpha component</p>
<h2>g</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The green component</p>
<h2>mul</h2>
<pre><code class="language-lua">function ncine.color.mul(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<p>Multiplies two colors together, component-wise, clamping to 1.0</p>
<h2>r</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The red component</p>
<h2>sub</h2>
<pre><code class="language-lua">function ncine.color.sub(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<p>Subtracts the second color from the first one, component-wise, clamping to 0.0</p>
<hr>
<h1>ncine.color.add</h1>
<pre><code class="language-lua">function ncine.color.add(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.add(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.color.create</h1>
<pre><code class="language-lua">function ncine.color.create(r: number, g: number, b: number, a: number)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.create(r: number, g: number, b: number, a: number)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.color.mul</h1>
<pre><code class="language-lua">function ncine.color.mul(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.mul(color0: ncine.color, scalar: number)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.mul(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.mul(color0: ncine.color, scalar: number)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.color.sub</h1>
<pre><code class="language-lua">function ncine.color.sub(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.color.sub(color0: ncine.color, color1: ncine.color)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.colors</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.BLACK</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.BLUE</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.CYAN</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.GREEN</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.MAGENTA</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.RED</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.WHITE</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.colors.YELLOW</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.depth_stencil_format</h1>
<pre><code class="language-lua">enum ncine.depth_stencil_format
</code></pre>
<pre><code class="language-lua">enum ncine.depth_stencil_format
</code></pre>
<hr>
<h1>ncine.drawable_node</h1>
<pre><code class="language-lua">ncine.drawable_node
</code></pre>
<pre><code class="language-lua">ncine.drawable_node
</code></pre>
<hr>
<h1>ncine.drawable_node</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of the node area</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of the node area</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.drawable_node.get_aabb</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.drawable_node.get_anchor_point</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.drawable_node.get_dest_blending_factor</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<hr>
<h1>ncine.drawable_node.get_height</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.drawable_node.get_last_frame_rendered</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.drawable_node.get_size</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.drawable_node.get_src_blending_factor</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<hr>
<h1>ncine.drawable_node.get_width</h1>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.drawable_node.is_blending_enabled</h1>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.drawable_node.set_anchor_point</h1>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, x: number, y: number)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, x: number, y: number)
</code></pre>
<hr>
<h1>ncine.drawable_node.set_blending_enabled</h1>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<hr>
<h1>ncine.drawable_node.set_blending_factors</h1>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<hr>
<h1>ncine.drawable_node.set_blending_preset</h1>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<hr>
<h1>ncine.efx_reverb_presets</h1>
<pre><code class="language-lua">enum ncine.efx_reverb_presets
</code></pre>
<pre><code class="language-lua">enum ncine.efx_reverb_presets
</code></pre>
<hr>
<h1>ncine.font</h1>
<pre><code class="language-lua">ncine.font
</code></pre>
<pre><code class="language-lua">ncine.font
</code></pre>
<hr>
<h1>ncine.font</h1>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.font.delete(font: fontObj)
</code></pre>
<p>Destroys a font object and releases its memory</p>
<p>@<em>param</em> <code>font</code> — The font object to be destroyed</p>
<h2>get_base</h2>
<pre><code class="language-lua">function ncine.font.get_base(font: fontObj)
  -&gt; integer
</code></pre>
<p>Returns the font base</p>
<h2>get_line_height</h2>
<pre><code class="language-lua">function ncine.font.get_line_height(font: fontObj)
  -&gt; integer
</code></pre>
<p>Returns the font line height</p>
<h2>get_render_mode</h2>
<pre><code class="language-lua">function ncine.font.get_render_mode(font: fontObj)
  -&gt; ncine.font_render_mode
</code></pre>
<p>Returns the mode detected by the font to render text nodes</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.font.get_texture(font: fontObj)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture object in use by the font</p>
<h2>get_texture_size</h2>
<pre><code class="language-lua">function ncine.font.get_texture_size(font: fontObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the texture atlas size</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.font.new(fnt_file: string, texture_file: string)
  -&gt; fontObj
</code></pre>
<p>Constructs the font object from an AngelCode's <code>FNT</code> file and a texture file</p>
<p>If the <code>texture_file</code> parameter is an empty string, then a texture with the same name as the <code>FNT</code> file is searched in the same path</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/font.lua#31">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>fnt_file</code> — The path to a <code>FNT</code> file</p>
<p>@<em>param</em> <code>texture_file</code> — The path to a texture file</p>
<p>@<em>return</em> — A new font object</p>
<h2>num_glyphs</h2>
<pre><code class="language-lua">function ncine.font.num_glyphs(font: fontObj)
  -&gt; integer
</code></pre>
<p>Returns the number of glyphs</p>
<h2>num_kernings</h2>
<pre><code class="language-lua">function ncine.font.num_kernings(font: fontObj)
  -&gt; integer
</code></pre>
<p>Returns the number of kerning pairs</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.font.set_texture(font: fontObj, texture?: textureObj)
</code></pre>
<p>Sets a new shared texture object without modifying any glyphs or kerning data</p>
<hr>
<h1>ncine.font.delete</h1>
<pre><code class="language-lua">function ncine.font.delete(font: fontObj)
</code></pre>
<pre><code class="language-lua">function ncine.font.delete(font: fontObj)
</code></pre>
<hr>
<h1>ncine.font.get_base</h1>
<pre><code class="language-lua">function ncine.font.get_base(font: fontObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.font.get_base(font: fontObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.font.get_line_height</h1>
<pre><code class="language-lua">function ncine.font.get_line_height(font: fontObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.font.get_line_height(font: fontObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.font.get_render_mode</h1>
<pre><code class="language-lua">function ncine.font.get_render_mode(font: fontObj)
  -&gt; ncine.font_render_mode
</code></pre>
<pre><code class="language-lua">function ncine.font.get_render_mode(font: fontObj)
  -&gt; ncine.font_render_mode
</code></pre>
<hr>
<h1>ncine.font.get_texture</h1>
<pre><code class="language-lua">function ncine.font.get_texture(font: fontObj)
  -&gt; textureObj?
</code></pre>
<pre><code class="language-lua">function ncine.font.get_texture(font: fontObj)
  -&gt; textureObj?
</code></pre>
<hr>
<h1>ncine.font.get_texture_size</h1>
<pre><code class="language-lua">function ncine.font.get_texture_size(font: fontObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.font.get_texture_size(font: fontObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.font.new</h1>
<pre><code class="language-lua">function ncine.font.new(fnt_file: string, texture_file: string)
  -&gt; fontObj
</code></pre>
<pre><code class="language-lua">function ncine.font.new(fnt_file: string, texture_file: string)
  -&gt; fontObj
</code></pre>
<hr>
<h1>ncine.font.num_glyphs</h1>
<pre><code class="language-lua">function ncine.font.num_glyphs(font: fontObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.font.num_glyphs(font: fontObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.font.num_kernings</h1>
<pre><code class="language-lua">function ncine.font.num_kernings(font: fontObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.font.num_kernings(font: fontObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.font.set_texture</h1>
<pre><code class="language-lua">function ncine.font.set_texture(font: fontObj, texture?: textureObj)
</code></pre>
<pre><code class="language-lua">function ncine.font.set_texture(font: fontObj, texture?: textureObj)
</code></pre>
<hr>
<h1>ncine.font_render_mode</h1>
<pre><code class="language-lua">enum ncine.font_render_mode
</code></pre>
<pre><code class="language-lua">enum ncine.font_render_mode
</code></pre>
<hr>
<h1>ncine.frame_timer</h1>
<pre><code class="language-lua">ncine.frame_timer
</code></pre>
<pre><code class="language-lua">ncine.frame_timer
</code></pre>
<hr>
<h1>ncine.frame_timer</h1>
<h2>average_fps</h2>
<pre><code class="language-lua">function ncine.frame_timer.average_fps()
  -&gt; number
</code></pre>
<p>Returns the average FPS during the update interval</p>
<h2>average_frame_time</h2>
<pre><code class="language-lua">function ncine.frame_timer.average_frame_time()
  -&gt; number
</code></pre>
<p>Returns the average frame time in seconds during the update interval</p>
<h2>current_frame_duration</h2>
<pre><code class="language-lua">function ncine.frame_timer.current_frame_duration()
  -&gt; number
</code></pre>
<p>Returns the elapsed time in seconds since current frame started</p>
<h2>get_average_interval</h2>
<pre><code class="language-lua">function ncine.frame_timer.get_average_interval()
  -&gt; number
</code></pre>
<p>Returns the number of seconds between two average FPS calculations</p>
<h2>get_log_level</h2>
<pre><code class="language-lua">function ncine.frame_timer.get_log_level()
  -&gt; ncine.log_level
</code></pre>
<p>Returns the level for the logging events</p>
<h2>get_logging_interval</h2>
<pre><code class="language-lua">function ncine.frame_timer.get_logging_interval()
  -&gt; number
</code></pre>
<p>Returns the number of seconds between two logging events</p>
<p>A different and independent average is calculated over this time interval.</p>
<h2>is_average_enabled</h2>
<pre><code class="language-lua">function ncine.frame_timer.is_average_enabled()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the average FPS calculation is enabled</p>
<h2>is_logging_enabled</h2>
<pre><code class="language-lua">function ncine.frame_timer.is_logging_enabled()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if logging of averages is enabled</p>
<h2>last_frame_duration</h2>
<pre><code class="language-lua">function ncine.frame_timer.last_frame_duration()
  -&gt; number
</code></pre>
<p>Returns the time in seconds that last frame took to complete</p>
<h2>set_average_interval</h2>
<pre><code class="language-lua">function ncine.frame_timer.set_average_interval(interval: number)
</code></pre>
<p>Sets the number of seconds between two average FPS calculations</p>
<h2>set_log_level</h2>
<pre><code class="language-lua">function ncine.frame_timer.set_log_level(log_level: ncine.log_level)
</code></pre>
<p>Sets the level for the logging events</p>
<h2>set_logging_interval</h2>
<pre><code class="language-lua">function ncine.frame_timer.set_logging_interval(interval: number)
</code></pre>
<p>Sets the number of seconds between two logging events</p>
<h2>total_number_frames</h2>
<pre><code class="language-lua">function ncine.frame_timer.total_number_frames()
  -&gt; integer
</code></pre>
<p>Returns the total number of frames rendered since the application started</p>
<hr>
<h1>ncine.frame_timer.average_fps</h1>
<pre><code class="language-lua">function ncine.frame_timer.average_fps()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.average_fps()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.average_frame_time</h1>
<pre><code class="language-lua">function ncine.frame_timer.average_frame_time()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.average_frame_time()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.current_frame_duration</h1>
<pre><code class="language-lua">function ncine.frame_timer.current_frame_duration()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.current_frame_duration()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.get_average_interval</h1>
<pre><code class="language-lua">function ncine.frame_timer.get_average_interval()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.get_average_interval()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.get_log_level</h1>
<pre><code class="language-lua">function ncine.frame_timer.get_log_level()
  -&gt; ncine.log_level
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.get_log_level()
  -&gt; ncine.log_level
</code></pre>
<hr>
<h1>ncine.frame_timer.get_logging_interval</h1>
<pre><code class="language-lua">function ncine.frame_timer.get_logging_interval()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.get_logging_interval()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.is_average_enabled</h1>
<pre><code class="language-lua">function ncine.frame_timer.is_average_enabled()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.is_average_enabled()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.frame_timer.is_logging_enabled</h1>
<pre><code class="language-lua">function ncine.frame_timer.is_logging_enabled()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.is_logging_enabled()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.frame_timer.last_frame_duration</h1>
<pre><code class="language-lua">function ncine.frame_timer.last_frame_duration()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.last_frame_duration()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.frame_timer.set_average_interval</h1>
<pre><code class="language-lua">function ncine.frame_timer.set_average_interval(interval: number)
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.set_average_interval(interval: number)
</code></pre>
<hr>
<h1>ncine.frame_timer.set_log_level</h1>
<pre><code class="language-lua">function ncine.frame_timer.set_log_level(log_level: ncine.log_level)
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.set_log_level(log_level: ncine.log_level)
</code></pre>
<hr>
<h1>ncine.frame_timer.set_logging_interval</h1>
<pre><code class="language-lua">function ncine.frame_timer.set_logging_interval(interval: number)
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.set_logging_interval(interval: number)
</code></pre>
<hr>
<h1>ncine.frame_timer.total_number_frames</h1>
<pre><code class="language-lua">function ncine.frame_timer.total_number_frames()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.frame_timer.total_number_frames()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.fs</h1>
<h2>absolute_join_path</h2>
<pre><code class="language-lua">function ncine.fs.absolute_join_path(first: string, second: string)
  -&gt; string
</code></pre>
<p>Returns the absolute path after joining together two path components</p>
<h2>absolute_path</h2>
<pre><code class="language-lua">function ncine.fs.absolute_path(path: string)
  -&gt; string
</code></pre>
<p>Returns an absolute path from a relative one</p>
<p>It also resolves dot references to current and parent directories, and double separators.</p>
<h2>add_permissions</h2>
<pre><code class="language-lua">function ncine.fs.add_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<p>Adds the permissions in the mask to a file or a directory</p>
<p>@<em>param</em> <code>mode</code> — A mask created from values in <code>ncine.permission</code></p>
<p>@<em>return</em> — True if the new permission mode was added</p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#14#9">ncine.permission</a></p>
<h2>basename</h2>
<pre><code class="language-lua">function ncine.fs.basename(path: string)
  -&gt; string
</code></pre>
<p>Returns the path component after the final separator</p>
<h2>change_permissions</h2>
<pre><code class="language-lua">function ncine.fs.change_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<p>Returns the file or directory permissions in a mask</p>
<p>@<em>param</em> <code>mode</code> — A mask created from values in <code>ncine.permission</code></p>
<p>@<em>return</em> — True if the permission mode was changed</p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#14#9">ncine.permission</a></p>
<h2>copy</h2>
<pre><code class="language-lua">function ncine.fs.copy(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<p>Copies a file</p>
<p>@<em>return</em> — True if the file has been copied</p>
<h2>create_dir</h2>
<pre><code class="language-lua">function ncine.fs.create_dir(path: string)
  -&gt; boolean
</code></pre>
<p>Creates a new directory</p>
<p>@<em>return</em> — True if the new directory has been created</p>
<h2>delete_empty_dir</h2>
<pre><code class="language-lua">function ncine.fs.delete_empty_dir(path: string)
  -&gt; boolean
</code></pre>
<p>Deletes an empty directory</p>
<p>@<em>return</em> — True if the empty directory has been deleted</p>
<h2>delete_file</h2>
<pre><code class="language-lua">function ncine.fs.delete_file(path: string)
  -&gt; boolean
</code></pre>
<p>Deletes a file</p>
<p>@<em>return</em> — True if the file has been deleted</p>
<h2>dirname</h2>
<pre><code class="language-lua">function ncine.fs.dirname(path: string)
  -&gt; string
</code></pre>
<p>Returns the path up to, but not including, the final separator</p>
<h2>exists</h2>
<pre><code class="language-lua">function ncine.fs.exists(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the file or directory exists</p>
<h2>file_size</h2>
<pre><code class="language-lua">function ncine.fs.file_size(path: string)
  -&gt; integer
</code></pre>
<p>Returns the file size in bytes</p>
<h2>get_cache_path</h2>
<pre><code class="language-lua">function ncine.fs.get_cache_path()
  -&gt; string
</code></pre>
<p>Returns the writable directory for saving cache data</p>
<h2>get_current_dir</h2>
<pre><code class="language-lua">function ncine.fs.get_current_dir()
  -&gt; string
</code></pre>
<p>Returns the path of the current working directory</p>
<h2>get_data_path</h2>
<pre><code class="language-lua">function ncine.fs.get_data_path()
  -&gt; string
</code></pre>
<p>Returns the base directory for data loading</p>
<h2>get_extension</h2>
<pre><code class="language-lua">function ncine.fs.get_extension(path: string)
  -&gt; string?
</code></pre>
<p>Returns the extension position in the string or <code>nil</code> if it is not found</p>
<h2>get_home_path</h2>
<pre><code class="language-lua">function ncine.fs.get_home_path()
  -&gt; string
</code></pre>
<p>Returns the current user home directory</p>
<h2>get_permissions</h2>
<pre><code class="language-lua">function ncine.fs.get_permissions(path: string)
  -&gt; integer
</code></pre>
<p>Returns the file or directory permissions in a mask</p>
<p>@<em>return</em> — A mask created from values in <code>ncine.permission</code></p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#14#9">ncine.permission</a></p>
<h2>get_save_path</h2>
<pre><code class="language-lua">function ncine.fs.get_save_path()
  -&gt; string
</code></pre>
<p>Returns the writable directory for saving data</p>
<h2>has_extension</h2>
<pre><code class="language-lua">function ncine.fs.has_extension(path: string, extension: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the path has the specified extension (case-insensitive comparison)</p>
<h2>is_directory</h2>
<pre><code class="language-lua">function ncine.fs.is_directory(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the specified path is a directory</p>
<h2>is_executable</h2>
<pre><code class="language-lua">function ncine.fs.is_executable(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the file or directory is executable</p>
<h2>is_file</h2>
<pre><code class="language-lua">function ncine.fs.is_file(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the specified path is a file</p>
<h2>is_hidden</h2>
<pre><code class="language-lua">function ncine.fs.is_hidden(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the file or directory is hidden</p>
<h2>is_readable</h2>
<pre><code class="language-lua">function ncine.fs.is_readable(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the file or directory is readable</p>
<h2>is_readable_file</h2>
<pre><code class="language-lua">function ncine.fs.is_readable_file(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the path is a file and is readable</p>
<h2>is_writable</h2>
<pre><code class="language-lua">function ncine.fs.is_writable(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the file or directory is writable</p>
<h2>is_writable_file</h2>
<pre><code class="language-lua">function ncine.fs.is_writable_file(path: string)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the path is a file and is writeable</p>
<h2>join_path</h2>
<pre><code class="language-lua">function ncine.fs.join_path(first: string, second: string)
  -&gt; string
</code></pre>
<p>Joins together two path components</p>
<h2>last_access_time</h2>
<pre><code class="language-lua">function ncine.fs.last_access_time(path: string)
  -&gt; file_date
</code></pre>
<p>Returns the last time the file or directory was accessed</p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#4#10">file_date</a></p>
<h2>last_modification_time</h2>
<pre><code class="language-lua">function ncine.fs.last_modification_time(path: string)
  -&gt; file_date
</code></pre>
<p>Returns the last time the file or directory was modified</p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#4#10">file_date</a></p>
<h2>logical_drive_strings</h2>
<pre><code class="language-lua">function ncine.fs.logical_drive_strings()
  -&gt; string
</code></pre>
<p>Returns a buffer with strings that specify valid drives in the system on Windows</p>
<h2>logical_drives</h2>
<pre><code class="language-lua">function ncine.fs.logical_drives()
  -&gt; integer
</code></pre>
<p>Returns a bitmask representing the currently available disk drives on Windows</p>
<h2>remove_permissions</h2>
<pre><code class="language-lua">function ncine.fs.remove_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<p>Removes the permissions in the mask from a file or a directory</p>
<p>@<em>param</em> <code>mode</code> — A mask created from values in <code>ncine.permission</code></p>
<p>@<em>return</em> — True if the permission mode was removed</p>
<p>See: <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/fs.lua#14#9">ncine.permission</a></p>
<h2>rename</h2>
<pre><code class="language-lua">function ncine.fs.rename(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<p>Renames or moves a file or a directory</p>
<p>@<em>return</em> — True if the file or directory has been renamed or moved</p>
<h2>set_current_dir</h2>
<pre><code class="language-lua">function ncine.fs.set_current_dir(path: string)
  -&gt; boolean
</code></pre>
<p>Sets the current working directory, the starting point for interpreting relative paths</p>
<p>@<em>return</em> — True if the directory has been successfully changed</p>
<h2>set_hidden</h2>
<pre><code class="language-lua">function ncine.fs.set_hidden(path: string, hidden: boolean)
  -&gt; boolean
</code></pre>
<p>Makes a file or a directory hidden or not</p>
<p>@<em>return</em> — True if the new hidden state has been successfully set</p>
<hr>
<h1>ncine.fs</h1>
<pre><code class="language-lua">ncine.fs
</code></pre>
<pre><code class="language-lua">ncine.fs
</code></pre>
<hr>
<h1>ncine.fs.absolute_join_path</h1>
<pre><code class="language-lua">function ncine.fs.absolute_join_path(first: string, second: string)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.absolute_join_path(first: string, second: string)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.absolute_path</h1>
<pre><code class="language-lua">function ncine.fs.absolute_path(path: string)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.absolute_path(path: string)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.add_permissions</h1>
<pre><code class="language-lua">function ncine.fs.add_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.add_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.basename</h1>
<pre><code class="language-lua">function ncine.fs.basename(path: string)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.basename(path: string)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.change_permissions</h1>
<pre><code class="language-lua">function ncine.fs.change_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.change_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.copy</h1>
<pre><code class="language-lua">function ncine.fs.copy(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.copy(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.create_dir</h1>
<pre><code class="language-lua">function ncine.fs.create_dir(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.create_dir(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.delete_empty_dir</h1>
<pre><code class="language-lua">function ncine.fs.delete_empty_dir(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.delete_empty_dir(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.delete_file</h1>
<pre><code class="language-lua">function ncine.fs.delete_file(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.delete_file(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.dirname</h1>
<pre><code class="language-lua">function ncine.fs.dirname(path: string)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.dirname(path: string)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.exists</h1>
<pre><code class="language-lua">function ncine.fs.exists(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.exists(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.file_size</h1>
<pre><code class="language-lua">function ncine.fs.file_size(path: string)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.fs.file_size(path: string)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.fs.get_cache_path</h1>
<pre><code class="language-lua">function ncine.fs.get_cache_path()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_cache_path()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.get_current_dir</h1>
<pre><code class="language-lua">function ncine.fs.get_current_dir()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_current_dir()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.get_data_path</h1>
<pre><code class="language-lua">function ncine.fs.get_data_path()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_data_path()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.get_extension</h1>
<pre><code class="language-lua">function ncine.fs.get_extension(path: string)
  -&gt; string?
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_extension(path: string)
  -&gt; string?
</code></pre>
<hr>
<h1>ncine.fs.get_home_path</h1>
<pre><code class="language-lua">function ncine.fs.get_home_path()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_home_path()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.get_permissions</h1>
<pre><code class="language-lua">function ncine.fs.get_permissions(path: string)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_permissions(path: string)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.fs.get_save_path</h1>
<pre><code class="language-lua">function ncine.fs.get_save_path()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.get_save_path()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.has_extension</h1>
<pre><code class="language-lua">function ncine.fs.has_extension(path: string, extension: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.has_extension(path: string, extension: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_directory</h1>
<pre><code class="language-lua">function ncine.fs.is_directory(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_directory(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_executable</h1>
<pre><code class="language-lua">function ncine.fs.is_executable(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_executable(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_file</h1>
<pre><code class="language-lua">function ncine.fs.is_file(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_file(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_hidden</h1>
<pre><code class="language-lua">function ncine.fs.is_hidden(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_hidden(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_readable</h1>
<pre><code class="language-lua">function ncine.fs.is_readable(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_readable(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_readable_file</h1>
<pre><code class="language-lua">function ncine.fs.is_readable_file(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_readable_file(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_writable</h1>
<pre><code class="language-lua">function ncine.fs.is_writable(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_writable(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.is_writable_file</h1>
<pre><code class="language-lua">function ncine.fs.is_writable_file(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.is_writable_file(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.join_path</h1>
<pre><code class="language-lua">function ncine.fs.join_path(first: string, second: string)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.join_path(first: string, second: string)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.last_access_time</h1>
<pre><code class="language-lua">function ncine.fs.last_access_time(path: string)
  -&gt; file_date
</code></pre>
<pre><code class="language-lua">function ncine.fs.last_access_time(path: string)
  -&gt; file_date
</code></pre>
<hr>
<h1>ncine.fs.last_modification_time</h1>
<pre><code class="language-lua">function ncine.fs.last_modification_time(path: string)
  -&gt; file_date
</code></pre>
<pre><code class="language-lua">function ncine.fs.last_modification_time(path: string)
  -&gt; file_date
</code></pre>
<hr>
<h1>ncine.fs.logical_drive_strings</h1>
<pre><code class="language-lua">function ncine.fs.logical_drive_strings()
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.fs.logical_drive_strings()
  -&gt; string
</code></pre>
<hr>
<h1>ncine.fs.logical_drives</h1>
<pre><code class="language-lua">function ncine.fs.logical_drives()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.fs.logical_drives()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.fs.remove_permissions</h1>
<pre><code class="language-lua">function ncine.fs.remove_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.remove_permissions(path: string, mode: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.rename</h1>
<pre><code class="language-lua">function ncine.fs.rename(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.rename(old_path: string, new_path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.set_current_dir</h1>
<pre><code class="language-lua">function ncine.fs.set_current_dir(path: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.set_current_dir(path: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.fs.set_hidden</h1>
<pre><code class="language-lua">function ncine.fs.set_hidden(path: string, hidden: boolean)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.fs.set_hidden(path: string, hidden: boolean)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.gfx_device</h1>
<pre><code class="language-lua">ncine.gfx_device
</code></pre>
<pre><code class="language-lua">ncine.gfx_device
</code></pre>
<hr>
<h1>ncine.gfx_device</h1>
<h2>flash_window</h2>
<pre><code class="language-lua">function ncine.gfx_device.flash_window()
</code></pre>
<p>Highlights the application window to notify the user</p>
<h2>get_aspect_ratio</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_aspect_ratio()
  -&gt; number
</code></pre>
<p>Returns the window or video mode resolution aspect ratio</p>
<h2>get_current_video_mode</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_current_video_mode()
  -&gt; video_mode
</code></pre>
<p>Returns the current video mode for the specified monitor`</p>
<h2>get_drawable_resolution</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_resolution()
  -&gt; ncine.vec2
</code></pre>
<p>Returns the window resolution in pixels as a <code>ncine.vec2</code></p>
<p>It may differs from <code>width()</code> on HiDPI screens</p>
<h2>get_drawable_width</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_width()
  -&gt; integer
</code></pre>
<p>Returns the window width in pixels</p>
<p>It may differs from <code>width()</code> on HiDPI screens</p>
<h2>get_hdrawable_eight</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_hdrawable_eight()
  -&gt; integer
</code></pre>
<p>Returns the window height in pixels</p>
<p>It may differs from <code>width()</code> on HiDPI screens</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_height()
  -&gt; integer
</code></pre>
<p>Returns the window or video mode height in screen coordinates</p>
<h2>get_monitor</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_monitor(index: integer)
  -&gt; monitor
</code></pre>
<p>Returns the specified monitor</p>
<h2>get_primary_monitor_index</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_primary_monitor_index()
  -&gt; integer
</code></pre>
<p>Returns the array index of the primary monitor</p>
<p>This is usually the monitor where elements like the task bar or global menu bar are located</p>
<h2>get_resolution</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<p>Returns the window or video mode resolution in screen coordinates as a <code>ncine.vec2</code></p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_width()
  -&gt; integer
</code></pre>
<p>Returns the window or video mode width in screen coordinates</p>
<h2>get_window_monitor_index</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_window_monitor_index()
  -&gt; integer
</code></pre>
<p>Returns the array index of the monitor associated with the window</p>
<h2>get_window_position</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position()
  -&gt; ncine.vec2
</code></pre>
<p>Returns the window position as a <code>ncine.vec2</code></p>
<h2>get_window_position_x</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_x()
  -&gt; integer
</code></pre>
<p>Returns the window horizontal position</p>
<h2>get_window_position_y</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_y()
  -&gt; integer
</code></pre>
<p>Returns the window vertical position</p>
<h2>get_window_scaling_factor</h2>
<pre><code class="language-lua">function ncine.gfx_device.get_window_scaling_factor()
  -&gt; number
</code></pre>
<p>Returns the scaling factor for application window</p>
<h2>is_fullscreen</h2>
<pre><code class="language-lua">function ncine.gfx_device.is_fullscreen()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the device renders in full screen</p>
<h2>is_resizable</h2>
<pre><code class="language-lua">function ncine.gfx_device.is_resizable()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the window is resizable</p>
<h2>num_monitors</h2>
<pre><code class="language-lua">function ncine.gfx_device.num_monitors()
  -&gt; integer
</code></pre>
<p>Returns the number of connected monitors</p>
<h2>set_fullscreen</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_fullscreen(in_fullscreen: boolean)
</code></pre>
<p>Sets the full screen flag of the window</p>
<h2>set_swap_interval</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_swap_interval(interval: integer)
</code></pre>
<p>Sets the number of vertical blanks to occur before a buffer swap</p>
<p>An interval of <code>-1</code> will enable adaptive v-sync if available.</p>
<h2>set_video_mode</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_video_mode(mode_index: integer)
</code></pre>
<p>Sets the video mode that will be used in full screen by the monitor that hosts the window</p>
<p>Call this method <strong>before</strong> enabling full screen.</p>
<h2>set_window_icon</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_window_icon(icon_filename: string)
</code></pre>
<p>Sets the application window icon</p>
<h2>set_window_position</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_window_position(position: ncine.vec2)
</code></pre>
<p>Sets the position of the application window with a <code>ncine.vec2</code></p>
<h2>set_window_size</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_window_size(size: ncine.vec2)
</code></pre>
<p>Sets the window size with a <code>ncine.vec2</code></p>
<p>If the application is in full screen this method will have no effect.</p>
<h2>set_window_title</h2>
<pre><code class="language-lua">function ncine.gfx_device.set_window_title(title: string)
</code></pre>
<p>Sets the application window title</p>
<hr>
<h1>ncine.gfx_device.flash_window</h1>
<pre><code class="language-lua">function ncine.gfx_device.flash_window()
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.flash_window()
</code></pre>
<hr>
<h1>ncine.gfx_device.get_aspect_ratio</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_aspect_ratio()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_aspect_ratio()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.gfx_device.get_current_video_mode</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_current_video_mode()
  -&gt; video_mode
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_current_video_mode()
  -&gt; video_mode
</code></pre>
<hr>
<h1>ncine.gfx_device.get_drawable_resolution</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_resolution()
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_resolution()
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.gfx_device.get_drawable_width</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_width()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_drawable_width()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_hdrawable_eight</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_hdrawable_eight()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_hdrawable_eight()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_height</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_height()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_height()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_monitor</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_monitor(index: integer)
  -&gt; monitor
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_monitor(index: integer)
  -&gt; monitor
</code></pre>
<hr>
<h1>ncine.gfx_device.get_primary_monitor_index</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_primary_monitor_index()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_primary_monitor_index()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_resolution</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_resolution()
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.gfx_device.get_width</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_width()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_width()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_window_monitor_index</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_window_monitor_index()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_window_monitor_index()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_window_position</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position()
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position()
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.gfx_device.get_window_position_x</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_x()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_x()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_window_position_y</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_y()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_window_position_y()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.get_window_scaling_factor</h1>
<pre><code class="language-lua">function ncine.gfx_device.get_window_scaling_factor()
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.get_window_scaling_factor()
  -&gt; number
</code></pre>
<hr>
<h1>ncine.gfx_device.is_fullscreen</h1>
<pre><code class="language-lua">function ncine.gfx_device.is_fullscreen()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.is_fullscreen()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.gfx_device.is_resizable</h1>
<pre><code class="language-lua">function ncine.gfx_device.is_resizable()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.is_resizable()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.gfx_device.num_monitors</h1>
<pre><code class="language-lua">function ncine.gfx_device.num_monitors()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.num_monitors()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.gfx_device.set_fullscreen</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_fullscreen(in_fullscreen: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_fullscreen(in_fullscreen: boolean)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_swap_interval</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_swap_interval(interval: integer)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_swap_interval(interval: integer)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_video_mode</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_video_mode(mode_index: integer)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_video_mode(mode_index: integer)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_window_icon</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_window_icon(icon_filename: string)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_icon(icon_filename: string)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_window_position</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_window_position(position: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_position(position_x: integer, position_y: integer)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_position(position: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_position(position_x: integer, position_y: integer)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_window_size</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_window_size(size: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_size(width: integer, height: integer)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_size(size: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_size(width: integer, height: integer)
</code></pre>
<hr>
<h1>ncine.gfx_device.set_window_title</h1>
<pre><code class="language-lua">function ncine.gfx_device.set_window_title(title: string)
</code></pre>
<pre><code class="language-lua">function ncine.gfx_device.set_window_title(title: string)
</code></pre>
<hr>
<h1>ncine.hash64</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.input</h1>
<h2>add_joymappings_from_file</h2>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_file(filename: string)
</code></pre>
<p>Adds joystick mapping configurations from a text file</p>
<h2>add_joymappings_from_strings</h2>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_strings(strings: string[])
</code></pre>
<p>Adds joystick mapping configurations from a strings array</p>
<h2>deadzone_normalize</h2>
<pre><code class="language-lua">function ncine.input.deadzone_normalize(joy_vector: ncine.vec2, deadzone_value: number)
</code></pre>
<p>Modifies the joystick axis vector to account for a dead zone</p>
<h2>get_mouse_cursor_mode</h2>
<pre><code class="language-lua">function ncine.input.get_mouse_cursor_mode(joy_id: any)
  -&gt; ncine.mouse_cursor_mode
</code></pre>
<p>Returns current mouse cursor mode</p>
<h2>joy_axis_normvalue</h2>
<pre><code class="language-lua">function ncine.input.joy_axis_normvalue(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; number
</code></pre>
<p>Returns a normalized value between <code>-1.0</code> and <code>1.0</code> for a joystick axis</p>
<h2>joy_axis_value</h2>
<pre><code class="language-lua">function ncine.input.joy_axis_value(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; integer
</code></pre>
<p>Returns a value between <code>-32768</code> and <code>32767</code> for a joystick axis</p>
<h2>joy_button_pressed</h2>
<pre><code class="language-lua">function ncine.input.joy_button_pressed(joystick_state: joystickstateObj, button_id: integer)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the specified joystick button is pressed</p>
<h2>joy_guid</h2>
<pre><code class="language-lua">function ncine.input.joy_guid(joy_id: integer)
  -&gt; string
</code></pre>
<p>Returns the GUID of the specified joystick</p>
<h2>joy_hat_state</h2>
<pre><code class="language-lua">function ncine.input.joy_hat_state(joystick_state: joystickstateObj, hat_id: integer)
  -&gt; ncine.joy_hat_state
</code></pre>
<p>Returns the state of the specified hat</p>
<h2>joy_mapped</h2>
<pre><code class="language-lua">function ncine.input.joy_mapped(joy_id: integer)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the joystick has a valid mapping configuration</p>
<h2>joy_name</h2>
<pre><code class="language-lua">function ncine.input.joy_name(joy_id: integer)
  -&gt; string
</code></pre>
<p>joy_id</p>
<h2>joy_num_axes</h2>
<pre><code class="language-lua">function ncine.input.joy_num_axes(joy_id: integer)
  -&gt; integer
</code></pre>
<p>Returns the number of available axes for the specified joystick</p>
<h2>joy_num_buttons</h2>
<pre><code class="language-lua">function ncine.input.joy_num_buttons(joy_id: integer)
  -&gt; integer
</code></pre>
<p>Returns the number of available buttons for the specified joystick</p>
<h2>joy_num_hats</h2>
<pre><code class="language-lua">function ncine.input.joy_num_hats(joy_id: integer)
  -&gt; integer
</code></pre>
<p>Returns the number of available hats for the specified joystick</p>
<h2>joy_present</h2>
<pre><code class="language-lua">function ncine.input.joy_present(joy_id: integer)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the specified joystick is connected</p>
<h2>joy_state</h2>
<pre><code class="language-lua">function ncine.input.joy_state()
  -&gt; joystickstateObj
</code></pre>
<p>Returns the state of the joystick</p>
<h2>joymapped_state</h2>
<pre><code class="language-lua">function ncine.input.joymapped_state()
  -&gt; joymappedstateObj
</code></pre>
<p>Returns the state of the mapped joystick</p>
<h2>key_down</h2>
<pre><code class="language-lua">function ncine.input.key_down(key_state: keystateObj, keysym: integer)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the specified key is down</p>
<h2>key_state</h2>
<pre><code class="language-lua">function ncine.input.key_state()
  -&gt; keystateObj
</code></pre>
<p>Returns current keyboard state</p>
<h2>mouse_state</h2>
<pre><code class="language-lua">function ncine.input.mouse_state()
  -&gt; mouse_state
</code></pre>
<p>Returns current mouse state</p>
<h2>num_joymappings</h2>
<pre><code class="language-lua">function ncine.input.num_joymappings(strings: any)
  -&gt; integer
</code></pre>
<p>Returns the current number of valid joystick mappings</p>
<h2>set_mouse_cursor_mode</h2>
<pre><code class="language-lua">function ncine.input.set_mouse_cursor_mode(mouse_cursor_mode: ncine.mouse_cursor_mode)
</code></pre>
<p>Sets the mouse cursor mode</p>
<hr>
<h1>ncine.input</h1>
<pre><code class="language-lua">ncine.input
</code></pre>
<pre><code class="language-lua">ncine.input
</code></pre>
<hr>
<h1>ncine.input.add_joymappings_from_file</h1>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_file(filename: string)
</code></pre>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_file(filename: string)
</code></pre>
<hr>
<h1>ncine.input.add_joymappings_from_strings</h1>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_strings(strings: string[])
</code></pre>
<pre><code class="language-lua">function ncine.input.add_joymappings_from_strings(strings: string[])
</code></pre>
<hr>
<h1>ncine.input.deadzone_normalize</h1>
<pre><code class="language-lua">function ncine.input.deadzone_normalize(joy_vector: ncine.vec2, deadzone_value: number)
</code></pre>
<pre><code class="language-lua">function ncine.input.deadzone_normalize(joy_vector: ncine.vec2, deadzone_value: number)
</code></pre>
<hr>
<h1>ncine.input.get_mouse_cursor_mode</h1>
<pre><code class="language-lua">function ncine.input.get_mouse_cursor_mode(joy_id: any)
  -&gt; ncine.mouse_cursor_mode
</code></pre>
<pre><code class="language-lua">function ncine.input.get_mouse_cursor_mode(joy_id: any)
  -&gt; ncine.mouse_cursor_mode
</code></pre>
<hr>
<h1>ncine.input.joy_axis_normvalue</h1>
<pre><code class="language-lua">function ncine.input.joy_axis_normvalue(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_axis_normvalue(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.input.joy_axis_value</h1>
<pre><code class="language-lua">function ncine.input.joy_axis_value(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_axis_value(joystick_state: joymappedstateObj, axis_name: ncine.joy_axis)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_axis_value(joystick_state: joystickstateObj, axis_id: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_axis_value(joystick_state: joymappedstateObj, axis_name: ncine.joy_axis)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.input.joy_button_pressed</h1>
<pre><code class="language-lua">function ncine.input.joy_button_pressed(joystick_state: joystickstateObj, button_id: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_button_pressed(joystick_state: joymappedstateObj, button_name: ncine.joy_button)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_button_pressed(joystick_state: joystickstateObj, button_id: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_button_pressed(joystick_state: joymappedstateObj, button_name: ncine.joy_button)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.input.joy_guid</h1>
<pre><code class="language-lua">function ncine.input.joy_guid(joy_id: integer)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_guid(joy_id: integer)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.input.joy_hat_state</h1>
<pre><code class="language-lua">function ncine.input.joy_hat_state(joystick_state: joystickstateObj, hat_id: integer)
  -&gt; ncine.joy_hat_state
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_hat_state(joystick_state: joystickstateObj, hat_id: integer)
  -&gt; ncine.joy_hat_state
</code></pre>
<hr>
<h1>ncine.input.joy_mapped</h1>
<pre><code class="language-lua">function ncine.input.joy_mapped(joy_id: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_mapped(joy_id: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.input.joy_name</h1>
<pre><code class="language-lua">function ncine.input.joy_name(joy_id: integer)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_name(joy_id: integer)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.input.joy_num_axes</h1>
<pre><code class="language-lua">function ncine.input.joy_num_axes(joy_id: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_num_axes(joy_id: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.input.joy_num_buttons</h1>
<pre><code class="language-lua">function ncine.input.joy_num_buttons(joy_id: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_num_buttons(joy_id: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.input.joy_num_hats</h1>
<pre><code class="language-lua">function ncine.input.joy_num_hats(joy_id: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_num_hats(joy_id: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.input.joy_present</h1>
<pre><code class="language-lua">function ncine.input.joy_present(joy_id: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_present(joy_id: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.input.joy_state</h1>
<pre><code class="language-lua">function ncine.input.joy_state()
  -&gt; joystickstateObj
</code></pre>
<pre><code class="language-lua">function ncine.input.joy_state()
  -&gt; joystickstateObj
</code></pre>
<hr>
<h1>ncine.input.joymapped_state</h1>
<pre><code class="language-lua">function ncine.input.joymapped_state()
  -&gt; joymappedstateObj
</code></pre>
<pre><code class="language-lua">function ncine.input.joymapped_state()
  -&gt; joymappedstateObj
</code></pre>
<hr>
<h1>ncine.input.key_down</h1>
<pre><code class="language-lua">function ncine.input.key_down(key_state: keystateObj, keysym: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.input.key_down(key_state: keystateObj, keysym: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.input.key_state</h1>
<pre><code class="language-lua">function ncine.input.key_state()
  -&gt; keystateObj
</code></pre>
<pre><code class="language-lua">function ncine.input.key_state()
  -&gt; keystateObj
</code></pre>
<hr>
<h1>ncine.input.mouse_state</h1>
<pre><code class="language-lua">function ncine.input.mouse_state()
  -&gt; mouse_state
</code></pre>
<pre><code class="language-lua">function ncine.input.mouse_state()
  -&gt; mouse_state
</code></pre>
<hr>
<h1>ncine.input.num_joymappings</h1>
<pre><code class="language-lua">function ncine.input.num_joymappings(strings: any)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.input.num_joymappings(strings: any)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.input.set_mouse_cursor_mode</h1>
<pre><code class="language-lua">function ncine.input.set_mouse_cursor_mode(mouse_cursor_mode: ncine.mouse_cursor_mode)
</code></pre>
<pre><code class="language-lua">function ncine.input.set_mouse_cursor_mode(mouse_cursor_mode: ncine.mouse_cursor_mode)
</code></pre>
<hr>
<h1>ncine.joy_axis</h1>
<pre><code class="language-lua">enum ncine.joy_axis
</code></pre>
<pre><code class="language-lua">enum ncine.joy_axis
</code></pre>
<hr>
<h1>ncine.joy_button</h1>
<pre><code class="language-lua">enum ncine.joy_button
</code></pre>
<pre><code class="language-lua">enum ncine.joy_button
</code></pre>
<hr>
<h1>ncine.joy_dead_zone</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.joy_hat_state</h1>
<pre><code class="language-lua">enum ncine.joy_hat_state
</code></pre>
<pre><code class="language-lua">enum ncine.joy_hat_state
</code></pre>
<hr>
<h1>ncine.keymod</h1>
<pre><code class="language-lua">enum ncine.keymod
</code></pre>
<pre><code class="language-lua">enum ncine.keymod
</code></pre>
<hr>
<h1>ncine.keysym</h1>
<pre><code class="language-lua">enum ncine.keysym
</code></pre>
<pre><code class="language-lua">enum ncine.keysym
</code></pre>
<hr>
<h1>ncine.log</h1>
<h2>debug</h2>
<pre><code class="language-lua">function ncine.log.debug(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.DEBUG</code> level</p>
<h2>error</h2>
<pre><code class="language-lua">function ncine.log.error(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.ERROR</code> level</p>
<h2>fatal</h2>
<pre><code class="language-lua">function ncine.log.fatal(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.FATAL</code> level</p>
<h2>info</h2>
<pre><code class="language-lua">function ncine.log.info(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.INFO</code> level</p>
<h2>verbose</h2>
<pre><code class="language-lua">function ncine.log.verbose(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.VERBOSE</code> level</p>
<h2>warn</h2>
<pre><code class="language-lua">function ncine.log.warn(msg: string)
</code></pre>
<p>Logs a message with a <code>ncine.log_level.WARN</code> level</p>
<hr>
<h1>ncine.log</h1>
<pre><code class="language-lua">ncine.log
</code></pre>
<pre><code class="language-lua">ncine.log
</code></pre>
<hr>
<h1>ncine.log.debug</h1>
<pre><code class="language-lua">function ncine.log.debug(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.debug(msg: string)
</code></pre>
<hr>
<h1>ncine.log.error</h1>
<pre><code class="language-lua">function ncine.log.error(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.error(msg: string)
</code></pre>
<hr>
<h1>ncine.log.fatal</h1>
<pre><code class="language-lua">function ncine.log.fatal(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.fatal(msg: string)
</code></pre>
<hr>
<h1>ncine.log.info</h1>
<pre><code class="language-lua">function ncine.log.info(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.info(msg: string)
</code></pre>
<hr>
<h1>ncine.log.verbose</h1>
<pre><code class="language-lua">function ncine.log.verbose(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.verbose(msg: string)
</code></pre>
<hr>
<h1>ncine.log.warn</h1>
<pre><code class="language-lua">function ncine.log.warn(msg: string)
</code></pre>
<pre><code class="language-lua">function ncine.log.warn(msg: string)
</code></pre>
<hr>
<h1>ncine.log_level</h1>
<pre><code class="language-lua">enum ncine.log_level
</code></pre>
<pre><code class="language-lua">enum ncine.log_level
</code></pre>
<hr>
<h1>ncine.loop_mode</h1>
<pre><code class="language-lua">enum ncine.loop_mode
</code></pre>
<pre><code class="language-lua">enum ncine.loop_mode
</code></pre>
<hr>
<h1>ncine.mesh_sprite</h1>
<pre><code class="language-lua">ncine.mesh_sprite
</code></pre>
<pre><code class="language-lua">ncine.mesh_sprite
</code></pre>
<hr>
<h1>ncine.mesh_sprite</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>are_unique_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_indices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the indices belong to the sprite and are not stored externally</p>
<h2>are_unique_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_vertices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the vertices belong to the sprite and are not stored externally</p>
<h2>clone</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.clone(sprite: meshspriteObj)
  -&gt; meshspriteObj
</code></pre>
<p>Constructs a new mesh sprite object as a clone of the specified one</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/mesh_sprite.lua#62">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>sprite</code> — The sprite object to be cloned</p>
<p>@<em>return</em> — The cloned mesh sprite object</p>
<h2>copy_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<p>Copies the indices data from a table into the sprite (no texture version)</p>
<h2>copy_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_vertices(sprite: meshspriteObj, vertices: mesh_sprite_vertex[])
</code></pre>
<p>Copies the vertices data from a table into the sprite</p>
<h2>create_vertices_from_texels</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.create_vertices_from_texels(sprite: meshspriteObj, texels: ncine.vec2[], texture_cut_mode: ncine.texture_cut_mode)
</code></pre>
<p>Creates an internal set of vertices from an external table of points in texture space, with optional texture cut mode</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.delete(sprite: meshspriteObj)
</code></pre>
<p>Destroys a mesh sprite object and releases its memory</p>
<p>@<em>param</em> <code>sprite</code> — The mesh sprite object to be destroyed</p>
<h2>emplace_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<p>Emplaces the indices data from an array of integers into the sprite</p>
<h2>emplace_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_vertices(sprite: meshspriteObj, vertices: number[])
</code></pre>
<p>Emplaces the vertices data from an array of numbers into the sprite</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_bytes_per_vertex</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.get_bytes_per_vertex(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the number of bytes used by each vertex</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of the node area</p>
<h2>get_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.get_indices(sprite: meshspriteObj)
  -&gt; integer[]
</code></pre>
<p>Returns the indices used to draw the sprite mesh</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the texture source rectangle for blitting</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture object</p>
<h2>get_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.get_vertices(sprite: meshspriteObj)
  -&gt; number[]
</code></pre>
<p>Returns the vertices data of the sprite mesh</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of the node area</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>is_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is horizontally flipped</p>
<h2>is_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is vertically flipped</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; meshspriteObj
</code></pre>
<p>Constructs a mesh sprite object with a parent scene node, a texture, and position components</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/mesh_sprite.lua#62">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>parent</code> — The parent scenenode</p>
<p>@<em>param</em> <code>texture</code> — The texture object</p>
<p>@<em>param</em> <code>x</code> — The X component of the position</p>
<p>@<em>param</em> <code>y</code> — The Y component of the position</p>
<p>@<em>return</em> — A new mesh sprite object</p>
<h2>num_bytes</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.num_bytes(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the total number of bytes used by all sprite's vertices</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>num_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.num_indices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the number of indices used to draw the sprite mesh</p>
<h2>num_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.num_vertices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<p>Returns the number of vertices of the sprite mesh</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>reset_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<p>Triggers a texture update without setting a new texture</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<p>Flips the texture rect horizontally</p>
<h2>set_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<p>Flips the texture rect vertically</p>
<h2>set_indices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.set_indices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<p>Sets the indices data to the data used by another sprite</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_size</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<p>Sets the sprite size</p>
<h2>set_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<p>Sets the texture source rectangle for blitting</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<p>Sets the texture object</p>
<h2>set_vertices</h2>
<pre><code class="language-lua">function ncine.mesh_sprite.set_vertices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<p>Sets the vertices data to the data used by another sprite</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.mesh_sprite.are_unique_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_indices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_indices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.mesh_sprite.are_unique_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_vertices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.are_unique_vertices(sprite: meshspriteObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.mesh_sprite.clone</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.clone(sprite: meshspriteObj)
  -&gt; meshspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.clone(sprite: meshspriteObj)
  -&gt; meshspriteObj
</code></pre>
<hr>
<h1>ncine.mesh_sprite.copy_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<hr>
<h1>ncine.mesh_sprite.copy_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_vertices(sprite: meshspriteObj, vertices: mesh_sprite_vertex[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_vertices(sprite: meshspriteObj, vertices: mesh_sprite_vertex_notexture[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_vertices(sprite: meshspriteObj, vertices: mesh_sprite_vertex[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.copy_vertices(sprite: meshspriteObj, vertices: mesh_sprite_vertex_notexture[])
</code></pre>
<hr>
<h1>ncine.mesh_sprite.create_vertices_from_texels</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.create_vertices_from_texels(sprite: meshspriteObj, texels: ncine.vec2[], texture_cut_mode: ncine.texture_cut_mode)
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.create_vertices_from_texels(sprite: meshspriteObj, texels: ncine.vec2[], texture_cut_mode: ncine.texture_cut_mode)
</code></pre>
<hr>
<h1>ncine.mesh_sprite.delete</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.delete(sprite: meshspriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.delete(sprite: meshspriteObj)
</code></pre>
<hr>
<h1>ncine.mesh_sprite.emplace_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_indices(sprite: meshspriteObj, indices: integer[])
</code></pre>
<hr>
<h1>ncine.mesh_sprite.emplace_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_vertices(sprite: meshspriteObj, vertices: number[])
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.emplace_vertices(sprite: meshspriteObj, vertices: number[])
</code></pre>
<hr>
<h1>ncine.mesh_sprite.get_bytes_per_vertex</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.get_bytes_per_vertex(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.get_bytes_per_vertex(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.mesh_sprite.get_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.get_indices(sprite: meshspriteObj)
  -&gt; integer[]
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.get_indices(sprite: meshspriteObj)
  -&gt; integer[]
</code></pre>
<hr>
<h1>ncine.mesh_sprite.get_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.get_vertices(sprite: meshspriteObj)
  -&gt; number[]
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.get_vertices(sprite: meshspriteObj)
  -&gt; number[]
</code></pre>
<hr>
<h1>ncine.mesh_sprite.new</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; meshspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; meshspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; meshspriteObj
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; meshspriteObj
</code></pre>
<hr>
<h1>ncine.mesh_sprite.num_bytes</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.num_bytes(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.num_bytes(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.mesh_sprite.num_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.num_indices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.num_indices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.mesh_sprite.num_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.num_vertices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.num_vertices(sprite: meshspriteObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.mesh_sprite.set_indices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.set_indices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.set_indices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<hr>
<h1>ncine.mesh_sprite.set_vertices</h1>
<pre><code class="language-lua">function ncine.mesh_sprite.set_vertices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.mesh_sprite.set_vertices(sprite: meshspriteObj, source_sprite: meshspriteObj)
</code></pre>
<hr>
<h1>ncine.mouse_button</h1>
<pre><code class="language-lua">enum ncine.mouse_button
</code></pre>
<pre><code class="language-lua">enum ncine.mouse_button
</code></pre>
<hr>
<h1>ncine.mouse_cursor_mode</h1>
<pre><code class="language-lua">enum ncine.mouse_cursor_mode
</code></pre>
<pre><code class="language-lua">enum ncine.mouse_cursor_mode
</code></pre>
<hr>
<h1>ncine.on_acceleration</h1>
<pre><code class="language-lua">function ncine.on_acceleration(event: accelerometer_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_acceleration(event: accelerometer_event)
</code></pre>
<hr>
<h1>ncine.on_change_scaling_factor</h1>
<pre><code class="language-lua">function ncine.on_change_scaling_factor(factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.on_change_scaling_factor(factor: number)
</code></pre>
<hr>
<h1>ncine.on_draw_viewport</h1>
<pre><code class="language-lua">function ncine.on_draw_viewport(viewport: viewportObj)
</code></pre>
<pre><code class="language-lua">function ncine.on_draw_viewport(viewport: viewportObj)
</code></pre>
<hr>
<h1>ncine.on_frame_end</h1>
<pre><code class="language-lua">function ncine.on_frame_end()
</code></pre>
<pre><code class="language-lua">function ncine.on_frame_end()
</code></pre>
<hr>
<h1>ncine.on_frame_start</h1>
<pre><code class="language-lua">function ncine.on_frame_start()
</code></pre>
<pre><code class="language-lua">function ncine.on_frame_start()
</code></pre>
<hr>
<h1>ncine.on_init</h1>
<pre><code class="language-lua">function ncine.on_init()
</code></pre>
<pre><code class="language-lua">function ncine.on_init()
</code></pre>
<hr>
<h1>ncine.on_joy_axis_moved</h1>
<pre><code class="language-lua">function ncine.on_joy_axis_moved(event: joy_axis_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_axis_moved(event: joy_axis_event)
</code></pre>
<hr>
<h1>ncine.on_joy_button_pressed</h1>
<pre><code class="language-lua">function ncine.on_joy_button_pressed(event: joy_button_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_button_pressed(event: joy_button_event)
</code></pre>
<hr>
<h1>ncine.on_joy_button_released</h1>
<pre><code class="language-lua">function ncine.on_joy_button_released(event: joy_button_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_button_released(event: joy_button_event)
</code></pre>
<hr>
<h1>ncine.on_joy_connected</h1>
<pre><code class="language-lua">function ncine.on_joy_connected(event: joy_connection_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_connected(event: joy_connection_event)
</code></pre>
<hr>
<h1>ncine.on_joy_disconnected</h1>
<pre><code class="language-lua">function ncine.on_joy_disconnected(event: joy_connection_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_disconnected(event: joy_connection_event)
</code></pre>
<hr>
<h1>ncine.on_joy_hat_moved</h1>
<pre><code class="language-lua">function ncine.on_joy_hat_moved(event: joy_hat_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joy_hat_moved(event: joy_hat_event)
</code></pre>
<hr>
<h1>ncine.on_joymapped_axis_moved</h1>
<pre><code class="language-lua">function ncine.on_joymapped_axis_moved(event: joymapped_axis_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joymapped_axis_moved(event: joymapped_axis_event)
</code></pre>
<hr>
<h1>ncine.on_joymapped_button_pressed</h1>
<pre><code class="language-lua">function ncine.on_joymapped_button_pressed(event: joymapped_button_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joymapped_button_pressed(event: joymapped_button_event)
</code></pre>
<hr>
<h1>ncine.on_joymapped_button_released</h1>
<pre><code class="language-lua">function ncine.on_joymapped_button_released(event: joymapped_button_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_joymapped_button_released(event: joymapped_button_event)
</code></pre>
<hr>
<h1>ncine.on_key_pressed</h1>
<pre><code class="language-lua">function ncine.on_key_pressed(event: keyboard_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_key_pressed(event: keyboard_event)
</code></pre>
<hr>
<h1>ncine.on_key_released</h1>
<pre><code class="language-lua">function ncine.on_key_released(event: keyboard_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_key_released(event: keyboard_event)
</code></pre>
<hr>
<h1>ncine.on_mouse_button_pressed</h1>
<pre><code class="language-lua">function ncine.on_mouse_button_pressed(event: mouse_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_mouse_button_pressed(event: mouse_event)
</code></pre>
<hr>
<h1>ncine.on_mouse_button_released</h1>
<pre><code class="language-lua">function ncine.on_mouse_button_released(event: mouse_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_mouse_button_released(event: mouse_event)
</code></pre>
<hr>
<h1>ncine.on_mouse_moved</h1>
<pre><code class="language-lua">function ncine.on_mouse_moved(event: mouse_state)
</code></pre>
<pre><code class="language-lua">function ncine.on_mouse_moved(event: mouse_state)
</code></pre>
<hr>
<h1>ncine.on_pointer_down</h1>
<pre><code class="language-lua">function ncine.on_pointer_down(event: touch_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_pointer_down(event: touch_event)
</code></pre>
<hr>
<h1>ncine.on_pointer_up</h1>
<pre><code class="language-lua">function ncine.on_pointer_up(event: touch_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_pointer_up(event: touch_event)
</code></pre>
<hr>
<h1>ncine.on_post_update</h1>
<pre><code class="language-lua">function ncine.on_post_update()
</code></pre>
<pre><code class="language-lua">function ncine.on_post_update()
</code></pre>
<hr>
<h1>ncine.on_pre_init</h1>
<pre><code class="language-lua">function ncine.on_pre_init(cfg: ncine.app_configuration)
</code></pre>
<pre><code class="language-lua">function ncine.on_pre_init(cfg: ncine.app_configuration)
</code></pre>
<hr>
<h1>ncine.on_quit_request</h1>
<pre><code class="language-lua">function ncine.on_quit_request()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.on_quit_request()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.on_resize_window</h1>
<pre><code class="language-lua">function ncine.on_resize_window(width: integer, height: integer)
</code></pre>
<pre><code class="language-lua">function ncine.on_resize_window(width: integer, height: integer)
</code></pre>
<hr>
<h1>ncine.on_resume</h1>
<pre><code class="language-lua">function ncine.on_resume()
</code></pre>
<pre><code class="language-lua">function ncine.on_resume()
</code></pre>
<hr>
<h1>ncine.on_scroll_input</h1>
<pre><code class="language-lua">function ncine.on_scroll_input(event: scroll_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_scroll_input(event: scroll_event)
</code></pre>
<hr>
<h1>ncine.on_shutdown</h1>
<pre><code class="language-lua">function ncine.on_shutdown()
</code></pre>
<pre><code class="language-lua">function ncine.on_shutdown()
</code></pre>
<hr>
<h1>ncine.on_suspend</h1>
<pre><code class="language-lua">function ncine.on_suspend()
</code></pre>
<pre><code class="language-lua">function ncine.on_suspend()
</code></pre>
<hr>
<h1>ncine.on_text_input</h1>
<pre><code class="language-lua">function ncine.on_text_input(event: text_input_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_text_input(event: text_input_event)
</code></pre>
<hr>
<h1>ncine.on_touch_down</h1>
<pre><code class="language-lua">function ncine.on_touch_down(event: touch_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_touch_down(event: touch_event)
</code></pre>
<hr>
<h1>ncine.on_touch_move</h1>
<pre><code class="language-lua">function ncine.on_touch_move(event: touch_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_touch_move(event: touch_event)
</code></pre>
<hr>
<h1>ncine.on_touch_up</h1>
<pre><code class="language-lua">function ncine.on_touch_up(event: touch_event)
</code></pre>
<pre><code class="language-lua">function ncine.on_touch_up(event: touch_event)
</code></pre>
<hr>
<h1>ncine.particle_affector</h1>
<pre><code class="language-lua">ncine.particle_affector
</code></pre>
<pre><code class="language-lua">ncine.particle_affector
</code></pre>
<hr>
<h1>ncine.particle_affector</h1>
<h2>add_color_step</h2>
<pre><code class="language-lua">function ncine.particle_affector.add_color_step(affector: affectorObj, age: number, color: ncine.color)
</code></pre>
<p>Adds a color step (if the affector type is <code>COLOR</code>)</p>
<h2>add_position_step</h2>
<pre><code class="language-lua">function ncine.particle_affector.add_position_step(affector: affectorObj, age: number, position: ncine.vec2)
</code></pre>
<p>Adds a position step (if the affector type is <code>POSITION</code>)</p>
<h2>add_rotation_step</h2>
<pre><code class="language-lua">function ncine.particle_affector.add_rotation_step(affector: affectorObj, age: number, angle: number)
</code></pre>
<p>Adds a rotation step (if the affector type is <code>ROTATION</code>)</p>
<h2>add_size_step</h2>
<pre><code class="language-lua">function ncine.particle_affector.add_size_step(affector: affectorObj, age: number, scale: ncine.vec2)
</code></pre>
<p>Adds a size step (if the affector type is <code>SIZE</code>)</p>
<h2>add_velocity_step</h2>
<pre><code class="language-lua">function ncine.particle_affector.add_velocity_step(affector: affectorObj, age: number, velocity: ncine.vec2)
</code></pre>
<p>Adds a velocity step (if the affector type is <code>VELOCITY</code>)</p>
<h2>clear_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.clear_steps(affector: affectorObj)
</code></pre>
<p>Removes all steps</p>
<h2>get_base_scale</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_base_scale(affector: affectorObj)
  -&gt; (ncine.vec2)?
</code></pre>
<p>Returns a base scale factor that will be multiplied by all size steps</p>
<p>The affector type should be <code>SIZE</code> or the function will return <code>nil</code>.</p>
<h2>get_color_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_color_steps(affector: affectorObj)
  -&gt; affector_color_step[]?
</code></pre>
<p>Returns the color steps as a table (or <code>nil</code> if the affector type is not <code>COLOR</code>)</p>
<h2>get_position_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_position_steps(affector: affectorObj)
  -&gt; affector_position_step[]?
</code></pre>
<p>Returns the position steps as a table (or <code>nil</code> if the affector type is not <code>POSITION</code>)</p>
<h2>get_rotation_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_rotation_steps(affector: affectorObj)
  -&gt; affector_rotation_step[]?
</code></pre>
<p>Returns the rotation steps as a table (or <code>nil</code> if the affector type is not <code>ROTATION</code>)</p>
<h2>get_size_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_size_steps(affector: affectorObj)
  -&gt; affector_size_step_vector[]?
</code></pre>
<p>Returns the size steps as a table (or <code>nil</code> if the affector type is not <code>SIZE</code>)</p>
<h2>get_type</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_type(affector: affectorObj)
  -&gt; ncine.affector_type
</code></pre>
<p>Returns the affector type</p>
<h2>get_velocity_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.get_velocity_steps(affector: affectorObj)
  -&gt; affector_velocity_step[]?
</code></pre>
<p>Returns the velocity steps as a table (or <code>nil</code> if the affector type is not <code>VELOCITY</code>)</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.particle_affector.is_enabled(affector: affectorObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the affector is enabled</p>
<h2>num_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.num_steps(affector: affectorObj)
  -&gt; integer
</code></pre>
<p>Returns the number of steps</p>
<h2>remove_steps</h2>
<pre><code class="language-lua">function ncine.particle_affector.remove_steps(affector: affectorObj, index: integer)
</code></pre>
<p>Removes the step at the specified position index</p>
<h2>set_base_scale</h2>
<pre><code class="language-lua">function ncine.particle_affector.set_base_scale(affector: affectorObj, base_scale: ncine.vec2)
</code></pre>
<p>Sets a base scale factor that will be multiplied by all size steps</p>
<p>The affector type should be <code>SIZE</code> or the function will do nothing.</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.particle_affector.set_enabled(affector: affectorObj, enabled: boolean)
</code></pre>
<p>Enables or disables the affector</p>
<hr>
<h1>ncine.particle_affector.add_color_step</h1>
<pre><code class="language-lua">function ncine.particle_affector.add_color_step(affector: affectorObj, age: number, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_color_step(affector: affectorObj, age: number, red: number, green: number, blue: number, alpha: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_color_step(affector: affectorObj, age: number, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_color_step(affector: affectorObj, age: number, red: number, green: number, blue: number, alpha: number)
</code></pre>
<hr>
<h1>ncine.particle_affector.add_position_step</h1>
<pre><code class="language-lua">function ncine.particle_affector.add_position_step(affector: affectorObj, age: number, position: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_position_step(affector: affectorObj, age: number, position_x: number, position_y: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_position_step(affector: affectorObj, age: number, position: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_position_step(affector: affectorObj, age: number, position_x: number, position_y: number)
</code></pre>
<hr>
<h1>ncine.particle_affector.add_rotation_step</h1>
<pre><code class="language-lua">function ncine.particle_affector.add_rotation_step(affector: affectorObj, age: number, angle: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_rotation_step(affector: affectorObj, age: number, angle: number)
</code></pre>
<hr>
<h1>ncine.particle_affector.add_size_step</h1>
<pre><code class="language-lua">function ncine.particle_affector.add_size_step(affector: affectorObj, age: number, scale: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_size_step(affector: affectorObj, age: number, scale_x: number, scale_y: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_size_step(affector: affectorObj, age: number, scale: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_size_step(affector: affectorObj, age: number, scale_x: number, scale_y: number)
</code></pre>
<hr>
<h1>ncine.particle_affector.add_velocity_step</h1>
<pre><code class="language-lua">function ncine.particle_affector.add_velocity_step(affector: affectorObj, age: number, velocity: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_velocity_step(affector: affectorObj, age: number, velocity_x: number, velocity_y: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_velocity_step(affector: affectorObj, age: number, velocity: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.add_velocity_step(affector: affectorObj, age: number, velocity_x: number, velocity_y: number)
</code></pre>
<hr>
<h1>ncine.particle_affector.clear_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.clear_steps(affector: affectorObj)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.clear_steps(affector: affectorObj)
</code></pre>
<hr>
<h1>ncine.particle_affector.get_base_scale</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_base_scale(affector: affectorObj)
  -&gt; (ncine.vec2)?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_base_scale(affector: affectorObj)
  -&gt; (ncine.vec2)?
</code></pre>
<hr>
<h1>ncine.particle_affector.get_color_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_color_steps(affector: affectorObj)
  -&gt; affector_color_step[]?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_color_steps(affector: affectorObj)
  -&gt; affector_color_step[]?
</code></pre>
<hr>
<h1>ncine.particle_affector.get_position_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_position_steps(affector: affectorObj)
  -&gt; affector_position_step[]?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_position_steps(affector: affectorObj)
  -&gt; affector_position_step[]?
</code></pre>
<hr>
<h1>ncine.particle_affector.get_rotation_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_rotation_steps(affector: affectorObj)
  -&gt; affector_rotation_step[]?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_rotation_steps(affector: affectorObj)
  -&gt; affector_rotation_step[]?
</code></pre>
<hr>
<h1>ncine.particle_affector.get_size_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_size_steps(affector: affectorObj)
  -&gt; affector_size_step_vector[]?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_size_steps(affector: affectorObj)
  -&gt; affector_size_step_vector[]?
</code></pre>
<hr>
<h1>ncine.particle_affector.get_type</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_type(affector: affectorObj)
  -&gt; ncine.affector_type
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_type(affector: affectorObj)
  -&gt; ncine.affector_type
</code></pre>
<hr>
<h1>ncine.particle_affector.get_velocity_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.get_velocity_steps(affector: affectorObj)
  -&gt; affector_velocity_step[]?
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.get_velocity_steps(affector: affectorObj)
  -&gt; affector_velocity_step[]?
</code></pre>
<hr>
<h1>ncine.particle_affector.is_enabled</h1>
<pre><code class="language-lua">function ncine.particle_affector.is_enabled(affector: affectorObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.is_enabled(affector: affectorObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.particle_affector.num_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.num_steps(affector: affectorObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.num_steps(affector: affectorObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.particle_affector.remove_steps</h1>
<pre><code class="language-lua">function ncine.particle_affector.remove_steps(affector: affectorObj, index: integer)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.remove_steps(affector: affectorObj, index: integer)
</code></pre>
<hr>
<h1>ncine.particle_affector.set_base_scale</h1>
<pre><code class="language-lua">function ncine.particle_affector.set_base_scale(affector: affectorObj, base_scale: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.set_base_scale(affector: affectorObj, base_scale: ncine.vec2)
</code></pre>
<hr>
<h1>ncine.particle_affector.set_enabled</h1>
<pre><code class="language-lua">function ncine.particle_affector.set_enabled(affector: affectorObj, enabled: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_affector.set_enabled(affector: affectorObj, enabled: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system</h1>
<pre><code class="language-lua">ncine.particle_system
</code></pre>
<pre><code class="language-lua">ncine.particle_system
</code></pre>
<hr>
<h1>ncine.particle_system</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>add_color_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.add_color_affector(particle_system: particlesystemObj, color_steps: affector_color_step[])
</code></pre>
<p>Adds a color particle affector</p>
<h2>add_position_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.add_position_affector(particle_system: particlesystemObj, position_steps: affector_position_step[])
</code></pre>
<p>Adds a position particle affector</p>
<h2>add_rotation_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.add_rotation_affector(particle_system: particlesystemObj, rotation_steps: affector_rotation_step[])
</code></pre>
<p>Adds a rotation particle affector</p>
<h2>add_size_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.add_size_affector(particle_system: particlesystemObj, base_scale: number, size_steps: affector_size_step_factor[])
</code></pre>
<p>Adds a size particle affector</p>
<h2>add_velocity_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.add_velocity_affector(particle_system: particlesystemObj, velocity_steps: affector_velocity_step[])
</code></pre>
<p>Adds a velocity particle affector</p>
<h2>clear_affectors</h2>
<pre><code class="language-lua">function ncine.particle_system.clear_affectors(particle_system: particlesystemObj)
</code></pre>
<p>Deletes all particle affectors</p>
<h2>clone</h2>
<pre><code class="language-lua">function ncine.particle_system.clone(particle_system: particlesystemObj)
  -&gt; particlesystemObj
</code></pre>
<p>Constructs a new particle system object as a clone of the specified one</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/particle_system.lua#42">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>particle_system</code> — The particle system object to be cloned</p>
<p>@<em>return</em> — The cloned particle system object</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.particle_system.delete(particle_system: particlesystemObj)
</code></pre>
<p>Destroys a particle system object and releases its memory</p>
<p>@<em>param</em> <code>particle_system</code> — The particle system object to be destroyed</p>
<h2>emit_particles</h2>
<pre><code class="language-lua">function ncine.particle_system.emit_particles(particle_system: particlesystemObj, initializer: particle_initializer)
</code></pre>
<p>Emits particles with the specified initialization parameters</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.get_affector(particle_system: particlesystemObj, index: integer)
  -&gt; affectorObj?
</code></pre>
<p>Returns the affector at the specified index</p>
<h2>get_affectors_enabled</h2>
<pre><code class="language-lua">function ncine.particle_system.get_affectors_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if affectors are modifying particles properties</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_in_local_space</h2>
<pre><code class="language-lua">function ncine.particle_system.get_in_local_space(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if particles are positioned using the particle system as their origin</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_particles_update_enabled</h2>
<pre><code class="language-lua">function ncine.particle_system.get_particles_update_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if particles are updating</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>kill_particles</h2>
<pre><code class="language-lua">function ncine.particle_system.kill_particles(particle_system: particlesystemObj)
</code></pre>
<p>Kills all alive particles</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.particle_system.new(parent?: scenenodeObj, count: integer, texture?: textureObj, tex_rect: ncine.rect)
  -&gt; particlesystemObj
</code></pre>
<p>Constructs a particle system</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/particle_system.lua#42">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>parent</code> — The parent scenenode</p>
<p>@<em>param</em> <code>count</code> — Maximum amount of particles</p>
<p>@<em>return</em> — A new particle system object</p>
<h2>num_affectors</h2>
<pre><code class="language-lua">function ncine.particle_system.num_affectors(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<p>Returns the number of affectors</p>
<h2>num_alive_particles</h2>
<pre><code class="language-lua">function ncine.particle_system.num_alive_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<p>Returns the number of particles currently alive</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>num_particles</h2>
<pre><code class="language-lua">function ncine.particle_system.num_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<p>Returns the total number of particles in the system</p>
<h2>remove_affector</h2>
<pre><code class="language-lua">function ncine.particle_system.remove_affector(particle_system: particlesystemObj, index: integer)
</code></pre>
<p>Removes the affector at the specified index</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_affectors_enabled</h2>
<pre><code class="language-lua">function ncine.particle_system.set_affectors_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<p>Enables or disables affectors modifying particles properties</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.particle_system.set_anchor_point(particle_system: particlesystemObj, point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point for every particle in the system with a <code>ncine.vec2</code></p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.particle_system.set_blending_factors(particle_system: particlesystemObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets the source and destination blending factors for every particle in the system</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.particle_system.set_blending_preset(particle_system: particlesystemObj, blending_preset: ncine.blending_preset)
</code></pre>
<p>Sets the blending factors preset for every particle in the system</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_flipped_x</h2>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_x(particle_system: particlesystemObj, flipped_x: boolean)
</code></pre>
<p>Flips the texture rect horizontally for every particle in the system</p>
<h2>set_flipped_y</h2>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_y(particle_system: particlesystemObj, flipped_y: boolean)
</code></pre>
<p>Flips the texture rect vertically for every particle in the system</p>
<h2>set_in_local_space</h2>
<pre><code class="language-lua">function ncine.particle_system.set_in_local_space(particle_system: particlesystemObj, local_space: boolean)
</code></pre>
<p>Sets or clears the local space flag, to move particles around the particle system or freely</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.particle_system.set_layer(particle_system: particlesystemObj, layer: integer)
</code></pre>
<p>Sets the rendering layer for every particle in the system</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_particles_update_enabled</h2>
<pre><code class="language-lua">function ncine.particle_system.set_particles_update_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<p>Enables or disables particles updating</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.particle_system.set_texture(particle_system: particlesystemObj, texture: textureObj)
</code></pre>
<p>Sets the texture object for every particle in the system</p>
<h2>set_texture_rect</h2>
<pre><code class="language-lua">function ncine.particle_system.set_texture_rect(particle_system: particlesystemObj, tex_rect: ncine.rect)
</code></pre>
<p>Sets the texture source rectangle for every particle in the system</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.particle_system.add_color_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.add_color_affector(particle_system: particlesystemObj, color_steps: affector_color_step[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_color_affector(particle_system: particlesystemObj, color_steps: affector_color_step[])
</code></pre>
<hr>
<h1>ncine.particle_system.add_position_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.add_position_affector(particle_system: particlesystemObj, position_steps: affector_position_step[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_position_affector(particle_system: particlesystemObj, position_steps: affector_position_step[])
</code></pre>
<hr>
<h1>ncine.particle_system.add_rotation_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.add_rotation_affector(particle_system: particlesystemObj, rotation_steps: affector_rotation_step[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_rotation_affector(particle_system: particlesystemObj, rotation_steps: affector_rotation_step[])
</code></pre>
<hr>
<h1>ncine.particle_system.add_size_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.add_size_affector(particle_system: particlesystemObj, base_scale: number, size_steps: affector_size_step_factor[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_size_affector(particle_system: particlesystemObj, base_scale: number, size_steps: affector_size_step_vector[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_size_affector(particle_system: particlesystemObj, base_scale: number, size_steps: affector_size_step_factor[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_size_affector(particle_system: particlesystemObj, base_scale: number, size_steps: affector_size_step_vector[])
</code></pre>
<hr>
<h1>ncine.particle_system.add_velocity_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.add_velocity_affector(particle_system: particlesystemObj, velocity_steps: affector_velocity_step[])
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.add_velocity_affector(particle_system: particlesystemObj, velocity_steps: affector_velocity_step[])
</code></pre>
<hr>
<h1>ncine.particle_system.clear_affectors</h1>
<pre><code class="language-lua">function ncine.particle_system.clear_affectors(particle_system: particlesystemObj)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.clear_affectors(particle_system: particlesystemObj)
</code></pre>
<hr>
<h1>ncine.particle_system.clone</h1>
<pre><code class="language-lua">function ncine.particle_system.clone(particle_system: particlesystemObj)
  -&gt; particlesystemObj
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.clone(particle_system: particlesystemObj)
  -&gt; particlesystemObj
</code></pre>
<hr>
<h1>ncine.particle_system.delete</h1>
<pre><code class="language-lua">function ncine.particle_system.delete(particle_system: particlesystemObj)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.delete(particle_system: particlesystemObj)
</code></pre>
<hr>
<h1>ncine.particle_system.emit_particles</h1>
<pre><code class="language-lua">function ncine.particle_system.emit_particles(particle_system: particlesystemObj, initializer: particle_initializer)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.emit_particles(particle_system: particlesystemObj, initializer: particle_initializer)
</code></pre>
<hr>
<h1>ncine.particle_system.get_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.get_affector(particle_system: particlesystemObj, index: integer)
  -&gt; affectorObj?
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.get_affector(particle_system: particlesystemObj, index: integer)
  -&gt; affectorObj?
</code></pre>
<hr>
<h1>ncine.particle_system.get_affectors_enabled</h1>
<pre><code class="language-lua">function ncine.particle_system.get_affectors_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.get_affectors_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.particle_system.get_in_local_space</h1>
<pre><code class="language-lua">function ncine.particle_system.get_in_local_space(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.get_in_local_space(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.particle_system.get_particles_update_enabled</h1>
<pre><code class="language-lua">function ncine.particle_system.get_particles_update_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.get_particles_update_enabled(particle_system: particlesystemObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.particle_system.kill_particles</h1>
<pre><code class="language-lua">function ncine.particle_system.kill_particles(particle_system: particlesystemObj)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.kill_particles(particle_system: particlesystemObj)
</code></pre>
<hr>
<h1>ncine.particle_system.new</h1>
<pre><code class="language-lua">function ncine.particle_system.new(parent?: scenenodeObj, count: integer, texture?: textureObj, tex_rect: ncine.rect)
  -&gt; particlesystemObj
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.new(parent?: scenenodeObj, count: integer, texture?: textureObj, tex_rect: ncine.rect)
  -&gt; particlesystemObj
</code></pre>
<hr>
<h1>ncine.particle_system.num_affectors</h1>
<pre><code class="language-lua">function ncine.particle_system.num_affectors(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.num_affectors(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.particle_system.num_alive_particles</h1>
<pre><code class="language-lua">function ncine.particle_system.num_alive_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.num_alive_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.particle_system.num_particles</h1>
<pre><code class="language-lua">function ncine.particle_system.num_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.num_particles(particle_system: particlesystemObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.particle_system.remove_affector</h1>
<pre><code class="language-lua">function ncine.particle_system.remove_affector(particle_system: particlesystemObj, index: integer)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.remove_affector(particle_system: particlesystemObj, index: integer)
</code></pre>
<hr>
<h1>ncine.particle_system.set_affectors_enabled</h1>
<pre><code class="language-lua">function ncine.particle_system.set_affectors_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_affectors_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system.set_anchor_point</h1>
<pre><code class="language-lua">function ncine.particle_system.set_anchor_point(particle_system: particlesystemObj, point: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_anchor_point(particle_system: particlesystemObj, point_x: number, point_y: number)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_anchor_point(particle_system: particlesystemObj, point: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_anchor_point(particle_system: particlesystemObj, point_x: number, point_y: number)
</code></pre>
<hr>
<h1>ncine.particle_system.set_blending_factors</h1>
<pre><code class="language-lua">function ncine.particle_system.set_blending_factors(particle_system: particlesystemObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_blending_factors(particle_system: particlesystemObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<hr>
<h1>ncine.particle_system.set_blending_preset</h1>
<pre><code class="language-lua">function ncine.particle_system.set_blending_preset(particle_system: particlesystemObj, blending_preset: ncine.blending_preset)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_blending_preset(particle_system: particlesystemObj, blending_preset: ncine.blending_preset)
</code></pre>
<hr>
<h1>ncine.particle_system.set_flipped_x</h1>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_x(particle_system: particlesystemObj, flipped_x: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_x(particle_system: particlesystemObj, flipped_x: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system.set_flipped_y</h1>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_y(particle_system: particlesystemObj, flipped_y: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_flipped_y(particle_system: particlesystemObj, flipped_y: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system.set_in_local_space</h1>
<pre><code class="language-lua">function ncine.particle_system.set_in_local_space(particle_system: particlesystemObj, local_space: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_in_local_space(particle_system: particlesystemObj, local_space: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system.set_layer</h1>
<pre><code class="language-lua">function ncine.particle_system.set_layer(particle_system: particlesystemObj, layer: integer)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_layer(particle_system: particlesystemObj, layer: integer)
</code></pre>
<hr>
<h1>ncine.particle_system.set_particles_update_enabled</h1>
<pre><code class="language-lua">function ncine.particle_system.set_particles_update_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_particles_update_enabled(particle_system: particlesystemObj, enabled: boolean)
</code></pre>
<hr>
<h1>ncine.particle_system.set_texture</h1>
<pre><code class="language-lua">function ncine.particle_system.set_texture(particle_system: particlesystemObj, texture: textureObj)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_texture(particle_system: particlesystemObj, texture: textureObj)
</code></pre>
<hr>
<h1>ncine.particle_system.set_texture_rect</h1>
<pre><code class="language-lua">function ncine.particle_system.set_texture_rect(particle_system: particlesystemObj, tex_rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.particle_system.set_texture_rect(particle_system: particlesystemObj, tex_rect: ncine.rect)
</code></pre>
<hr>
<h1>ncine.permission</h1>
<pre><code class="language-lua">enum ncine.permission
</code></pre>
<pre><code class="language-lua">enum ncine.permission
</code></pre>
<hr>
<h1>ncine.rect</h1>
<h2>create</h2>
<pre><code class="language-lua">function ncine.rect.create(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<p>Creates a rect table from top-left point and size</p>
<p>@<em>param</em> <code>x</code> — The top-left X coordinate (left with positive width)</p>
<p>@<em>param</em> <code>y</code> — The top-left Y coordinate (top with positive height)</p>
<p>@<em>param</em> <code>w</code> — The width</p>
<p>@<em>param</em> <code>h</code> — The height</p>
<h2>create_center_size</h2>
<pre><code class="language-lua">function ncine.rect.create_center_size(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<p>Creates a vec2 table from center and size</p>
<p>@<em>param</em> <code>x</code> — The center X coordinate</p>
<p>@<em>param</em> <code>y</code> — The center Y coordinate</p>
<p>@<em>param</em> <code>w</code> — The width</p>
<p>@<em>param</em> <code>h</code> — The height</p>
<h2>create_min_max</h2>
<pre><code class="language-lua">function ncine.rect.create_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<p>Creates a vec2 table from its components</p>
<p>@<em>param</em> <code>min_x</code> — The minimum X coordinate</p>
<p>@<em>param</em> <code>min_y</code> — The minimum Y coordinate</p>
<p>@<em>param</em> <code>max_x</code> — The maximum X coordinate</p>
<p>@<em>param</em> <code>max_y</code> — The maximum Y coordinate</p>
<h2>h</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The height</p>
<h2>set_min_max</h2>
<pre><code class="language-lua">function ncine.rect.set_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<p>Sets rectangle minimum and maximum coordinates</p>
<h2>w</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The width</p>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The top-left X coordinate (left with positive width)</p>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The top-left Y coordinate (top with positive height)</p>
<hr>
<h1>ncine.rect</h1>
<pre><code class="language-lua">ncine.rect
</code></pre>
<pre><code class="language-lua">ncine.rect
</code></pre>
<hr>
<h1>ncine.rect.create</h1>
<pre><code class="language-lua">function ncine.rect.create(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.rect.create(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.rect.create_center_size</h1>
<pre><code class="language-lua">function ncine.rect.create_center_size(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.rect.create_center_size(x: number, y: number, w: number, h: number)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.rect.create_min_max</h1>
<pre><code class="language-lua">function ncine.rect.create_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.rect.create_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.rect.set_min_max</h1>
<pre><code class="language-lua">function ncine.rect.set_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.rect.set_min_max(min_x: number, min_y: number, max_x: number, max_y: number)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.rect_animation</h1>
<h2>frame_duration</h2>
<pre><code class="language-lua">number
</code></pre>
<p>Frame duration in seconds</p>
<h2>loop</h2>
<pre><code class="language-lua">ncine.loop_mode
</code></pre>
<p>Loop state</p>
<h2>num_rectangles_to_skip</h2>
<pre><code class="language-lua">integer?
</code></pre>
<p>Optional field, default is 0</p>
<h2>padding</h2>
<pre><code class="language-lua">(ncine.vec2)?
</code></pre>
<p>Optional field, default is { x = 0, y = 0 }</p>
<h2>rect_size</h2>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<p>A two component vector</p>
<h2>rewind</h2>
<pre><code class="language-lua">ncine.rewind_mode
</code></pre>
<p>Rewind modes</p>
<h2>source_rect</h2>
<pre><code class="language-lua">ncine.rect
</code></pre>
<p>A rectangle in 2D</p>
<hr>
<h1>ncine.rect_animation</h1>
<pre><code class="language-lua">ncine.rect_animation
</code></pre>
<pre><code class="language-lua">ncine.rect_animation
</code></pre>
<hr>
<h1>ncine.rewind_mode</h1>
<pre><code class="language-lua">enum ncine.rewind_mode
</code></pre>
<pre><code class="language-lua">enum ncine.rewind_mode
</code></pre>
<hr>
<h1>ncine.scenenode</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.scenenode</h1>
<pre><code class="language-lua">ncine.scenenode
</code></pre>
<pre><code class="language-lua">ncine.scenenode
</code></pre>
<hr>
<h1>ncine.scenenode.add_child</h1>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.get_abs_anchor_point</h1>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.scenenode.get_alpha</h1>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.scenenode.get_child</h1>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<hr>
<h1>ncine.scenenode.get_child_order_index</h1>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.scenenode.get_children</h1>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<hr>
<h1>ncine.scenenode.get_color</h1>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.scenenode.get_last_frame_updated</h1>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.scenenode.get_layer</h1>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.scenenode.get_parent</h1>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<hr>
<h1>ncine.scenenode.get_position</h1>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.scenenode.get_rotation</h1>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.scenenode.get_scale</h1>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.scenenode.get_visit_order_index</h1>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.scenenode.get_visit_order_state</h1>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<hr>
<h1>ncine.scenenode.is_enabled</h1>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.num_children</h1>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.scenenode.remove_all_children</h1>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.remove_child</h1>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.remove_child_at</h1>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.set_abs_anchor_point</h1>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, x: number, y: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, x: number, y: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_alpha</h1>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_color</h1>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, red: number, green: number, blue: number, alpha: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, red: number, green: number, blue: number, alpha: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_enabled</h1>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<hr>
<h1>ncine.scenenode.set_layer</h1>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<hr>
<h1>ncine.scenenode.set_parent</h1>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.set_position</h1>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, x: number, y: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, x: number, y: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_rotation</h1>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_scale</h1>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_scale_x</h1>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_scale_y</h1>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<hr>
<h1>ncine.scenenode.set_visit_order_state</h1>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<hr>
<h1>ncine.scenenode.swap_children</h1>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.swap_node_back</h1>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.swap_node_forward</h1>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.scenenode.unlink_child</h1>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader</h1>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.shader.delete(shader: shaderObj)
</code></pre>
<p>Destroys a shader object and releases its memory</p>
<p>@<em>param</em> <code>shader</code> — The shader object to be destroyed</p>
<h2>get_log_on_errors</h2>
<pre><code class="language-lua">function ncine.shader.get_log_on_errors(shader: shaderObj)
  -&gt; boolean
</code></pre>
<p>Returns the automatic log on errors flag</p>
<h2>is_binary_cache_enabled</h2>
<pre><code class="language-lua">function ncine.shader.is_binary_cache_enabled()
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the binary shader cache is enabled</p>
<h2>is_linked</h2>
<pre><code class="language-lua">function ncine.shader.is_linked(shader: shaderObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the shader is linked and can therefore be used</p>
<h2>load_from_file</h2>
<pre><code class="language-lua">function ncine.shader.load_from_file(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading shader sources from files</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The vertex shader source filename</p>
<p>@<em>param</em> <code>fragment</code> — The fragment shader source filename</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_file_default_fragment</h2>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading the vertex shader source from a file</p>
<p>The fragment shader is a default one, in this case.</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The vertex shader source filename</p>
<p>@<em>param</em> <code>fragment</code> — The default fragment shader</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_file_default_vertex</h2>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading the fragment shader source from a file</p>
<p>The vertex shader is a default one, in this case.</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The default vertex shader</p>
<p>@<em>param</em> <code>fragment</code> — The fragment shader source filename</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_memory</h2>
<pre><code class="language-lua">function ncine.shader.load_from_memory(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading shader sources from strings</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The vertex shader GLSL source code</p>
<p>@<em>param</em> <code>fragment</code> — The fragment shader GLSL source code</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_memory_default_fragment</h2>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading the vertex shader source from a string</p>
<p>The fragment shader is a default one, in this case.</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The vertex shader GLSL source code</p>
<p>@<em>param</em> <code>fragment</code> — The default fragment shader</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_memory_default_vertex</h2>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading the fragment shader source from a string</p>
<p>The vertex shader is a default one, in this case.</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The default vertex shader</p>
<p>@<em>param</em> <code>fragment</code> — The fragment shader GLSL source code</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>load_from_memory_with_hashes</h2>
<pre><code class="language-lua">function ncine.shader.load_from_memory_with_hashes(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string, vertex_hash: integer, fragment_hash: integer)
  -&gt; boolean
</code></pre>
<p>Compiles a shader program after loading shader sources from strings</p>
<p>In this case custom hashes can be passed to the function.</p>
<p>@<em>param</em> <code>name</code> — The name of the shader</p>
<p>@<em>param</em> <code>vertex</code> — The vertex shader GLSL source code</p>
<p>@<em>param</em> <code>fragment</code> — The fragment shader GLSL source code</p>
<p>@<em>return</em> — True if the shader program has been successfully linked</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.shader.new()
  -&gt; shaderObj
</code></pre>
<p>Constructs a shader object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/shader.lua#52">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new shader object</p>
<h2>register_batched_shader</h2>
<pre><code class="language-lua">function ncine.shader.register_batched_shader(shader: shaderObj, batched_shader: shaderObj)
</code></pre>
<p>Registers a shader to be used for batches of render commands</p>
<h2>retrieve_infolog</h2>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog(shader: shaderObj)
  -&gt; string
</code></pre>
<p>Retrieves the information log</p>
<h2>retrieve_infolog_length</h2>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog_length(shader: shaderObj)
  -&gt; integer
</code></pre>
<p>Returns the length of the information log including the null termination character</p>
<h2>set_attribute</h2>
<pre><code class="language-lua">function ncine.shader.set_attribute(shader: shaderObj, attribute: string, stride: integer, pointer: integer)
  -&gt; boolean
</code></pre>
<p>Sets the VBO stride and pointer for the specified vertex attribute</p>
<p>@<em>param</em> <code>attribute</code> — The name of the vertex attribute</p>
<p>@<em>return</em> — True if the vertex attribute was found</p>
<h2>set_binary_cache_enabled</h2>
<pre><code class="language-lua">function ncine.shader.set_binary_cache_enabled(enable: boolean)
</code></pre>
<p>Enables or disables the binary shader cache</p>
<h2>set_glshaderprogram_label</h2>
<pre><code class="language-lua">function ncine.shader.set_glshaderprogram_label(shader: shaderObj, label: string)
</code></pre>
<p>Sets the OpenGL object label for the shader program</p>
<h2>set_log_on_errors</h2>
<pre><code class="language-lua">function ncine.shader.set_log_on_errors(shader: shaderObj, should_log: boolean)
</code></pre>
<p>Sets the automatic log on errors flag</p>
<p>If the flag is set to <code>true</code>, the shader will automatically log compilation and linking errors.</p>
<hr>
<h1>ncine.shader</h1>
<pre><code class="language-lua">ncine.shader
</code></pre>
<pre><code class="language-lua">ncine.shader
</code></pre>
<hr>
<h1>ncine.shader.delete</h1>
<pre><code class="language-lua">function ncine.shader.delete(shader: shaderObj)
</code></pre>
<pre><code class="language-lua">function ncine.shader.delete(shader: shaderObj)
</code></pre>
<hr>
<h1>ncine.shader.get_log_on_errors</h1>
<pre><code class="language-lua">function ncine.shader.get_log_on_errors(shader: shaderObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.get_log_on_errors(shader: shaderObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.is_binary_cache_enabled</h1>
<pre><code class="language-lua">function ncine.shader.is_binary_cache_enabled()
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.is_binary_cache_enabled()
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.is_linked</h1>
<pre><code class="language-lua">function ncine.shader.is_linked(shader: shaderObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.is_linked(shader: shaderObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_file</h1>
<pre><code class="language-lua">function ncine.shader.load_from_file(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_file(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_file_default_fragment</h1>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_file_default_vertex</h1>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_file_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_memory</h1>
<pre><code class="language-lua">function ncine.shader.load_from_memory(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_memory(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_memory_default_fragment</h1>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_fragment(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: ncine.shader_default_fragment)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_memory_default_vertex</h1>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_memory_default_vertex(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: ncine.shader_default_vertex, fragment: string)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.load_from_memory_with_hashes</h1>
<pre><code class="language-lua">function ncine.shader.load_from_memory_with_hashes(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string, vertex_hash: integer, fragment_hash: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.load_from_memory_with_hashes(shader: shaderObj, name: string, introspection: ncine.shader_introspection, vertex: string, fragment: string, vertex_hash: integer, fragment_hash: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.new</h1>
<pre><code class="language-lua">function ncine.shader.new()
  -&gt; shaderObj
</code></pre>
<pre><code class="language-lua">function ncine.shader.new()
  -&gt; shaderObj
</code></pre>
<hr>
<h1>ncine.shader.register_batched_shader</h1>
<pre><code class="language-lua">function ncine.shader.register_batched_shader(shader: shaderObj, batched_shader: shaderObj)
</code></pre>
<pre><code class="language-lua">function ncine.shader.register_batched_shader(shader: shaderObj, batched_shader: shaderObj)
</code></pre>
<hr>
<h1>ncine.shader.retrieve_infolog</h1>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog(shader: shaderObj)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog(shader: shaderObj)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.shader.retrieve_infolog_length</h1>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog_length(shader: shaderObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.shader.retrieve_infolog_length(shader: shaderObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.shader.set_attribute</h1>
<pre><code class="language-lua">function ncine.shader.set_attribute(shader: shaderObj, attribute: string, stride: integer, pointer: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shader.set_attribute(shader: shaderObj, attribute: string, stride: integer, pointer: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shader.set_binary_cache_enabled</h1>
<pre><code class="language-lua">function ncine.shader.set_binary_cache_enabled(enable: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.shader.set_binary_cache_enabled(enable: boolean)
</code></pre>
<hr>
<h1>ncine.shader.set_glshaderprogram_label</h1>
<pre><code class="language-lua">function ncine.shader.set_glshaderprogram_label(shader: shaderObj, label: string)
</code></pre>
<pre><code class="language-lua">function ncine.shader.set_glshaderprogram_label(shader: shaderObj, label: string)
</code></pre>
<hr>
<h1>ncine.shader.set_log_on_errors</h1>
<pre><code class="language-lua">function ncine.shader.set_log_on_errors(shader: shaderObj, should_log: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.shader.set_log_on_errors(shader: shaderObj, should_log: boolean)
</code></pre>
<hr>
<h1>ncine.shader_default_fragment</h1>
<pre><code class="language-lua">enum ncine.shader_default_fragment
</code></pre>
<pre><code class="language-lua">enum ncine.shader_default_fragment
</code></pre>
<hr>
<h1>ncine.shader_default_vertex</h1>
<pre><code class="language-lua">enum ncine.shader_default_vertex
</code></pre>
<pre><code class="language-lua">enum ncine.shader_default_vertex
</code></pre>
<hr>
<h1>ncine.shader_introspection</h1>
<pre><code class="language-lua">enum ncine.shader_introspection
</code></pre>
<pre><code class="language-lua">enum ncine.shader_introspection
</code></pre>
<hr>
<h1>ncine.shaderstate</h1>
<pre><code class="language-lua">ncine.shaderstate
</code></pre>
<pre><code class="language-lua">ncine.shaderstate
</code></pre>
<hr>
<h1>ncine.shaderstate</h1>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.shaderstate.delete(shaderstate: shaderstateObj)
</code></pre>
<p>Destroys a shaderstate object and releases its memory</p>
<p>@<em>param</em> <code>shaderstate</code> — The shaderstate object to be destroyed</p>
<h2>get_node</h2>
<pre><code class="language-lua">function ncine.shaderstate.get_node(shaderstate: shaderstateObj)
  -&gt; drawablenodeObj?
</code></pre>
<p>Returns the drawable node affected by the shader state</p>
<h2>get_shader</h2>
<pre><code class="language-lua">function ncine.shaderstate.get_shader(shaderstate: shaderstateObj)
  -&gt; shaderObj?
</code></pre>
<p>Return the associated custom shader</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.shaderstate.new(node: drawablenodeObj, shader: shaderObj)
  -&gt; shaderstateObj
</code></pre>
<p>Constructs a shaderstate object and assigns to it a node and a shader</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/shaderstate.lua#21">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new shader object</p>
<h2>reset_shader</h2>
<pre><code class="language-lua">function ncine.shaderstate.reset_shader(shaderstate: shaderstateObj)
</code></pre>
<p>Triggers a shader update without setting a new shader</p>
<h2>set_node</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_node(shaderstate: shaderstateObj, node?: drawablenodeObj)
</code></pre>
<p>Sets the drawable node affected by the shader state</p>
<h2>set_shader</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_shader(shaderstate: shaderstateObj, shader?: shaderObj)
  -&gt; boolean
</code></pre>
<p>Sets the associated custom shader</p>
<p>@<em>return</em> — True if the shader has been changed</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_texture(shaderstate: shaderstateObj, unit: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<p>Assigns a texture to the specified texture unit</p>
<p>@<em>return</em> — True if the texture has been assigned</p>
<h2>set_uniform_float_color</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_color(shaderstate: shaderstateObj, block_name: string, name: string, color: ncine.color)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with a <code>ncine.color</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_value1</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: number)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with one value</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_value2</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with two values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_value3</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with three values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_value4</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number, value3: number)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with four values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_vector</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: number[])
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with an array of values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>param</em> <code>vector</code> — An array of 1 to 4 float elements</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_vector2</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with a <code>ncine.vec2</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_vector3</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with a <code>ncine.vec3</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_float_vector4</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<p>Sets a float uniform with a <code>ncine.vec4</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_value1</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with one value</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_value2</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with two values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_value3</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with three values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_value4</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer, value3: integer)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with four values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_vector</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: integer[])
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with an array of values</p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>param</em> <code>vector</code> — An array of 1 to 4 integer elements</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_vector2</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with a <code>ncine.vec2</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_vector3</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with a <code>ncine.vec3</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<h2>set_uniform_int_vector4</h2>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<p>Sets an integer uniform with a <code>ncine.vec4</code></p>
<p>@<em>param</em> <code>block_name</code> — It can be an empty string</p>
<p>@<em>param</em> <code>name</code> — Uniform name</p>
<p>@<em>return</em> — True if the uniform has been found and updated</p>
<hr>
<h1>ncine.shaderstate.delete</h1>
<pre><code class="language-lua">function ncine.shaderstate.delete(shaderstate: shaderstateObj)
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.delete(shaderstate: shaderstateObj)
</code></pre>
<hr>
<h1>ncine.shaderstate.get_node</h1>
<pre><code class="language-lua">function ncine.shaderstate.get_node(shaderstate: shaderstateObj)
  -&gt; drawablenodeObj?
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.get_node(shaderstate: shaderstateObj)
  -&gt; drawablenodeObj?
</code></pre>
<hr>
<h1>ncine.shaderstate.get_shader</h1>
<pre><code class="language-lua">function ncine.shaderstate.get_shader(shaderstate: shaderstateObj)
  -&gt; shaderObj?
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.get_shader(shaderstate: shaderstateObj)
  -&gt; shaderObj?
</code></pre>
<hr>
<h1>ncine.shaderstate.new</h1>
<pre><code class="language-lua">function ncine.shaderstate.new(node: drawablenodeObj, shader: shaderObj)
  -&gt; shaderstateObj
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.new(node: drawablenodeObj, shader: shaderObj)
  -&gt; shaderstateObj
</code></pre>
<hr>
<h1>ncine.shaderstate.reset_shader</h1>
<pre><code class="language-lua">function ncine.shaderstate.reset_shader(shaderstate: shaderstateObj)
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.reset_shader(shaderstate: shaderstateObj)
</code></pre>
<hr>
<h1>ncine.shaderstate.set_node</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_node(shaderstate: shaderstateObj, node?: drawablenodeObj)
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_node(shaderstate: shaderstateObj, node?: drawablenodeObj)
</code></pre>
<hr>
<h1>ncine.shaderstate.set_shader</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_shader(shaderstate: shaderstateObj, shader?: shaderObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_shader(shaderstate: shaderstateObj, shader?: shaderObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_texture</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_texture(shaderstate: shaderstateObj, unit: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_texture(shaderstate: shaderstateObj, unit: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_color</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_color(shaderstate: shaderstateObj, block_name: string, name: string, color: ncine.color)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_color(shaderstate: shaderstateObj, block_name: string, name: string, color: ncine.color)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_value1</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: number)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: number)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_value2</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_value3</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_value4</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number, value3: number)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: number, value1: number, value2: number, value3: number)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_vector</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: number[])
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: number[])
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_vector2</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_vector3</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_float_vector4</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_float_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_value1</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value1(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_value2</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value2(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_value3</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value3(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_value4</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer, value3: integer)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_value4(shaderstate: shaderstateObj, block_name: string, name: string, value0: integer, value1: integer, value2: integer, value3: integer)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_vector</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: integer[])
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector(shaderstate: shaderstateObj, block_name: string, name: string, vector: integer[])
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_vector2</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector2(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec2)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_vector3</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector3(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec3)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.shaderstate.set_uniform_int_vector4</h1>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.shaderstate.set_uniform_int_vector4(shaderstate: shaderstateObj, block_name: string, name: string, vector: ncine.vec4)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.sprite</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>clone</h2>
<pre><code class="language-lua">function ncine.sprite.clone(sprite: spriteObj)
  -&gt; spriteObj
</code></pre>
<p>Constructs a new sprite object as a clone of the specified one</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/sprite.lua#41">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>sprite</code> — The sprite object to be cloned</p>
<p>@<em>return</em> — The cloned sprite object</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.sprite.delete(sprite: spriteObj)
</code></pre>
<p>Destroys a sprite object and releases its memory</p>
<p>@<em>param</em> <code>sprite</code> — The sprite object to be destroyed</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_height(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of the node area</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texrect(sprite: basespriteObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the texture source rectangle for blitting</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.get_texture(sprite: basespriteObj)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture object</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_width(node: drawablenodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of the node area</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>is_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_x(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is horizontally flipped</p>
<h2>is_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.is_flipped_y(sprite: basespriteObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the sprite texture is vertically flipped</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; spriteObj
</code></pre>
<p>Constructs a sprite object with a parent scene node, a texture, and position components</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/sprite.lua#41">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>parent</code> — The parent scenenode</p>
<p>@<em>param</em> <code>texture</code> — The texture object</p>
<p>@<em>param</em> <code>x</code> — The X component of the position</p>
<p>@<em>param</em> <code>y</code> — The Y component of the position</p>
<p>@<em>return</em> — A new sprite object</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>reset_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.reset_texture(sprite: basespriteObj)
</code></pre>
<p>Triggers a texture update without setting a new texture</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_flipped_x</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_x(sprite: basespriteObj, flipped_x: boolean)
</code></pre>
<p>Flips the texture rect horizontally</p>
<h2>set_flipped_y</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_flipped_y(sprite: basespriteObj, flipped_y: boolean)
</code></pre>
<p>Flips the texture rect vertically</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_size</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_size(sprite: basespriteObj, width: number, height: number)
</code></pre>
<p>Sets the sprite size</p>
<h2>set_texrect</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texrect(sprite: basespriteObj, rect: ncine.rect)
</code></pre>
<p>Sets the texture source rectangle for blitting</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.base_sprite.set_texture(sprite: basespriteObj, texture?: textureObj)
</code></pre>
<p>Sets the texture object</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.sprite</h1>
<pre><code class="language-lua">ncine.sprite
</code></pre>
<pre><code class="language-lua">ncine.sprite
</code></pre>
<hr>
<h1>ncine.sprite.clone</h1>
<pre><code class="language-lua">function ncine.sprite.clone(sprite: spriteObj)
  -&gt; spriteObj
</code></pre>
<pre><code class="language-lua">function ncine.sprite.clone(sprite: spriteObj)
  -&gt; spriteObj
</code></pre>
<hr>
<h1>ncine.sprite.delete</h1>
<pre><code class="language-lua">function ncine.sprite.delete(sprite: spriteObj)
</code></pre>
<pre><code class="language-lua">function ncine.sprite.delete(sprite: spriteObj)
</code></pre>
<hr>
<h1>ncine.sprite.new</h1>
<pre><code class="language-lua">function ncine.sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; spriteObj
</code></pre>
<pre><code class="language-lua">function ncine.sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; spriteObj
</code></pre>
<pre><code class="language-lua">function ncine.sprite.new(parent?: scenenodeObj, texture?: textureObj, x: number, y: number)
  -&gt; spriteObj
</code></pre>
<pre><code class="language-lua">function ncine.sprite.new(parent?: scenenodeObj, texture?: textureObj, pos: ncine.vec2)
  -&gt; spriteObj
</code></pre>
<hr>
<h1>ncine.start</h1>
<pre><code class="language-lua">function ncine.start()
</code></pre>
<pre><code class="language-lua">function ncine.start()
</code></pre>
<hr>
<h1>ncine.tex_filtering</h1>
<pre><code class="language-lua">enum ncine.tex_filtering
</code></pre>
<pre><code class="language-lua">enum ncine.tex_filtering
</code></pre>
<hr>
<h1>ncine.tex_format</h1>
<pre><code class="language-lua">enum ncine.tex_format
</code></pre>
<pre><code class="language-lua">enum ncine.tex_format
</code></pre>
<hr>
<h1>ncine.tex_wrap</h1>
<pre><code class="language-lua">enum ncine.tex_wrap
</code></pre>
<pre><code class="language-lua">enum ncine.tex_wrap
</code></pre>
<hr>
<h1>ncine.text_alignment</h1>
<pre><code class="language-lua">enum ncine.text_alignment
</code></pre>
<pre><code class="language-lua">enum ncine.text_alignment
</code></pre>
<hr>
<h1>ncine.textnode</h1>
<pre><code class="language-lua">ncine.textnode
</code></pre>
<pre><code class="language-lua">ncine.textnode
</code></pre>
<hr>
<h1>ncine.textnode</h1>
<h2>add_child</h2>
<pre><code class="language-lua">function ncine.scenenode.add_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Adds a child node to the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been added</p>
<h2>calculate_boundaries</h2>
<pre><code class="language-lua">function ncine.textnode.calculate_boundaries(font: fontObj, with_kerning: boolean, string: string)
  -&gt; ncine.vec2
</code></pre>
<p>Calculates the rectangle boundaries needed to render the provided string with the specified font</p>
<h2>clone</h2>
<pre><code class="language-lua">function ncine.textnode.clone(textnode: textnodeObj)
  -&gt; textnodeObj
</code></pre>
<p>Constructs a new textnode object as a clone of the specified one</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/textnode.lua#38">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>textnode</code> — The textnode object to be cloned</p>
<p>@<em>return</em> — The cloned textnode object</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.textnode.delete(textnode: textnodeObj)
</code></pre>
<p>Destroys a textnode object and releases its memory</p>
<p>@<em>param</em> <code>textnode</code> — The textnode object to be destroyed</p>
<h2>get_aabb</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_aabb(node: drawablenodeObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the axis-aligned bounding box of the node area in the last frame</p>
<h2>get_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.get_abs_anchor_point(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the absolute transformation anchor point in pixels</p>
<h2>get_absheight</h2>
<pre><code class="language-lua">function ncine.textnode.get_absheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the absolute height of rendered text</p>
<h2>get_abslineheight</h2>
<pre><code class="language-lua">function ncine.textnode.get_abslineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the text node line height multiplied by the absolute vertical scale factor</p>
<h2>get_abswidth</h2>
<pre><code class="language-lua">function ncine.textnode.get_abswidth(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the absolute width of rendered text</p>
<h2>get_alignment</h2>
<pre><code class="language-lua">function ncine.textnode.get_alignment(textnode: textnodeObj)
  -&gt; ncine.text_alignment
</code></pre>
<p>Returns the horizontal text alignment of multiple lines</p>
<h2>get_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.get_alpha(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node alpha color component</p>
<h2>get_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_anchor_point(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the transformation anchor point</p>
<h2>get_child</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child(node: scenenodeObj, index: integer)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the n-th child</p>
<h2>get_child_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_child_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the order index of this node among its siblings</p>
<p>@<em>return</em> — The order index or zero if the node has no parent</p>
<h2>get_children</h2>
<pre><code class="language-lua">function ncine.scenenode.get_children(node: scenenodeObj)
  -&gt; scenenodeObj[]
</code></pre>
<p>Returns the array of children</p>
<h2>get_color</h2>
<pre><code class="language-lua">function ncine.scenenode.get_color(node: scenenodeObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the node color</p>
<h2>get_dest_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_dest_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>Returns the destination blending factor</p>
<h2>get_font</h2>
<pre><code class="language-lua">function ncine.textnode.get_font(textnode: textnodeObj)
  -&gt; fontObj
</code></pre>
<p>Returns the font object used by the textnode</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.textnode.get_height(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the height of rendered text</p>
<h2>get_kerning</h2>
<pre><code class="language-lua">function ncine.textnode.get_kerning(textnode: textnodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if kerning is enabled for this node rendering</p>
<h2>get_last_frame_rendered</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_last_frame_rendered(node: drawablenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have rendered this node (node was not culled)</p>
<h2>get_last_frame_updated</h2>
<pre><code class="language-lua">function ncine.scenenode.get_last_frame_updated(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame in which any of the viewports have updated this node</p>
<h2>get_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.get_layer(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the node rendering layer</p>
<h2>get_lineheight</h2>
<pre><code class="language-lua">function ncine.textnode.get_lineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the text node line height</p>
<h2>get_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.get_parent(node: scenenodeObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the parent node, if there is any</p>
<h2>get_position</h2>
<pre><code class="language-lua">function ncine.scenenode.get_position(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node position relative to its parent</p>
<h2>get_render_mode</h2>
<pre><code class="language-lua">function ncine.textnode.get_render_mode(textnode: textnodeObj)
  -&gt; ncine.font_render_mode
</code></pre>
<p>Returns the render mode used to render this text node</p>
<h2>get_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.get_rotation(node: scenenodeObj)
  -&gt; number
</code></pre>
<p>Returns the node rotation in degress</p>
<h2>get_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.get_scale(node: scenenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the node scale factors</p>
<h2>get_size</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_size(node: drawablenodeObj)
  -&gt; ncine.vec2
</code></pre>
<p>Returns the size of the node area</p>
<h2>get_src_blending_factor</h2>
<pre><code class="language-lua">function ncine.drawable_node.get_src_blending_factor(node: drawablenodeObj)
  -&gt; ncine.blending_factor
</code></pre>
<p>eturns the source blending factor</p>
<h2>get_string</h2>
<pre><code class="language-lua">function ncine.textnode.get_string(textnode: textnodeObj)
  -&gt; string
</code></pre>
<p>Returns the string to render</p>
<h2>get_visit_order_index</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_index(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the visit drawing order of the node</p>
<h2>get_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.get_visit_order_state(node: scenenodeObj)
  -&gt; ncine.visit_order_state
</code></pre>
<p>Returns the visit order state for the specified node</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.textnode.get_width(textnode: textnodeObj)
  -&gt; number
</code></pre>
<p>Returns the width of rendered text</p>
<h2>is_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.is_blending_enabled(node: drawablenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node renders with blending enabled</p>
<h2>is_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.is_enabled(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the node is both updating and drawing</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.textnode.new(parent?: scenenodeObj, font?: fontObj, max_string_length: integer)
  -&gt; textnodeObj
</code></pre>
<p>Constructs a textnode object with a parent scene node, a font, and a maximum text string length</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/textnode.lua#38">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>parent</code> — The parent scenenode</p>
<p>@<em>param</em> <code>font</code> — The font object</p>
<p>@<em>param</em> <code>max_string_length</code> — The maximum length for the text</p>
<p>@<em>return</em> — A new textnode object</p>
<h2>num_children</h2>
<pre><code class="language-lua">function ncine.scenenode.num_children(node: scenenodeObj)
  -&gt; integer
</code></pre>
<p>Returns the number of children</p>
<h2>remove_all_children</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_all_children(parent: scenenodeObj, index: any)
  -&gt; boolean
</code></pre>
<p>Removes all children from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if there were at least one node to remove</p>
<h2>remove_child</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Removes a child node from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>remove_child_at</h2>
<pre><code class="language-lua">function ncine.scenenode.remove_child_at(parent: scenenodeObj, index: integer)
  -&gt; boolean
</code></pre>
<p>Removes a child node at the specified index from the specified parent</p>
<p>@<em>return</em> — <code>true</code> if the node has been removed</p>
<h2>set_abs_anchor_point</h2>
<pre><code class="language-lua">function ncine.scenenode.set_abs_anchor_point(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets the absolute transformation anchor point in pixels</p>
<h2>set_alignment</h2>
<pre><code class="language-lua">function ncine.textnode.set_alignment(textnode: textnodeObj, text_alignment: ncine.text_alignment)
</code></pre>
<p>Sets the horizontal text alignment of multiple lines</p>
<h2>set_alpha</h2>
<pre><code class="language-lua">function ncine.scenenode.set_alpha(node: scenenodeObj, alpha: number)
</code></pre>
<p>Sets the node alpha color component</p>
<h2>set_anchor_point</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_anchor_point(node: drawablenodeObj, anchor_point: ncine.vec2)
</code></pre>
<p>Sets the transformation anchor point</p>
<h2>set_blending_enabled</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_enabled(node: drawablenodeObj, enabled: boolean)
</code></pre>
<p>Sets the blending state for node rendering</p>
<h2>set_blending_factors</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_factors(node: drawablenodeObj, src_factor: ncine.blending_factor, dest_factor: ncine.blending_factor)
</code></pre>
<p>Sets a specific source and destination blending factors</p>
<h2>set_blending_preset</h2>
<pre><code class="language-lua">function ncine.drawable_node.set_blending_preset(node: drawablenodeObj, preset: ncine.blending_preset)
</code></pre>
<p>Sets a blending preset for source and destination blending factors</p>
<h2>set_color</h2>
<pre><code class="language-lua">function ncine.scenenode.set_color(node: scenenodeObj, color: ncine.color)
</code></pre>
<p>Sets the node color</p>
<h2>set_enabled</h2>
<pre><code class="language-lua">function ncine.scenenode.set_enabled(node: scenenodeObj, newValue: boolean)
</code></pre>
<p>Enables or disables both node updating and drawing</p>
<h2>set_font</h2>
<pre><code class="language-lua">function ncine.textnode.set_font(textnode: textnodeObj, font: fontObj)
</code></pre>
<p>Sets the font object to be used by the textnode</p>
<h2>set_kerning</h2>
<pre><code class="language-lua">function ncine.textnode.set_kerning(textnode: textnodeObj, with_kerning: boolean)
</code></pre>
<p>Sets the kerning flag for this node rendering</p>
<h2>set_layer</h2>
<pre><code class="language-lua">function ncine.scenenode.set_layer(node: scenenodeObj, layer: integer)
</code></pre>
<p>Sets the node rendering layer</p>
<p>The lowest value (bottom) is 0 and the highest one (top) is 65535.<br>
When the value is 0, the final layer value is inherited from the parent.</p>
<h2>set_lineheight</h2>
<pre><code class="language-lua">function ncine.textnode.set_lineheight(textnode: textnodeObj, line_height: number)
</code></pre>
<p>Sets the text node line height</p>
<h2>set_parent</h2>
<pre><code class="language-lua">function ncine.scenenode.set_parent(node: scenenodeObj, parent?: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Sets the parent node</p>
<p>@<em>return</em> — <code>true</code> if the parent has been set</p>
<h2>set_position</h2>
<pre><code class="language-lua">function ncine.scenenode.set_position(node: scenenodeObj, pos: ncine.vec2)
</code></pre>
<p>Sets a new position for the node</p>
<h2>set_render_mode</h2>
<pre><code class="language-lua">function ncine.textnode.set_render_mode(textnode: textnodeObj, font_render_mode: ncine.font_render_mode)
</code></pre>
<p>Sets the render mode used to render this text node, overriding the font one</p>
<h2>set_rotation</h2>
<pre><code class="language-lua">function ncine.scenenode.set_rotation(node: scenenodeObj, rot: number)
</code></pre>
<p>Sets the node rotation in degrees</p>
<p>@<em>param</em> <code>rot</code> — The amount of degrees</p>
<h2>set_scale</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets both node scale factors to the specified value</p>
<h2>set_scale_x</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_x(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale X factor</p>
<h2>set_scale_y</h2>
<pre><code class="language-lua">function ncine.scenenode.set_scale_y(node: scenenodeObj, factor: number)
</code></pre>
<p>Sets the node scale Y factor</p>
<h2>set_string</h2>
<pre><code class="language-lua">function ncine.textnode.set_string(textnode: textnodeObj, string: string)
</code></pre>
<p>Sets the string to render</p>
<h2>set_visit_order_state</h2>
<pre><code class="language-lua">function ncine.scenenode.set_visit_order_state(node: scenenodeObj, state: ncine.visit_order_state)
</code></pre>
<p>Sets the visit order state for the specified node</p>
<h2>swap_children</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_children(parent: scenenodeObj, firstIndex: integer, secondIndex: integer)
  -&gt; boolean
</code></pre>
<p>Swaps two children at the specified indices</p>
<p>@<em>return</em> — <code>true</code> if the two nodes have been swapped</p>
<h2>swap_node_back</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_back(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node back in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position back</p>
<h2>swap_node_forward</h2>
<pre><code class="language-lua">function ncine.scenenode.swap_node_forward(node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Brings this node one node forward in the parent's list of children</p>
<p>@<em>return</em> — <code>true</code> if the node has been brought one position forward</p>
<h2>unlink_child</h2>
<pre><code class="language-lua">function ncine.scenenode.unlink_child(parent: scenenodeObj, node: scenenodeObj)
  -&gt; boolean
</code></pre>
<p>Unlinks a child node from the specified parent</p>
<p>The children of the unlinked node will be reparented with the grandparent node</p>
<p>@<em>return</em> — <code>true</code> if the node has been unlinked</p>
<hr>
<h1>ncine.textnode.calculate_boundaries</h1>
<pre><code class="language-lua">function ncine.textnode.calculate_boundaries(font: fontObj, with_kerning: boolean, string: string)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.textnode.calculate_boundaries(font: fontObj, with_kerning: boolean, string: string)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.textnode.clone</h1>
<pre><code class="language-lua">function ncine.textnode.clone(textnode: textnodeObj)
  -&gt; textnodeObj
</code></pre>
<pre><code class="language-lua">function ncine.textnode.clone(textnode: textnodeObj)
  -&gt; textnodeObj
</code></pre>
<hr>
<h1>ncine.textnode.delete</h1>
<pre><code class="language-lua">function ncine.textnode.delete(textnode: textnodeObj)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.delete(textnode: textnodeObj)
</code></pre>
<hr>
<h1>ncine.textnode.get_absheight</h1>
<pre><code class="language-lua">function ncine.textnode.get_absheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_absheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.get_abslineheight</h1>
<pre><code class="language-lua">function ncine.textnode.get_abslineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_abslineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.get_abswidth</h1>
<pre><code class="language-lua">function ncine.textnode.get_abswidth(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_abswidth(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.get_alignment</h1>
<pre><code class="language-lua">function ncine.textnode.get_alignment(textnode: textnodeObj)
  -&gt; ncine.text_alignment
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_alignment(textnode: textnodeObj)
  -&gt; ncine.text_alignment
</code></pre>
<hr>
<h1>ncine.textnode.get_font</h1>
<pre><code class="language-lua">function ncine.textnode.get_font(textnode: textnodeObj)
  -&gt; fontObj
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_font(textnode: textnodeObj)
  -&gt; fontObj
</code></pre>
<hr>
<h1>ncine.textnode.get_height</h1>
<pre><code class="language-lua">function ncine.textnode.get_height(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_height(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.get_kerning</h1>
<pre><code class="language-lua">function ncine.textnode.get_kerning(textnode: textnodeObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_kerning(textnode: textnodeObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.textnode.get_lineheight</h1>
<pre><code class="language-lua">function ncine.textnode.get_lineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_lineheight(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.get_render_mode</h1>
<pre><code class="language-lua">function ncine.textnode.get_render_mode(textnode: textnodeObj)
  -&gt; ncine.font_render_mode
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_render_mode(textnode: textnodeObj)
  -&gt; ncine.font_render_mode
</code></pre>
<hr>
<h1>ncine.textnode.get_string</h1>
<pre><code class="language-lua">function ncine.textnode.get_string(textnode: textnodeObj)
  -&gt; string
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_string(textnode: textnodeObj)
  -&gt; string
</code></pre>
<hr>
<h1>ncine.textnode.get_width</h1>
<pre><code class="language-lua">function ncine.textnode.get_width(textnode: textnodeObj)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.textnode.get_width(textnode: textnodeObj)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.textnode.new</h1>
<pre><code class="language-lua">function ncine.textnode.new(parent?: scenenodeObj, font?: fontObj, max_string_length: integer)
  -&gt; textnodeObj
</code></pre>
<pre><code class="language-lua">function ncine.textnode.new(parent?: scenenodeObj, font?: fontObj, max_string_length: integer)
  -&gt; textnodeObj
</code></pre>
<hr>
<h1>ncine.textnode.set_alignment</h1>
<pre><code class="language-lua">function ncine.textnode.set_alignment(textnode: textnodeObj, text_alignment: ncine.text_alignment)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_alignment(textnode: textnodeObj, text_alignment: ncine.text_alignment)
</code></pre>
<hr>
<h1>ncine.textnode.set_font</h1>
<pre><code class="language-lua">function ncine.textnode.set_font(textnode: textnodeObj, font: fontObj)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_font(textnode: textnodeObj, font: fontObj)
</code></pre>
<hr>
<h1>ncine.textnode.set_kerning</h1>
<pre><code class="language-lua">function ncine.textnode.set_kerning(textnode: textnodeObj, with_kerning: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_kerning(textnode: textnodeObj, with_kerning: boolean)
</code></pre>
<hr>
<h1>ncine.textnode.set_lineheight</h1>
<pre><code class="language-lua">function ncine.textnode.set_lineheight(textnode: textnodeObj, line_height: number)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_lineheight(textnode: textnodeObj, line_height: number)
</code></pre>
<hr>
<h1>ncine.textnode.set_render_mode</h1>
<pre><code class="language-lua">function ncine.textnode.set_render_mode(textnode: textnodeObj, font_render_mode: ncine.font_render_mode)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_render_mode(textnode: textnodeObj, font_render_mode: ncine.font_render_mode)
</code></pre>
<hr>
<h1>ncine.textnode.set_string</h1>
<pre><code class="language-lua">function ncine.textnode.set_string(textnode: textnodeObj, string: string)
</code></pre>
<pre><code class="language-lua">function ncine.textnode.set_string(textnode: textnodeObj, string: string)
</code></pre>
<hr>
<h1>ncine.texture</h1>
<pre><code class="language-lua">ncine.texture
</code></pre>
<pre><code class="language-lua">ncine.texture
</code></pre>
<hr>
<h1>ncine.texture</h1>
<h2>datasize</h2>
<pre><code class="language-lua">function ncine.texture.datasize(texture: textureObj)
  -&gt; integer
</code></pre>
<p>Returns the amount of video memory needed to load the texture</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.texture.delete(texture: textureObj)
</code></pre>
<p>Destroys a texture object and releases its memory</p>
<p>@<em>param</em> <code>texture</code> — The texture object to be destroyed</p>
<h2>get_chromakey_color</h2>
<pre><code class="language-lua">function ncine.texture.get_chromakey_color(texture: textureObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the color treated as transparent when loading a texture</p>
<h2>get_format</h2>
<pre><code class="language-lua">function ncine.texture.get_format(texture: textureObj)
  -&gt; ncine.tex_format
</code></pre>
<p>Returns the texture format</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.texture.get_height(texture: textureObj)
  -&gt; integer
</code></pre>
<p>Returns the texture height</p>
<h2>get_mag_filtering</h2>
<pre><code class="language-lua">function ncine.texture.get_mag_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<p>Returns the filtering mode used for magnification</p>
<h2>get_min_filtering</h2>
<pre><code class="language-lua">function ncine.texture.get_min_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<p>Returns the filtering mode used for minification</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.texture.get_width(texture: textureObj)
  -&gt; integer
</code></pre>
<p>Returns the texture width</p>
<h2>get_wrap</h2>
<pre><code class="language-lua">function ncine.texture.get_wrap(texture: textureObj)
  -&gt; ncine.tex_wrap
</code></pre>
<p>Returns the wrap mode used for the <code>s</code> and <code>t</code> directions</p>
<h2>init</h2>
<pre><code class="language-lua">function ncine.texture.init(texture: textureObj, name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
</code></pre>
<p>Initializes a texture object to a blank texture</p>
<p>@<em>param</em> <code>name</code> — The name for the new texture object</p>
<p>@<em>param</em> <code>format</code> — The texture format</p>
<p>@<em>param</em> <code>mip_count</code> — The number of MIP map levels</p>
<p>@<em>param</em> <code>size</code> — The texture size</p>
<h2>is_chromakey_enabled</h2>
<pre><code class="language-lua">function ncine.texture.is_chromakey_enabled(texture: textureObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if chroma key transparency will be used when loading</p>
<h2>is_compressed</h2>
<pre><code class="language-lua">function ncine.texture.is_compressed(texture: textureObj)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the texture holds compressed data</p>
<h2>mip_levels</h2>
<pre><code class="language-lua">function ncine.texture.mip_levels(texture: textureObj)
  -&gt; integer
</code></pre>
<p>Returns the number of MIP map levels</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.texture.new(filename: string)
  -&gt; textureObj
</code></pre>
<p>Constructs a texture object from an image file</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/texture.lua#72">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>filename</code> — The path to an image file</p>
<p>@<em>return</em> — A new texture object</p>
<h2>new_init</h2>
<pre><code class="language-lua">function ncine.texture.new_init(name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
  -&gt; textureObj
</code></pre>
<p>Constructs a blank texture</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/lua-language-server-3.13.0-linux-x64/../nCine-LuaCATS/library/texture.lua#72">delete</a> when you are done with it!</p>
<p>@<em>param</em> <code>name</code> — The name for the new texture object</p>
<p>@<em>param</em> <code>format</code> — The texture format</p>
<p>@<em>param</em> <code>mip_count</code> — The number of MIP map levels</p>
<p>@<em>param</em> <code>size</code> — The texture size</p>
<p>@<em>return</em> — A new texture object</p>
<h2>num_channels</h2>
<pre><code class="language-lua">function ncine.texture.num_channels(texture: textureObj)
  -&gt; integer
</code></pre>
<p>Returns the number of color channels</p>
<h2>set_chromakey_color</h2>
<pre><code class="language-lua">function ncine.texture.set_chromakey_color(texture: textureObj, color: ncine.color)
</code></pre>
<p>Sets the color to be treated as transparent when loading a texture through a <code>ncine.color</code> table</p>
<h2>set_chromakey_enabled</h2>
<pre><code class="language-lua">function ncine.texture.set_chromakey_enabled(texture: textureObj, state: boolean)
</code></pre>
<p>Sets the chroma key transparency state to use when loading</p>
<h2>set_gltexture_label</h2>
<pre><code class="language-lua">function ncine.texture.set_gltexture_label(texture: textureObj, label: string)
</code></pre>
<p>Sets the OpenGL object label for the texture</p>
<h2>set_mag_filtering</h2>
<pre><code class="language-lua">function ncine.texture.set_mag_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<p>Sets the filtering mode used for magnification</p>
<h2>set_min_filtering</h2>
<pre><code class="language-lua">function ncine.texture.set_min_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<p>Sets the filtering mode used for minification</p>
<h2>set_wrap</h2>
<pre><code class="language-lua">function ncine.texture.set_wrap(texture: textureObj, wrap: ncine.tex_wrap)
</code></pre>
<p>Sets the wrap mode used for the <code>s</code> and <code>t</code> directions</p>
<hr>
<h1>ncine.texture.datasize</h1>
<pre><code class="language-lua">function ncine.texture.datasize(texture: textureObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.texture.datasize(texture: textureObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.texture.delete</h1>
<pre><code class="language-lua">function ncine.texture.delete(texture: textureObj)
</code></pre>
<pre><code class="language-lua">function ncine.texture.delete(texture: textureObj)
</code></pre>
<hr>
<h1>ncine.texture.get_chromakey_color</h1>
<pre><code class="language-lua">function ncine.texture.get_chromakey_color(texture: textureObj)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_chromakey_color(texture: textureObj)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.texture.get_format</h1>
<pre><code class="language-lua">function ncine.texture.get_format(texture: textureObj)
  -&gt; ncine.tex_format
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_format(texture: textureObj)
  -&gt; ncine.tex_format
</code></pre>
<hr>
<h1>ncine.texture.get_height</h1>
<pre><code class="language-lua">function ncine.texture.get_height(texture: textureObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_height(texture: textureObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.texture.get_mag_filtering</h1>
<pre><code class="language-lua">function ncine.texture.get_mag_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_mag_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<hr>
<h1>ncine.texture.get_min_filtering</h1>
<pre><code class="language-lua">function ncine.texture.get_min_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_min_filtering(texture: textureObj)
  -&gt; ncine.tex_filtering
</code></pre>
<hr>
<h1>ncine.texture.get_width</h1>
<pre><code class="language-lua">function ncine.texture.get_width(texture: textureObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_width(texture: textureObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.texture.get_wrap</h1>
<pre><code class="language-lua">function ncine.texture.get_wrap(texture: textureObj)
  -&gt; ncine.tex_wrap
</code></pre>
<pre><code class="language-lua">function ncine.texture.get_wrap(texture: textureObj)
  -&gt; ncine.tex_wrap
</code></pre>
<hr>
<h1>ncine.texture.init</h1>
<pre><code class="language-lua">function ncine.texture.init(texture: textureObj, name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.texture.init(texture: textureObj, name: string, format: ncine.tex_format, mip_count: integer, x: integer, y: integer)
</code></pre>
<pre><code class="language-lua">function ncine.texture.init(texture: textureObj, name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
</code></pre>
<pre><code class="language-lua">function ncine.texture.init(texture: textureObj, name: string, format: ncine.tex_format, mip_count: integer, x: integer, y: integer)
</code></pre>
<hr>
<h1>ncine.texture.is_chromakey_enabled</h1>
<pre><code class="language-lua">function ncine.texture.is_chromakey_enabled(texture: textureObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.texture.is_chromakey_enabled(texture: textureObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.texture.is_compressed</h1>
<pre><code class="language-lua">function ncine.texture.is_compressed(texture: textureObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.texture.is_compressed(texture: textureObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.texture.mip_levels</h1>
<pre><code class="language-lua">function ncine.texture.mip_levels(texture: textureObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.texture.mip_levels(texture: textureObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.texture.new</h1>
<pre><code class="language-lua">function ncine.texture.new(filename: string)
  -&gt; textureObj
</code></pre>
<pre><code class="language-lua">function ncine.texture.new(filename: string)
  -&gt; textureObj
</code></pre>
<hr>
<h1>ncine.texture.new_init</h1>
<pre><code class="language-lua">function ncine.texture.new_init(name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
  -&gt; textureObj
</code></pre>
<pre><code class="language-lua">function ncine.texture.new_init(name: string, format: ncine.tex_format, mip_count: integer, x: integer, y: integer)
  -&gt; textureObj
</code></pre>
<pre><code class="language-lua">function ncine.texture.new_init(name: string, format: ncine.tex_format, mip_count: integer, size: ncine.vec2)
  -&gt; textureObj
</code></pre>
<pre><code class="language-lua">function ncine.texture.new_init(name: string, format: ncine.tex_format, mip_count: integer, x: integer, y: integer)
  -&gt; textureObj
</code></pre>
<hr>
<h1>ncine.texture.num_channels</h1>
<pre><code class="language-lua">function ncine.texture.num_channels(texture: textureObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.texture.num_channels(texture: textureObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.texture.set_chromakey_color</h1>
<pre><code class="language-lua">function ncine.texture.set_chromakey_color(texture: textureObj, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_chromakey_color(texture: textureObj, r: number, g: number, b: number, a: number)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_chromakey_color(texture: textureObj, color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_chromakey_color(texture: textureObj, r: number, g: number, b: number, a: number)
</code></pre>
<hr>
<h1>ncine.texture.set_chromakey_enabled</h1>
<pre><code class="language-lua">function ncine.texture.set_chromakey_enabled(texture: textureObj, state: boolean)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_chromakey_enabled(texture: textureObj, state: boolean)
</code></pre>
<hr>
<h1>ncine.texture.set_gltexture_label</h1>
<pre><code class="language-lua">function ncine.texture.set_gltexture_label(texture: textureObj, label: string)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_gltexture_label(texture: textureObj, label: string)
</code></pre>
<hr>
<h1>ncine.texture.set_mag_filtering</h1>
<pre><code class="language-lua">function ncine.texture.set_mag_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_mag_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<hr>
<h1>ncine.texture.set_min_filtering</h1>
<pre><code class="language-lua">function ncine.texture.set_min_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_min_filtering(texture: textureObj, filtering: ncine.tex_filtering)
</code></pre>
<hr>
<h1>ncine.texture.set_wrap</h1>
<pre><code class="language-lua">function ncine.texture.set_wrap(texture: textureObj, wrap: ncine.tex_wrap)
</code></pre>
<pre><code class="language-lua">function ncine.texture.set_wrap(texture: textureObj, wrap: ncine.tex_wrap)
</code></pre>
<hr>
<h1>ncine.texture_cut_mode</h1>
<pre><code class="language-lua">enum ncine.texture_cut_mode
</code></pre>
<pre><code class="language-lua">enum ncine.texture_cut_mode
</code></pre>
<hr>
<h1>ncine.timestamp</h1>
<pre><code class="language-lua">table
</code></pre>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>ncine.timestamp.hash_file_stat</h1>
<pre><code class="language-lua">function ncine.timestamp.hash_file_stat(filepath: string)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.hash_file_stat(filepath: string)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.timestamp.hash_string</h1>
<pre><code class="language-lua">function ncine.timestamp.hash_string(string: string)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.hash_string(string: string)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.timestamp.microseconds</h1>
<pre><code class="language-lua">function ncine.timestamp.microseconds(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.microseconds(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.microseconds_since</h1>
<pre><code class="language-lua">function ncine.timestamp.microseconds_since(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.microseconds_since(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.milliseconds</h1>
<pre><code class="language-lua">function ncine.timestamp.milliseconds(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.milliseconds(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.milliseconds_since</h1>
<pre><code class="language-lua">function ncine.timestamp.milliseconds_since(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.milliseconds_since(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.nanoseconds</h1>
<pre><code class="language-lua">function ncine.timestamp.nanoseconds(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.nanoseconds(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.nanoseconds_since</h1>
<pre><code class="language-lua">function ncine.timestamp.nanoseconds_since(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.nanoseconds_since(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.now</h1>
<pre><code class="language-lua">function ncine.timestamp.now()
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.now()
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.timestamp.scan_hash_string</h1>
<pre><code class="language-lua">function ncine.timestamp.scan_hash_string(string: string)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.scan_hash_string(string: string)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.timestamp.seconds</h1>
<pre><code class="language-lua">function ncine.timestamp.seconds(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.seconds(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.seconds_since</h1>
<pre><code class="language-lua">function ncine.timestamp.seconds_since(counter: integer)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.seconds_since(counter: integer)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.timestamp.ticks_since</h1>
<pre><code class="language-lua">function ncine.timestamp.ticks_since(counter: integer)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.timestamp.ticks_since(counter: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.vec2</h1>
<h2>add</h2>
<pre><code class="language-lua">function ncine.vec2.add(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<p>Adds two vectors together, component-wise</p>
<h2>contains</h2>
<pre><code class="language-lua">function ncine.vec2.contains(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the other rectangle is contained inside this one</p>
<h2>contains_point</h2>
<pre><code class="language-lua">function ncine.vec2.contains_point(rect: ncine.rect, x: number, y: number)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if the point is inside this rectangle</p>
<h2>create</h2>
<pre><code class="language-lua">function ncine.vec2.create(x: number, y: number)
  -&gt; ncine.vec2
</code></pre>
<p>Creates a vec2 table from its components</p>
<p>@<em>param</em> <code>x</code> — The X component</p>
<p>@<em>param</em> <code>y</code> — The Y component</p>
<h2>div</h2>
<pre><code class="language-lua">function ncine.vec2.div(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<p>Divides the first vector by the second one, component-wise</p>
<h2>dot</h2>
<pre><code class="language-lua">function ncine.vec2.dot(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; number
</code></pre>
<p>Returns the dot product between the two vectors</p>
<h2>get_center</h2>
<pre><code class="language-lua">function ncine.vec2.get_center(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<p>Calculates the center of the rectangle</p>
<p>@<em>return</em> — The center coordinates</p>
<h2>get_max</h2>
<pre><code class="language-lua">function ncine.vec2.get_max(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<p>Calculates the maximum coordinates of the rectangle</p>
<p>@<em>return</em> — The maximum coordinates</p>
<h2>get_min</h2>
<pre><code class="language-lua">function ncine.vec2.get_min(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<p>Calculates the minimum coordinates of the rectangle</p>
<p>@<em>return</em> — The minimum coordinates</p>
<h2>intersect</h2>
<pre><code class="language-lua">function ncine.vec2.intersect(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<p>Intersects this rectangle with the other rectangle</p>
<h2>invert_size</h2>
<pre><code class="language-lua">function ncine.vec2.invert_size(rect: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<p>Inverts rectangle size and moves (x, y) to a different angle</p>
<h2>length</h2>
<pre><code class="language-lua">function ncine.vec2.length(vec: ncine.vec2)
  -&gt; number
</code></pre>
<p>Returns the length of the vector</p>
<h2>mul</h2>
<pre><code class="language-lua">function ncine.vec2.mul(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<p>Multiplies two vectors together, component-wise</p>
<h2>normalized</h2>
<pre><code class="language-lua">function ncine.vec2.normalized(vec: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<p>Returns a normalized version of the vector</p>
<h2>overlaps</h2>
<pre><code class="language-lua">function ncine.vec2.overlaps(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<p>Returns <code>true</code> if this rect does overlap the other rectangle in any way</p>
<h2>set_center</h2>
<pre><code class="language-lua">function ncine.vec2.set_center(rect: ncine.rect, x: number, y: number)
</code></pre>
<p>Retains rectangle size but moves its center to another position</p>
<h2>sqrlength</h2>
<pre><code class="language-lua">function ncine.vec2.sqrlength(vec: ncine.vec2)
  -&gt; number
</code></pre>
<p>Returns the squared length of the vector</p>
<h2>sub</h2>
<pre><code class="language-lua">function ncine.vec2.sub(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<p>Subtracts the second vector from the first one, component-wise</p>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The X component</p>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The Y component</p>
<hr>
<h1>ncine.vec2</h1>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<pre><code class="language-lua">ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.add</h1>
<pre><code class="language-lua">function ncine.vec2.add(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.add(vec0: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.add(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.add(vec0: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.contains</h1>
<pre><code class="language-lua">function ncine.vec2.contains(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.vec2.contains(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.vec2.contains_point</h1>
<pre><code class="language-lua">function ncine.vec2.contains_point(rect: ncine.rect, x: number, y: number)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.vec2.contains_point(rect: ncine.rect, x: number, y: number)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.vec2.create</h1>
<pre><code class="language-lua">function ncine.vec2.create(x: number, y: number)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.create(x: number, y: number)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.div</h1>
<pre><code class="language-lua">function ncine.vec2.div(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.div(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.div(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.div(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.dot</h1>
<pre><code class="language-lua">function ncine.vec2.dot(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec2.dot(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec2.get_center</h1>
<pre><code class="language-lua">function ncine.vec2.get_center(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.get_center(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.get_max</h1>
<pre><code class="language-lua">function ncine.vec2.get_max(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.get_max(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.get_min</h1>
<pre><code class="language-lua">function ncine.vec2.get_min(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.get_min(rect: ncine.rect)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.intersect</h1>
<pre><code class="language-lua">function ncine.vec2.intersect(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.vec2.intersect(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.vec2.invert_size</h1>
<pre><code class="language-lua">function ncine.vec2.invert_size(rect: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.vec2.invert_size(rect: ncine.rect)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.vec2.length</h1>
<pre><code class="language-lua">function ncine.vec2.length(vec: ncine.vec2)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec2.length(vec: ncine.vec2)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec2.mul</h1>
<pre><code class="language-lua">function ncine.vec2.mul(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.mul(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.mul(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.mul(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.normalized</h1>
<pre><code class="language-lua">function ncine.vec2.normalized(vec: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.normalized(vec: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec2.overlaps</h1>
<pre><code class="language-lua">function ncine.vec2.overlaps(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.vec2.overlaps(rect0: ncine.rect, rect1: ncine.rect)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.vec2.set_center</h1>
<pre><code class="language-lua">function ncine.vec2.set_center(rect: ncine.rect, x: number, y: number)
</code></pre>
<pre><code class="language-lua">function ncine.vec2.set_center(rect: ncine.rect, x: number, y: number)
</code></pre>
<hr>
<h1>ncine.vec2.sqrlength</h1>
<pre><code class="language-lua">function ncine.vec2.sqrlength(vec: ncine.vec2)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec2.sqrlength(vec: ncine.vec2)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec2.sub</h1>
<pre><code class="language-lua">function ncine.vec2.sub(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.sub(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.sub(vec0: ncine.vec2, vec1: ncine.vec2)
  -&gt; ncine.vec2
</code></pre>
<pre><code class="language-lua">function ncine.vec2.sub(vec: ncine.vec2, scalar: number)
  -&gt; ncine.vec2
</code></pre>
<hr>
<h1>ncine.vec3</h1>
<pre><code class="language-lua">ncine.vec3
</code></pre>
<pre><code class="language-lua">ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3</h1>
<h2>add</h2>
<pre><code class="language-lua">function ncine.vec3.add(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<p>Adds two vectors together, component-wise</p>
<h2>create</h2>
<pre><code class="language-lua">function ncine.vec3.create(x: number, y: number, z: number)
  -&gt; ncine.vec3
</code></pre>
<p>Creates a vec3 table from its components</p>
<p>@<em>param</em> <code>x</code> — The X component</p>
<p>@<em>param</em> <code>y</code> — The Y component</p>
<p>@<em>param</em> <code>z</code> — The Z component</p>
<h2>div</h2>
<pre><code class="language-lua">function ncine.vec3.div(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<p>Divides the first vector by the second one, component-wise</p>
<h2>dot</h2>
<pre><code class="language-lua">function ncine.vec3.dot(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; number
</code></pre>
<p>Returns the dot product between the two vectors</p>
<h2>length</h2>
<pre><code class="language-lua">function ncine.vec3.length(vec: ncine.vec3)
  -&gt; number
</code></pre>
<p>Returns the length of the vector</p>
<h2>mul</h2>
<pre><code class="language-lua">function ncine.vec3.mul(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<p>Multiplies two vectors together, component-wise</p>
<h2>normalized</h2>
<pre><code class="language-lua">function ncine.vec3.normalized(vec: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<p>Returns a normalized version of the vector</p>
<h2>sqrlength</h2>
<pre><code class="language-lua">function ncine.vec3.sqrlength(vec: ncine.vec3)
  -&gt; number
</code></pre>
<p>Returns the squared length of the vector</p>
<h2>sub</h2>
<pre><code class="language-lua">function ncine.vec3.sub(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<p>Subtracts the second vector from the first one, component-wise</p>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The X component</p>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The Y component</p>
<h2>z</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The Z component</p>
<hr>
<h1>ncine.vec3.add</h1>
<pre><code class="language-lua">function ncine.vec3.add(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.add(vec0: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.add(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.add(vec0: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3.create</h1>
<pre><code class="language-lua">function ncine.vec3.create(x: number, y: number, z: number)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.create(x: number, y: number, z: number)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3.div</h1>
<pre><code class="language-lua">function ncine.vec3.div(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.div(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.div(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.div(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3.dot</h1>
<pre><code class="language-lua">function ncine.vec3.dot(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec3.dot(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec3.length</h1>
<pre><code class="language-lua">function ncine.vec3.length(vec: ncine.vec3)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec3.length(vec: ncine.vec3)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec3.mul</h1>
<pre><code class="language-lua">function ncine.vec3.mul(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.mul(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.mul(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.mul(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3.normalized</h1>
<pre><code class="language-lua">function ncine.vec3.normalized(vec: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.normalized(vec: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec3.sqrlength</h1>
<pre><code class="language-lua">function ncine.vec3.sqrlength(vec: ncine.vec3)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec3.sqrlength(vec: ncine.vec3)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec3.sub</h1>
<pre><code class="language-lua">function ncine.vec3.sub(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.sub(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.sub(vec0: ncine.vec3, vec1: ncine.vec3)
  -&gt; ncine.vec3
</code></pre>
<pre><code class="language-lua">function ncine.vec3.sub(vec: ncine.vec3, scalar: number)
  -&gt; ncine.vec3
</code></pre>
<hr>
<h1>ncine.vec4</h1>
<h2>add</h2>
<pre><code class="language-lua">function ncine.vec4.add(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<p>Adds two vectors together, component-wise</p>
<h2>create</h2>
<pre><code class="language-lua">function ncine.vec4.create(x: number, y: number, z: number, w: number)
  -&gt; ncine.vec4
</code></pre>
<p>Creates a vec4 table from its components</p>
<p>@<em>param</em> <code>x</code> — The X component</p>
<p>@<em>param</em> <code>y</code> — The Y component</p>
<p>@<em>param</em> <code>z</code> — The Z component</p>
<p>@<em>param</em> <code>w</code> — The W component</p>
<h2>div</h2>
<pre><code class="language-lua">function ncine.vec4.div(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<p>Divides the first vector by the second one, component-wise</p>
<h2>dot</h2>
<pre><code class="language-lua">function ncine.vec4.dot(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; number
</code></pre>
<p>Returns the dot product between the two vectors</p>
<h2>length</h2>
<pre><code class="language-lua">function ncine.vec4.length(vec: ncine.vec4)
  -&gt; number
</code></pre>
<p>Returns the length of the vector</p>
<h2>mul</h2>
<pre><code class="language-lua">function ncine.vec4.mul(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<p>Multiplies two vectors together, component-wise</p>
<h2>normalized</h2>
<pre><code class="language-lua">function ncine.vec4.normalized(vec: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<p>Returns a normalized version of the vector</p>
<h2>sqrlength</h2>
<pre><code class="language-lua">function ncine.vec4.sqrlength(vec: ncine.vec4)
  -&gt; number
</code></pre>
<p>Returns the squared length of the vector</p>
<h2>sub</h2>
<pre><code class="language-lua">function ncine.vec4.sub(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<p>Subtracts the second vector from the first one, component-wise</p>
<h2>w</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The W component</p>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The X component</p>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The Y component</p>
<h2>z</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The Z component</p>
<hr>
<h1>ncine.vec4</h1>
<pre><code class="language-lua">ncine.vec4
</code></pre>
<pre><code class="language-lua">ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.add</h1>
<pre><code class="language-lua">function ncine.vec4.add(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.add(vec0: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.add(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.add(vec0: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.create</h1>
<pre><code class="language-lua">function ncine.vec4.create(x: number, y: number, z: number, w: number)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.create(x: number, y: number, z: number, w: number)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.div</h1>
<pre><code class="language-lua">function ncine.vec4.div(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.div(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.div(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.div(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.dot</h1>
<pre><code class="language-lua">function ncine.vec4.dot(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec4.dot(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec4.length</h1>
<pre><code class="language-lua">function ncine.vec4.length(vec: ncine.vec4)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec4.length(vec: ncine.vec4)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec4.mul</h1>
<pre><code class="language-lua">function ncine.vec4.mul(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.mul(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.mul(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.mul(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.normalized</h1>
<pre><code class="language-lua">function ncine.vec4.normalized(vec: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.normalized(vec: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.vec4.sqrlength</h1>
<pre><code class="language-lua">function ncine.vec4.sqrlength(vec: ncine.vec4)
  -&gt; number
</code></pre>
<pre><code class="language-lua">function ncine.vec4.sqrlength(vec: ncine.vec4)
  -&gt; number
</code></pre>
<hr>
<h1>ncine.vec4.sub</h1>
<pre><code class="language-lua">function ncine.vec4.sub(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.sub(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.sub(vec0: ncine.vec4, vec1: ncine.vec4)
  -&gt; ncine.vec4
</code></pre>
<pre><code class="language-lua">function ncine.vec4.sub(vec: ncine.vec4, scalar: number)
  -&gt; ncine.vec4
</code></pre>
<hr>
<h1>ncine.viewport</h1>
<pre><code class="language-lua">ncine.viewport
</code></pre>
<pre><code class="language-lua">ncine.viewport
</code></pre>
<hr>
<h1>ncine.viewport</h1>
<h2>clear_chain</h2>
<pre><code class="language-lua">function ncine.viewport.clear_chain()
</code></pre>
<p>Clears the array of viewports to be drawn before the screen</p>
<h2>delete</h2>
<pre><code class="language-lua">function ncine.viewport.delete(viewport: viewportObj)
</code></pre>
<p>Destroys a viewport object and releases its memory</p>
<p>@<em>param</em> <code>viewport</code> — The viewport object to be destroyed</p>
<h2>get_camera</h2>
<pre><code class="language-lua">function ncine.viewport.get_camera(viewport: viewportObj)
  -&gt; cameraObj?
</code></pre>
<p>Returns the camera used for rendering</p>
<h2>get_clear_color</h2>
<pre><code class="language-lua">function ncine.viewport.get_clear_color(viewport: viewportObj)
  -&gt; ncine.color
</code></pre>
<p>Returns the viewport clear color as a <code>ncine.color</code> table</p>
<h2>get_clear_mode</h2>
<pre><code class="language-lua">function ncine.viewport.get_clear_mode(viewport: viewportObj)
  -&gt; ncine.clear_mode
</code></pre>
<p>Returns the viewport clear mode</p>
<h2>get_culling_rect</h2>
<pre><code class="language-lua">function ncine.viewport.get_culling_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the rectangle for screen culling</p>
<h2>get_depth_stencil_format</h2>
<pre><code class="language-lua">function ncine.viewport.get_depth_stencil_format(viewport: viewportObj)
  -&gt; ncine.depth_stencil_format
</code></pre>
<p>Returns the depth and stencil format of the viewport's FBO renderbuffer</p>
<h2>get_height</h2>
<pre><code class="language-lua">function ncine.viewport.get_height(viewport: viewportObj)
  -&gt; integer
</code></pre>
<p>Returns viewport's FBO height or zero if no texture is present</p>
<h2>get_last_frame_cleared</h2>
<pre><code class="language-lua">function ncine.viewport.get_last_frame_cleared(viewport: viewportObj)
  -&gt; integer
</code></pre>
<p>Returns the last frame this viewport was cleared</p>
<h2>get_num_color_attachments</h2>
<pre><code class="language-lua">function ncine.viewport.get_num_color_attachments(viewport: viewportObj)
  -&gt; integer
</code></pre>
<p>Returns the number of color attachments of the viewport's FBO</p>
<h2>get_rootnode</h2>
<pre><code class="language-lua">function ncine.viewport.get_rootnode(viewport: viewportObj)
  -&gt; scenenodeObj?
</code></pre>
<p>Returns the root node</p>
<h2>get_scissor_rect</h2>
<pre><code class="language-lua">function ncine.viewport.get_scissor_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the OpenGL scissor test rectangle</p>
<h2>get_texture</h2>
<pre><code class="language-lua">function ncine.viewport.get_texture(viewport: viewportObj, index: integer)
  -&gt; textureObj?
</code></pre>
<p>Returns the texture at the specified viewport's FBO color attachment index, if any</p>
<h2>get_type</h2>
<pre><code class="language-lua">function ncine.viewport.get_type(viewport: viewportObj)
  -&gt; ncine.viewport_type
</code></pre>
<p>Returns the viewport type</p>
<h2>get_viewport_rect</h2>
<pre><code class="language-lua">function ncine.viewport.get_viewport_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<p>Returns the OpenGL viewport rectangle</p>
<h2>get_width</h2>
<pre><code class="language-lua">function ncine.viewport.get_width(viewport: viewportObj)
  -&gt; integer
</code></pre>
<p>Returns viewport's FBO width or zero if no texture is present</p>
<h2>new</h2>
<pre><code class="language-lua">function ncine.viewport.new()
  -&gt; viewportObj
</code></pre>
<p>Constructs a viewport object</p>
<p>Don't forget to call <a href="file:///home/runner/work/nCine-LuaCATS/nCine-LuaCATS/library/viewport.lua#46">delete</a> when you are done with it!</p>
<p>@<em>return</em> — A new viewport object</p>
<h2>push_back_chain</h2>
<pre><code class="language-lua">function ncine.viewport.push_back_chain(viewport: viewportObj)
</code></pre>
<p>Pushes a viewport to the back of the array of viewports to be drawn before the screen</p>
<h2>push_front_chain</h2>
<pre><code class="language-lua">function ncine.viewport.push_front_chain(viewport: viewportObj)
</code></pre>
<p>Pushes a viewport to the front of the array of viewports to be drawn before the screen</p>
<h2>remove_all_textures</h2>
<pre><code class="language-lua">function ncine.viewport.remove_all_textures(viewport: viewportObj)
  -&gt; boolean
</code></pre>
<p>Removes all textures and the depth stencil renderbuffer from the viewport's FBO</p>
<p>@<em>return</em> — True if the viewport is not the screen and all textures have been removed</p>
<h2>set_camera</h2>
<pre><code class="language-lua">function ncine.viewport.set_camera(viewport: viewportObj, camera?: cameraObj)
</code></pre>
<p>Sets the camera to be used for rendering</p>
<p>@<em>param</em> <code>camera</code> — Can be <code>nil</code> to use the default one</p>
<h2>set_clear_color</h2>
<pre><code class="language-lua">function ncine.viewport.set_clear_color(viewport: viewportObj, clear_color: ncine.color)
</code></pre>
<p>Sets the viewport clear color through a <code>ncine.color</code> table</p>
<h2>set_clear_mode</h2>
<pre><code class="language-lua">function ncine.viewport.set_clear_mode(viewport: viewportObj, clear_mode: ncine.clear_mode)
</code></pre>
<p>Sets the viewport clear mode</p>
<h2>set_depth_stencil_format</h2>
<pre><code class="language-lua">function ncine.viewport.set_depth_stencil_format(viewport: viewportObj, depth_stencil_format: ncine.depth_stencil_format)
  -&gt; boolean
</code></pre>
<p>Sets the depth and stencil format of the viewport's FBO renderbuffer</p>
<p>@<em>return</em> — True if a new depth and stencil format has been successfully set</p>
<h2>set_glframebuffer_label</h2>
<pre><code class="language-lua">function ncine.viewport.set_glframebuffer_label(viewport: viewportObj, label: string)
</code></pre>
<p>Sets the OpenGL object label for the viewport framebuffer object</p>
<h2>set_rootnode</h2>
<pre><code class="language-lua">function ncine.viewport.set_rootnode(viewport: viewportObj, rootnode?: scenenodeObj)
</code></pre>
<p>Sets or removes the root node</p>
<h2>set_scissor_rect</h2>
<pre><code class="language-lua">function ncine.viewport.set_scissor_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<p>Sets the OpenGL scissor test rectangle through a <code>ncine.rect</code> table</p>
<h2>set_texture</h2>
<pre><code class="language-lua">function ncine.viewport.set_texture(viewport: viewportObj, index: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<p>Adds or removes a texture at the specified viewport's FBO color attachment index</p>
<p>@<em>return</em> — True if a texture has been added or removed successfully</p>
<h2>set_viewport_rect</h2>
<pre><code class="language-lua">function ncine.viewport.set_viewport_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<p>Sets the OpenGL viewport rectangle through a <code>ncine.rect</code> table</p>
<hr>
<h1>ncine.viewport.clear_chain</h1>
<pre><code class="language-lua">function ncine.viewport.clear_chain()
</code></pre>
<pre><code class="language-lua">function ncine.viewport.clear_chain()
</code></pre>
<hr>
<h1>ncine.viewport.delete</h1>
<pre><code class="language-lua">function ncine.viewport.delete(viewport: viewportObj)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.delete(viewport: viewportObj)
</code></pre>
<hr>
<h1>ncine.viewport.get_camera</h1>
<pre><code class="language-lua">function ncine.viewport.get_camera(viewport: viewportObj)
  -&gt; cameraObj?
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_camera(viewport: viewportObj)
  -&gt; cameraObj?
</code></pre>
<hr>
<h1>ncine.viewport.get_clear_color</h1>
<pre><code class="language-lua">function ncine.viewport.get_clear_color(viewport: viewportObj)
  -&gt; ncine.color
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_clear_color(viewport: viewportObj)
  -&gt; ncine.color
</code></pre>
<hr>
<h1>ncine.viewport.get_clear_mode</h1>
<pre><code class="language-lua">function ncine.viewport.get_clear_mode(viewport: viewportObj)
  -&gt; ncine.clear_mode
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_clear_mode(viewport: viewportObj)
  -&gt; ncine.clear_mode
</code></pre>
<hr>
<h1>ncine.viewport.get_culling_rect</h1>
<pre><code class="language-lua">function ncine.viewport.get_culling_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_culling_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.viewport.get_depth_stencil_format</h1>
<pre><code class="language-lua">function ncine.viewport.get_depth_stencil_format(viewport: viewportObj)
  -&gt; ncine.depth_stencil_format
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_depth_stencil_format(viewport: viewportObj)
  -&gt; ncine.depth_stencil_format
</code></pre>
<hr>
<h1>ncine.viewport.get_height</h1>
<pre><code class="language-lua">function ncine.viewport.get_height(viewport: viewportObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_height(viewport: viewportObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.viewport.get_last_frame_cleared</h1>
<pre><code class="language-lua">function ncine.viewport.get_last_frame_cleared(viewport: viewportObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_last_frame_cleared(viewport: viewportObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.viewport.get_num_color_attachments</h1>
<pre><code class="language-lua">function ncine.viewport.get_num_color_attachments(viewport: viewportObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_num_color_attachments(viewport: viewportObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.viewport.get_rootnode</h1>
<pre><code class="language-lua">function ncine.viewport.get_rootnode(viewport: viewportObj)
  -&gt; scenenodeObj?
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_rootnode(viewport: viewportObj)
  -&gt; scenenodeObj?
</code></pre>
<hr>
<h1>ncine.viewport.get_scissor_rect</h1>
<pre><code class="language-lua">function ncine.viewport.get_scissor_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_scissor_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.viewport.get_texture</h1>
<pre><code class="language-lua">function ncine.viewport.get_texture(viewport: viewportObj, index: integer)
  -&gt; textureObj?
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_texture(viewport: viewportObj, index: integer)
  -&gt; textureObj?
</code></pre>
<hr>
<h1>ncine.viewport.get_type</h1>
<pre><code class="language-lua">function ncine.viewport.get_type(viewport: viewportObj)
  -&gt; ncine.viewport_type
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_type(viewport: viewportObj)
  -&gt; ncine.viewport_type
</code></pre>
<hr>
<h1>ncine.viewport.get_viewport_rect</h1>
<pre><code class="language-lua">function ncine.viewport.get_viewport_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_viewport_rect(viewport: viewportObj)
  -&gt; ncine.rect
</code></pre>
<hr>
<h1>ncine.viewport.get_width</h1>
<pre><code class="language-lua">function ncine.viewport.get_width(viewport: viewportObj)
  -&gt; integer
</code></pre>
<pre><code class="language-lua">function ncine.viewport.get_width(viewport: viewportObj)
  -&gt; integer
</code></pre>
<hr>
<h1>ncine.viewport.new</h1>
<pre><code class="language-lua">function ncine.viewport.new()
  -&gt; viewportObj
</code></pre>
<pre><code class="language-lua">function ncine.viewport.new()
  -&gt; viewportObj
</code></pre>
<hr>
<h1>ncine.viewport.push_back_chain</h1>
<pre><code class="language-lua">function ncine.viewport.push_back_chain(viewport: viewportObj)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.push_back_chain(viewport: viewportObj)
</code></pre>
<hr>
<h1>ncine.viewport.push_front_chain</h1>
<pre><code class="language-lua">function ncine.viewport.push_front_chain(viewport: viewportObj)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.push_front_chain(viewport: viewportObj)
</code></pre>
<hr>
<h1>ncine.viewport.remove_all_textures</h1>
<pre><code class="language-lua">function ncine.viewport.remove_all_textures(viewport: viewportObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.viewport.remove_all_textures(viewport: viewportObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.viewport.set_camera</h1>
<pre><code class="language-lua">function ncine.viewport.set_camera(viewport: viewportObj, camera?: cameraObj)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_camera(viewport: viewportObj, camera?: cameraObj)
</code></pre>
<hr>
<h1>ncine.viewport.set_clear_color</h1>
<pre><code class="language-lua">function ncine.viewport.set_clear_color(viewport: viewportObj, clear_color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_clear_color(viewport: viewportObj, r: number, g: number, b: number, a: number)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_clear_color(viewport: viewportObj, clear_color: ncine.color)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_clear_color(viewport: viewportObj, r: number, g: number, b: number, a: number)
</code></pre>
<hr>
<h1>ncine.viewport.set_clear_mode</h1>
<pre><code class="language-lua">function ncine.viewport.set_clear_mode(viewport: viewportObj, clear_mode: ncine.clear_mode)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_clear_mode(viewport: viewportObj, clear_mode: ncine.clear_mode)
</code></pre>
<hr>
<h1>ncine.viewport.set_depth_stencil_format</h1>
<pre><code class="language-lua">function ncine.viewport.set_depth_stencil_format(viewport: viewportObj, depth_stencil_format: ncine.depth_stencil_format)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_depth_stencil_format(viewport: viewportObj, depth_stencil_format: ncine.depth_stencil_format)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.viewport.set_glframebuffer_label</h1>
<pre><code class="language-lua">function ncine.viewport.set_glframebuffer_label(viewport: viewportObj, label: string)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_glframebuffer_label(viewport: viewportObj, label: string)
</code></pre>
<hr>
<h1>ncine.viewport.set_rootnode</h1>
<pre><code class="language-lua">function ncine.viewport.set_rootnode(viewport: viewportObj, rootnode?: scenenodeObj)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_rootnode(viewport: viewportObj, rootnode?: scenenodeObj)
</code></pre>
<hr>
<h1>ncine.viewport.set_scissor_rect</h1>
<pre><code class="language-lua">function ncine.viewport.set_scissor_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_scissor_rect(viewport: viewportObj, x: integer, y: integer, w: integer, h: integer)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_scissor_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_scissor_rect(viewport: viewportObj, x: integer, y: integer, w: integer, h: integer)
</code></pre>
<hr>
<h1>ncine.viewport.set_texture</h1>
<pre><code class="language-lua">function ncine.viewport.set_texture(viewport: viewportObj, index: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_texture(viewport: viewportObj, index: integer, texture?: textureObj)
  -&gt; boolean
</code></pre>
<hr>
<h1>ncine.viewport.set_viewport_rect</h1>
<pre><code class="language-lua">function ncine.viewport.set_viewport_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_viewport_rect(viewport: viewportObj, x: integer, y: integer, w: integer, h: integer)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_viewport_rect(viewport: viewportObj, rect: ncine.rect)
</code></pre>
<pre><code class="language-lua">function ncine.viewport.set_viewport_rect(viewport: viewportObj, x: integer, y: integer, w: integer, h: integer)
</code></pre>
<hr>
<h1>ncine.viewport_type</h1>
<pre><code class="language-lua">enum ncine.viewport_type
</code></pre>
<pre><code class="language-lua">enum ncine.viewport_type
</code></pre>
<hr>
<h1>ncine.visit_order_state</h1>
<pre><code class="language-lua">enum ncine.visit_order_state
</code></pre>
<pre><code class="language-lua">enum ncine.visit_order_state
</code></pre>
<hr>
<h1>newproxy</h1>
<pre><code class="language-lua">function newproxy(proxy: boolean|table|userdata)
  -&gt; userdata
</code></pre>
<hr>
<h1>next</h1>
<pre><code class="language-lua">function next(table: table&lt;&lt;K&gt;, &lt;V&gt;&gt;, index?: &lt;K&gt;)
  -&gt; &lt;K&gt;?
  2. &lt;V&gt;?
</code></pre>
<hr>
<h1>nil</h1>
<hr>
<h1>number</h1>
<hr>
<h1>openmode</h1>
<hr>
<h1>os</h1>
<pre><code class="language-lua">oslib
</code></pre>
<hr>
<h1>os.clock</h1>
<pre><code class="language-lua">function os.clock()
  -&gt; number
</code></pre>
<hr>
<h1>os.date</h1>
<pre><code class="language-lua">function os.date(format?: string, time?: integer)
  -&gt; string|osdate
</code></pre>
<hr>
<h1>os.difftime</h1>
<pre><code class="language-lua">function os.difftime(t2: integer, t1: integer)
  -&gt; integer
</code></pre>
<hr>
<h1>os.execute</h1>
<pre><code class="language-lua">function os.execute(command?: string)
  -&gt; suc: boolean?
  2. exitcode: (&quot;exit&quot;|&quot;signal&quot;)?
  3. code: integer?
</code></pre>
<hr>
<h1>os.exit</h1>
<pre><code class="language-lua">function os.exit(code?: boolean|integer, close?: boolean)
</code></pre>
<hr>
<h1>os.getenv</h1>
<pre><code class="language-lua">function os.getenv(varname: string)
  -&gt; string?
</code></pre>
<hr>
<h1>os.remove</h1>
<pre><code class="language-lua">function os.remove(filename: string)
  -&gt; suc: boolean
  2. errmsg: string?
</code></pre>
<hr>
<h1>os.rename</h1>
<pre><code class="language-lua">function os.rename(oldname: string, newname: string)
  -&gt; suc: boolean
  2. errmsg: string?
</code></pre>
<hr>
<h1>os.setlocale</h1>
<pre><code class="language-lua">function os.setlocale(locale: string|nil, category?: &quot;all&quot;|&quot;collate&quot;|&quot;ctype&quot;|&quot;monetary&quot;|&quot;numeric&quot;...(+1))
  -&gt; localecategory: string
</code></pre>
<hr>
<h1>os.time</h1>
<pre><code class="language-lua">function os.time(date?: osdateparam)
  -&gt; integer
</code></pre>
<hr>
<h1>os.tmpname</h1>
<pre><code class="language-lua">function os.tmpname()
  -&gt; string
</code></pre>
<hr>
<h1>osdate</h1>
<h2>day</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>1-31</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.day&quot;]">View documents</a></p>
<h2>hour</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>0-23</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.hour&quot;]">View documents</a></p>
<h2>isdst</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>daylight saving flag, a boolean</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.isdst&quot;]">View documents</a></p>
<h2>min</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>0-59</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.min&quot;]">View documents</a></p>
<h2>month</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>1-12</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.month&quot;]">View documents</a></p>
<h2>sec</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>0-61</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.sec&quot;]">View documents</a></p>
<h2>wday</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>weekday, 1–7, Sunday is 1</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.wday&quot;]">View documents</a></p>
<h2>yday</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>day of the year, 1–366</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.yday&quot;]">View documents</a></p>
<h2>year</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>four digits</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.year&quot;]">View documents</a></p>
<hr>
<h1>osdateparam</h1>
<h2>day</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>1-31</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.day&quot;]">View documents</a></p>
<h2>hour</h2>
<pre><code class="language-lua">(string|integer)?
</code></pre>
<p>0-23</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.hour&quot;]">View documents</a></p>
<h2>isdst</h2>
<pre><code class="language-lua">boolean?
</code></pre>
<p>daylight saving flag, a boolean</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.isdst&quot;]">View documents</a></p>
<h2>min</h2>
<pre><code class="language-lua">(string|integer)?
</code></pre>
<p>0-59</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.min&quot;]">View documents</a></p>
<h2>month</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>1-12</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.month&quot;]">View documents</a></p>
<h2>sec</h2>
<pre><code class="language-lua">(string|integer)?
</code></pre>
<p>0-61</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.sec&quot;]">View documents</a></p>
<h2>wday</h2>
<pre><code class="language-lua">(string|integer)?
</code></pre>
<p>weekday, 1–7, Sunday is 1</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.wday&quot;]">View documents</a></p>
<h2>yday</h2>
<pre><code class="language-lua">(string|integer)?
</code></pre>
<p>day of the year, 1–366</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.yday&quot;]">View documents</a></p>
<h2>year</h2>
<pre><code class="language-lua">string|integer
</code></pre>
<p>four digits</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-osdate.year&quot;]">View documents</a></p>
<hr>
<h1>oslib</h1>
<h2>clock</h2>
<pre><code class="language-lua">function os.clock()
  -&gt; number
</code></pre>
<p>Returns an approximation of the amount in seconds of CPU time used by the program.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.clock&quot;]">View documents</a></p>
<h2>date</h2>
<pre><code class="language-lua">function os.date(format?: string, time?: integer)
  -&gt; string|osdate
</code></pre>
<p>Returns a string or a table containing date and time, formatted according to the given string <code>format</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.date&quot;]">View documents</a></p>
<h2>difftime</h2>
<pre><code class="language-lua">function os.difftime(t2: integer, t1: integer)
  -&gt; integer
</code></pre>
<p>Returns the difference, in seconds, from time <code>t1</code> to time <code>t2</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.difftime&quot;]">View documents</a></p>
<h2>execute</h2>
<pre><code class="language-lua">function os.execute(command?: string)
  -&gt; suc: boolean?
  2. exitcode: (&quot;exit&quot;|&quot;signal&quot;)?
  3. code: integer?
</code></pre>
<p>Passes <code>command</code> to be executed by an operating system shell.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.execute&quot;]">View documents</a></p>
<pre><code class="language-lua">exitcode:
    | &quot;exit&quot;
    | &quot;signal&quot;
</code></pre>
<h2>exit</h2>
<pre><code class="language-lua">function os.exit(code?: boolean|integer, close?: boolean)
</code></pre>
<p>Calls the ISO C function <code>exit</code> to terminate the host program.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.exit&quot;]">View documents</a></p>
<h2>getenv</h2>
<pre><code class="language-lua">function os.getenv(varname: string)
  -&gt; string?
</code></pre>
<p>Returns the value of the process environment variable <code>varname</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.getenv&quot;]">View documents</a></p>
<h2>remove</h2>
<pre><code class="language-lua">function os.remove(filename: string)
  -&gt; suc: boolean
  2. errmsg: string?
</code></pre>
<p>Deletes the file with the given name.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.remove&quot;]">View documents</a></p>
<h2>rename</h2>
<pre><code class="language-lua">function os.rename(oldname: string, newname: string)
  -&gt; suc: boolean
  2. errmsg: string?
</code></pre>
<p>Renames the file or directory named <code>oldname</code> to <code>newname</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.rename&quot;]">View documents</a></p>
<h2>setlocale</h2>
<pre><code class="language-lua">function os.setlocale(locale: string|nil, category?: &quot;all&quot;|&quot;collate&quot;|&quot;ctype&quot;|&quot;monetary&quot;|&quot;numeric&quot;...(+1))
  -&gt; localecategory: string
</code></pre>
<p>Sets the current locale of the program.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.setlocale&quot;]">View documents</a></p>
<pre><code class="language-lua">category:
   -&gt; &quot;all&quot;
    | &quot;collate&quot;
    | &quot;ctype&quot;
    | &quot;monetary&quot;
    | &quot;numeric&quot;
    | &quot;time&quot;
</code></pre>
<h2>time</h2>
<pre><code class="language-lua">function os.time(date?: osdateparam)
  -&gt; integer
</code></pre>
<p>Returns the current time when called without arguments, or a time representing the local date and time specified by the given table.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.time&quot;]">View documents</a></p>
<h2>tmpname</h2>
<pre><code class="language-lua">function os.tmpname()
  -&gt; string
</code></pre>
<p>Returns a string with a file name that can be used for a temporary file.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-os.tmpname&quot;]">View documents</a></p>
<hr>
<h1>package</h1>
<pre><code class="language-lua">packagelib
</code></pre>
<hr>
<h1>package.config</h1>
<pre><code class="language-lua">string
</code></pre>
<hr>
<h1>package.loaders</h1>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>package.loadlib</h1>
<pre><code class="language-lua">function package.loadlib(libname: string, funcname: string)
  -&gt; any
</code></pre>
<hr>
<h1>package.searchers</h1>
<pre><code class="language-lua">table
</code></pre>
<hr>
<h1>package.searchpath</h1>
<pre><code class="language-lua">function package.searchpath(name: string, path: string, sep?: string, rep?: string)
  -&gt; filename: string?
  2. errmsg: string?
</code></pre>
<hr>
<h1>package.seeall</h1>
<pre><code class="language-lua">function package.seeall(module: table)
</code></pre>
<hr>
<h1>packagelib</h1>
<h2>config</h2>
<pre><code class="language-lua">string
</code></pre>
<p>A string describing some compile-time configurations for packages.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.config&quot;]">View documents</a></p>
<h2>cpath</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The path used by <code>require</code> to search for a C loader.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.cpath&quot;]">View documents</a></p>
<h2>loaded</h2>
<pre><code class="language-lua">table
</code></pre>
<p>A table used by <code>require</code> to control which modules are already loaded.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.loaded&quot;]">View documents</a></p>
<h2>loaders</h2>
<pre><code class="language-lua">table
</code></pre>
<p>A table used by <code>require</code> to control how to load modules.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.loaders&quot;]">View documents</a></p>
<h2>loadlib</h2>
<pre><code class="language-lua">function package.loadlib(libname: string, funcname: string)
  -&gt; any
</code></pre>
<p>Dynamically links the host program with the C library <code>libname</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.loadlib&quot;]">View documents</a></p>
<h2>path</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The path used by <code>require</code> to search for a Lua loader.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.path&quot;]">View documents</a></p>
<h2>preload</h2>
<pre><code class="language-lua">table
</code></pre>
<p>A table to store loaders for specific modules.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.preload&quot;]">View documents</a></p>
<h2>searchers</h2>
<pre><code class="language-lua">table
</code></pre>
<p>A table used by <code>require</code> to control how to load modules.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.searchers&quot;]">View documents</a></p>
<h2>searchpath</h2>
<pre><code class="language-lua">function package.searchpath(name: string, path: string, sep?: string, rep?: string)
  -&gt; filename: string?
  2. errmsg: string?
</code></pre>
<p>Searches for the given <code>name</code> in the given <code>path</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.searchpath&quot;]">View documents</a></p>
<h2>seeall</h2>
<pre><code class="language-lua">function package.seeall(module: table)
</code></pre>
<p>Sets a metatable for <code>module</code> with its <code>__index</code> field referring to the global environment, so that this module inherits values from the global environment. To be used as an option to function <code>module</code> .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-package.seeall&quot;]">View documents</a></p>
<hr>
<h1>pairs</h1>
<pre><code class="language-lua">function pairs(t: &lt;T:table&gt;)
  -&gt; fun(table: table&lt;&lt;K&gt;, &lt;V&gt;&gt;, index?: &lt;K&gt;):&lt;K&gt;, &lt;V&gt;
  2. &lt;T:table&gt;
</code></pre>
<hr>
<h1>particle_initializer</h1>
<h2>amount</h2>
<pre><code class="language-lua">number|number[]
</code></pre>
<h2>life</h2>
<pre><code class="language-lua">number|number[]
</code></pre>
<h2>position</h2>
<pre><code class="language-lua">ncine.vec2|ncine.vec2[]
</code></pre>
<p>A two component vector</p>
<h2>rotation</h2>
<pre><code class="language-lua">number|number[]
</code></pre>
<h2>velocity</h2>
<pre><code class="language-lua">ncine.vec2|ncine.vec2[]
</code></pre>
<p>A two component vector</p>
<hr>
<h1>particle_initializer</h1>
<pre><code class="language-lua">particle_initializer
</code></pre>
<pre><code class="language-lua">particle_initializer
</code></pre>
<hr>
<h1>particlesystemObj</h1>
<hr>
<h1>pcall</h1>
<pre><code class="language-lua">function pcall(f: fun(...any):...unknown, arg1?: any, ...any)
  -&gt; success: boolean
  2. result: any
  3. ...any
</code></pre>
<hr>
<h1>pointer</h1>
<h2>id</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>pointer</h1>
<pre><code class="language-lua">pointer
</code></pre>
<pre><code class="language-lua">pointer
</code></pre>
<hr>
<h1>popenmode</h1>
<hr>
<h1>print</h1>
<pre><code class="language-lua">function print(...any)
</code></pre>
<hr>
<h1>rawequal</h1>
<pre><code class="language-lua">function rawequal(v1: any, v2: any)
  -&gt; boolean
</code></pre>
<hr>
<h1>rawget</h1>
<pre><code class="language-lua">function rawget(table: table, index: any)
  -&gt; any
</code></pre>
<hr>
<h1>rawlen</h1>
<pre><code class="language-lua">function rawlen(v: string|table)
  -&gt; len: integer
</code></pre>
<hr>
<h1>rawset</h1>
<pre><code class="language-lua">function rawset(table: table, index: any, value: any)
  -&gt; table
</code></pre>
<hr>
<h1>readmode</h1>
<hr>
<h1>reload_script</h1>
<pre><code class="language-lua">function reload_script()
</code></pre>
<pre><code class="language-lua">function reload_script()
</code></pre>
<hr>
<h1>rendering_settings</h1>
<pre><code class="language-lua">rendering_settings
</code></pre>
<pre><code class="language-lua">rendering_settings
</code></pre>
<hr>
<h1>rendering_settings</h1>
<h2>batching</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if sprite batching is enabled</p>
<h2>batching_with_indices</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if using indices for vertex batching</p>
<h2>culling</h2>
<pre><code class="language-lua">boolean
</code></pre>
<p>True if node culling is enabled</p>
<h2>max_batch_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Maximum size for a batch before a forced split</p>
<h2>min_batch_size</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>Minimum size for a batch to be collected</p>
<hr>
<h1>require</h1>
<pre><code class="language-lua">function require(modname: string)
  -&gt; unknown
  2. loaderdata: unknown
</code></pre>
<hr>
<h1>scenenodeObj</h1>
<hr>
<h1>scroll_event</h1>
<pre><code class="language-lua">scroll_event
</code></pre>
<pre><code class="language-lua">scroll_event
</code></pre>
<hr>
<h1>scroll_event</h1>
<h2>x</h2>
<pre><code class="language-lua">number
</code></pre>
<h2>y</h2>
<pre><code class="language-lua">number
</code></pre>
<hr>
<h1>seekwhence</h1>
<hr>
<h1>select</h1>
<pre><code class="language-lua">function select(index: integer|&quot;#&quot;, ...any)
  -&gt; any
</code></pre>
<hr>
<h1>setfenv</h1>
<pre><code class="language-lua">function setfenv(f: integer|fun(...any):...unknown, table: table)
  -&gt; function
</code></pre>
<hr>
<h1>setmetatable</h1>
<pre><code class="language-lua">function setmetatable(table: table, metatable?: table|metatable)
  -&gt; table
</code></pre>
<hr>
<h1>shaderObj</h1>
<hr>
<h1>shaderstateObj</h1>
<hr>
<h1>show_gui</h1>
<pre><code class="language-lua">function show_gui(show: boolean)
</code></pre>
<pre><code class="language-lua">function show_gui(show: boolean)
</code></pre>
<hr>
<h1>spriteObj</h1>
<hr>
<h1>string</h1>
<h2>byte</h2>
<pre><code class="language-lua">function string.byte(s: string|number, i?: integer, j?: integer)
  -&gt; ...integer
</code></pre>
<p>Returns the internal numeric codes of the characters <code>s[i], s[i+1], ..., s[j]</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.byte&quot;]">View documents</a></p>
<h2>char</h2>
<pre><code class="language-lua">function string.char(byte: integer, ...integer)
  -&gt; string
</code></pre>
<p>Returns a string with length equal to the number of arguments, in which each character has the internal numeric code equal to its corresponding argument.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.char&quot;]">View documents</a></p>
<h2>dump</h2>
<pre><code class="language-lua">function string.dump(f: fun(...any):...unknown, strip?: boolean)
  -&gt; string
</code></pre>
<p>Returns a string containing a binary representation (a <em>binary chunk</em>) of the given function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.dump&quot;]">View documents</a></p>
<h2>find</h2>
<pre><code class="language-lua">function string.find(s: string|number, pattern: string|number, init?: integer, plain?: boolean)
  -&gt; start: integer|nil
  2. end: integer|nil
  3. ...any
</code></pre>
<p>Looks for the first match of <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) in the string.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.find&quot;]">View documents</a></p>
<p>@<em>return</em> <code>start</code></p>
<p>@<em>return</em> <code>end</code></p>
<p>@<em>return</em> <code>...</code> — captured</p>
<h2>format</h2>
<pre><code class="language-lua">function string.format(s: string|number, ...any)
  -&gt; string
</code></pre>
<p>Returns a formatted version of its variable number of arguments following the description given in its first argument.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.format&quot;]">View documents</a></p>
<h2>gmatch</h2>
<pre><code class="language-lua">function string.gmatch(s: string|number, pattern: string|number, init?: integer)
  -&gt; fun():string, ...unknown
</code></pre>
<p>Returns an iterator function that, each time it is called, returns the next captures from <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) over the string s.</p>
<p>As an example, the following loop will iterate over all the words from string s, printing one per line:</p>
<pre><code class="language-lua">    s =
&quot;hello world from Lua&quot;
    for w in string.gmatch(s, &quot;%a+&quot;) do
        print(w)
    end
</code></pre>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.gmatch&quot;]">View documents</a></p>
<h2>gsub</h2>
<pre><code class="language-lua">function string.gsub(s: string|number, pattern: string|number, repl: string|number|function|table, n?: integer)
  -&gt; string
  2. count: integer
</code></pre>
<p>Returns a copy of s in which all (or the first <code>n</code>, if given) occurrences of the <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) have been replaced by a replacement string specified by <code>repl</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.gsub&quot;]">View documents</a></p>
<h2>len</h2>
<pre><code class="language-lua">function string.len(s: string|number)
  -&gt; integer
</code></pre>
<p>Returns its length.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.len&quot;]">View documents</a></p>
<h2>lower</h2>
<pre><code class="language-lua">function string.lower(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a copy of this string with all uppercase letters changed to lowercase.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.lower&quot;]">View documents</a></p>
<h2>match</h2>
<pre><code class="language-lua">function string.match(s: string|number, pattern: string|number, init?: integer)
  -&gt; ...any
</code></pre>
<p>Looks for the first match of <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) in the string.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.match&quot;]">View documents</a></p>
<h2>pack</h2>
<pre><code class="language-lua">function string.pack(fmt: string, v1: string|number, v2?: string|number, ...string|number)
  -&gt; binary: string
</code></pre>
<p>Returns a binary string containing the values <code>v1</code>, <code>v2</code>, etc. packed (that is, serialized in binary form) according to the format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.pack&quot;]">View documents</a></p>
<h2>packsize</h2>
<pre><code class="language-lua">function string.packsize(fmt: string)
  -&gt; integer
</code></pre>
<p>Returns the size of a string resulting from <code>string.pack</code> with the given format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.packsize&quot;]">View documents</a></p>
<h2>rep</h2>
<pre><code class="language-lua">function string.rep(s: string|number, n: integer, sep?: string|number)
  -&gt; string
</code></pre>
<p>Returns a string that is the concatenation of <code>n</code> copies of the string <code>s</code> separated by the string <code>sep</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.rep&quot;]">View documents</a></p>
<h2>reverse</h2>
<pre><code class="language-lua">function string.reverse(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a string that is the string <code>s</code> reversed.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.reverse&quot;]">View documents</a></p>
<h2>sub</h2>
<pre><code class="language-lua">function string.sub(s: string|number, i: integer, j?: integer)
  -&gt; string
</code></pre>
<p>Returns the substring of the string that starts at <code>i</code> and continues until <code>j</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.sub&quot;]">View documents</a></p>
<h2>unpack</h2>
<pre><code class="language-lua">function string.unpack(fmt: string, s: string, pos?: integer)
  -&gt; ...any
  2. offset: integer
</code></pre>
<p>Returns the values packed in string according to the format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.unpack&quot;]">View documents</a></p>
<h2>upper</h2>
<pre><code class="language-lua">function string.upper(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a copy of this string with all lowercase letters changed to uppercase.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.upper&quot;]">View documents</a></p>
<hr>
<h1>string</h1>
<pre><code class="language-lua">stringlib
</code></pre>
<hr>
<h1>string.byte</h1>
<pre><code class="language-lua">function string.byte(s: string|number, i?: integer, j?: integer)
  -&gt; ...integer
</code></pre>
<hr>
<h1>string.char</h1>
<pre><code class="language-lua">function string.char(byte: integer, ...integer)
  -&gt; string
</code></pre>
<hr>
<h1>string.dump</h1>
<pre><code class="language-lua">function string.dump(f: fun(...any):...unknown, strip?: boolean)
  -&gt; string
</code></pre>
<hr>
<h1>string.find</h1>
<pre><code class="language-lua">function string.find(s: string|number, pattern: string|number, init?: integer, plain?: boolean)
  -&gt; start: integer|nil
  2. end: integer|nil
  3. ...any
</code></pre>
<hr>
<h1>string.format</h1>
<pre><code class="language-lua">function string.format(s: string|number, ...any)
  -&gt; string
</code></pre>
<hr>
<h1>string.gmatch</h1>
<pre><code class="language-lua">function string.gmatch(s: string|number, pattern: string|number, init?: integer)
  -&gt; fun():string, ...unknown
</code></pre>
<hr>
<h1>string.gsub</h1>
<pre><code class="language-lua">function string.gsub(s: string|number, pattern: string|number, repl: string|number|function|table, n?: integer)
  -&gt; string
  2. count: integer
</code></pre>
<hr>
<h1>string.len</h1>
<pre><code class="language-lua">function string.len(s: string|number)
  -&gt; integer
</code></pre>
<hr>
<h1>string.lower</h1>
<pre><code class="language-lua">function string.lower(s: string|number)
  -&gt; string
</code></pre>
<hr>
<h1>string.match</h1>
<pre><code class="language-lua">function string.match(s: string|number, pattern: string|number, init?: integer)
  -&gt; ...any
</code></pre>
<hr>
<h1>string.pack</h1>
<pre><code class="language-lua">function string.pack(fmt: string, v1: string|number, v2?: string|number, ...string|number)
  -&gt; binary: string
</code></pre>
<hr>
<h1>string.packsize</h1>
<pre><code class="language-lua">function string.packsize(fmt: string)
  -&gt; integer
</code></pre>
<hr>
<h1>string.rep</h1>
<pre><code class="language-lua">function string.rep(s: string|number, n: integer, sep?: string|number)
  -&gt; string
</code></pre>
<hr>
<h1>string.reverse</h1>
<pre><code class="language-lua">function string.reverse(s: string|number)
  -&gt; string
</code></pre>
<hr>
<h1>string.sub</h1>
<pre><code class="language-lua">function string.sub(s: string|number, i: integer, j?: integer)
  -&gt; string
</code></pre>
<hr>
<h1>string.unpack</h1>
<pre><code class="language-lua">function string.unpack(fmt: string, s: string, pos?: integer)
  -&gt; ...any
  2. offset: integer
</code></pre>
<hr>
<h1>string.upper</h1>
<pre><code class="language-lua">function string.upper(s: string|number)
  -&gt; string
</code></pre>
<hr>
<h1>stringlib</h1>
<h2>byte</h2>
<pre><code class="language-lua">function string.byte(s: string|number, i?: integer, j?: integer)
  -&gt; ...integer
</code></pre>
<p>Returns the internal numeric codes of the characters <code>s[i], s[i+1], ..., s[j]</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.byte&quot;]">View documents</a></p>
<h2>char</h2>
<pre><code class="language-lua">function string.char(byte: integer, ...integer)
  -&gt; string
</code></pre>
<p>Returns a string with length equal to the number of arguments, in which each character has the internal numeric code equal to its corresponding argument.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.char&quot;]">View documents</a></p>
<h2>dump</h2>
<pre><code class="language-lua">function string.dump(f: fun(...any):...unknown, strip?: boolean)
  -&gt; string
</code></pre>
<p>Returns a string containing a binary representation (a <em>binary chunk</em>) of the given function.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.dump&quot;]">View documents</a></p>
<h2>find</h2>
<pre><code class="language-lua">function string.find(s: string|number, pattern: string|number, init?: integer, plain?: boolean)
  -&gt; start: integer|nil
  2. end: integer|nil
  3. ...any
</code></pre>
<p>Looks for the first match of <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) in the string.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.find&quot;]">View documents</a></p>
<p>@<em>return</em> <code>start</code></p>
<p>@<em>return</em> <code>end</code></p>
<p>@<em>return</em> <code>...</code> — captured</p>
<h2>format</h2>
<pre><code class="language-lua">function string.format(s: string|number, ...any)
  -&gt; string
</code></pre>
<p>Returns a formatted version of its variable number of arguments following the description given in its first argument.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.format&quot;]">View documents</a></p>
<h2>gmatch</h2>
<pre><code class="language-lua">function string.gmatch(s: string|number, pattern: string|number, init?: integer)
  -&gt; fun():string, ...unknown
</code></pre>
<p>Returns an iterator function that, each time it is called, returns the next captures from <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) over the string s.</p>
<p>As an example, the following loop will iterate over all the words from string s, printing one per line:</p>
<pre><code class="language-lua">    s =
&quot;hello world from Lua&quot;
    for w in string.gmatch(s, &quot;%a+&quot;) do
        print(w)
    end
</code></pre>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.gmatch&quot;]">View documents</a></p>
<h2>gsub</h2>
<pre><code class="language-lua">function string.gsub(s: string|number, pattern: string|number, repl: string|number|function|table, n?: integer)
  -&gt; string
  2. count: integer
</code></pre>
<p>Returns a copy of s in which all (or the first <code>n</code>, if given) occurrences of the <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) have been replaced by a replacement string specified by <code>repl</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.gsub&quot;]">View documents</a></p>
<h2>len</h2>
<pre><code class="language-lua">function string.len(s: string|number)
  -&gt; integer
</code></pre>
<p>Returns its length.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.len&quot;]">View documents</a></p>
<h2>lower</h2>
<pre><code class="language-lua">function string.lower(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a copy of this string with all uppercase letters changed to lowercase.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.lower&quot;]">View documents</a></p>
<h2>match</h2>
<pre><code class="language-lua">function string.match(s: string|number, pattern: string|number, init?: integer)
  -&gt; ...any
</code></pre>
<p>Looks for the first match of <code>pattern</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.1&quot;]">§6.4.1</a>) in the string.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.match&quot;]">View documents</a></p>
<h2>pack</h2>
<pre><code class="language-lua">function string.pack(fmt: string, v1: string|number, v2?: string|number, ...string|number)
  -&gt; binary: string
</code></pre>
<p>Returns a binary string containing the values <code>v1</code>, <code>v2</code>, etc. packed (that is, serialized in binary form) according to the format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.pack&quot;]">View documents</a></p>
<h2>packsize</h2>
<pre><code class="language-lua">function string.packsize(fmt: string)
  -&gt; integer
</code></pre>
<p>Returns the size of a string resulting from <code>string.pack</code> with the given format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.packsize&quot;]">View documents</a></p>
<h2>rep</h2>
<pre><code class="language-lua">function string.rep(s: string|number, n: integer, sep?: string|number)
  -&gt; string
</code></pre>
<p>Returns a string that is the concatenation of <code>n</code> copies of the string <code>s</code> separated by the string <code>sep</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.rep&quot;]">View documents</a></p>
<h2>reverse</h2>
<pre><code class="language-lua">function string.reverse(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a string that is the string <code>s</code> reversed.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.reverse&quot;]">View documents</a></p>
<h2>sub</h2>
<pre><code class="language-lua">function string.sub(s: string|number, i: integer, j?: integer)
  -&gt; string
</code></pre>
<p>Returns the substring of the string that starts at <code>i</code> and continues until <code>j</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.sub&quot;]">View documents</a></p>
<h2>unpack</h2>
<pre><code class="language-lua">function string.unpack(fmt: string, s: string, pos?: integer)
  -&gt; ...any
  2. offset: integer
</code></pre>
<p>Returns the values packed in string according to the format string <code>fmt</code> (see <a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/6.4.2&quot;]">§6.4.2</a>) .</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.unpack&quot;]">View documents</a></p>
<h2>upper</h2>
<pre><code class="language-lua">function string.upper(s: string|number)
  -&gt; string
</code></pre>
<p>Returns a copy of this string with all lowercase letters changed to uppercase.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-string.upper&quot;]">View documents</a></p>
<hr>
<h1>table</h1>
<hr>
<h1>table</h1>
<pre><code class="language-lua">tablelib
</code></pre>
<hr>
<h1>table.concat</h1>
<pre><code class="language-lua">function table.concat(list: table, sep?: string, i?: integer, j?: integer)
  -&gt; string
</code></pre>
<hr>
<h1>table.foreach</h1>
<pre><code class="language-lua">function table.foreach(list: any, callback: fun(key: string, value: any):&lt;T&gt;|nil)
  -&gt; &lt;T&gt;|nil
</code></pre>
<hr>
<h1>table.foreachi</h1>
<pre><code class="language-lua">function table.foreachi(list: any, callback: fun(key: string, value: any):&lt;T&gt;|nil)
  -&gt; &lt;T&gt;|nil
</code></pre>
<hr>
<h1>table.getn</h1>
<pre><code class="language-lua">function table.getn(list: &lt;T&gt;[])
  -&gt; integer
</code></pre>
<hr>
<h1>table.insert</h1>
<pre><code class="language-lua">function table.insert(list: table, pos: integer, value: any)
</code></pre>
<hr>
<h1>table.maxn</h1>
<pre><code class="language-lua">function table.maxn(table: table)
  -&gt; integer
</code></pre>
<hr>
<h1>table.move</h1>
<pre><code class="language-lua">function table.move(a1: table, f: integer, e: integer, t: integer, a2?: table)
  -&gt; a2: table
</code></pre>
<hr>
<h1>table.pack</h1>
<pre><code class="language-lua">function table.pack(...any)
  -&gt; table
</code></pre>
<hr>
<h1>table.remove</h1>
<pre><code class="language-lua">function table.remove(list: table, pos?: integer)
  -&gt; any
</code></pre>
<hr>
<h1>table.sort</h1>
<pre><code class="language-lua">function table.sort(list: &lt;T&gt;[], comp?: fun(a: &lt;T&gt;, b: &lt;T&gt;):boolean)
</code></pre>
<hr>
<h1>table.unpack</h1>
<pre><code class="language-lua">function table.unpack(list: &lt;T&gt;[], i?: integer, j?: integer)
  -&gt; ...&lt;T&gt;
</code></pre>
<hr>
<h1>tablelib</h1>
<h2>concat</h2>
<pre><code class="language-lua">function table.concat(list: table, sep?: string, i?: integer, j?: integer)
  -&gt; string
</code></pre>
<p>Given a list where all elements are strings or numbers, returns the string <code>list[i]..sep..list[i+1] ··· sep..list[j]</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.concat&quot;]">View documents</a></p>
<h2>foreach</h2>
<pre><code class="language-lua">function table.foreach(list: any, callback: fun(key: string, value: any):&lt;T&gt;|nil)
  -&gt; &lt;T&gt;|nil
</code></pre>
<p>Executes the given f over all elements of table. For each element, f is called with the index and respective value as arguments. If f returns a non-nil value, then the loop is broken, and this value is returned as the final value of foreach.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.foreach&quot;]">View documents</a></p>
<h2>foreachi</h2>
<pre><code class="language-lua">function table.foreachi(list: any, callback: fun(key: string, value: any):&lt;T&gt;|nil)
  -&gt; &lt;T&gt;|nil
</code></pre>
<p>Executes the given f over the numerical indices of table. For each index, f is called with the index and respective value as arguments. Indices are visited in sequential order, from 1 to n, where n is the size of the table. If f returns a non-nil value, then the loop is broken and this value is returned as the result of foreachi.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.foreachi&quot;]">View documents</a></p>
<h2>getn</h2>
<pre><code class="language-lua">function table.getn(list: &lt;T&gt;[])
  -&gt; integer
</code></pre>
<p>Returns the number of elements in the table. This function is equivalent to <code>#list</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.getn&quot;]">View documents</a></p>
<h2>insert</h2>
<pre><code class="language-lua">function table.insert(list: table, pos: integer, value: any)
</code></pre>
<p>Inserts element <code>value</code> at position <code>pos</code> in <code>list</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.insert&quot;]">View documents</a></p>
<h2>maxn</h2>
<pre><code class="language-lua">function table.maxn(table: table)
  -&gt; integer
</code></pre>
<p>Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.maxn&quot;]">View documents</a></p>
<h2>move</h2>
<pre><code class="language-lua">function table.move(a1: table, f: integer, e: integer, t: integer, a2?: table)
  -&gt; a2: table
</code></pre>
<p>Moves elements from table <code>a1</code> to table <code>a2</code>.</p>
<pre><code class="language-lua">a2[t],··· =
a1[f],···,a1[e]
return a2
</code></pre>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.move&quot;]">View documents</a></p>
<h2>pack</h2>
<pre><code class="language-lua">function table.pack(...any)
  -&gt; table
</code></pre>
<p>Returns a new table with all arguments stored into keys <code>1</code>, <code>2</code>, etc. and with a field <code>"n"</code> with the total number of arguments.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.pack&quot;]">View documents</a></p>
<h2>remove</h2>
<pre><code class="language-lua">function table.remove(list: table, pos?: integer)
  -&gt; any
</code></pre>
<p>Removes from <code>list</code> the element at position <code>pos</code>, returning the value of the removed element.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.remove&quot;]">View documents</a></p>
<h2>sort</h2>
<pre><code class="language-lua">function table.sort(list: &lt;T&gt;[], comp?: fun(a: &lt;T&gt;, b: &lt;T&gt;):boolean)
</code></pre>
<p>Sorts list elements in a given order, <em>in-place</em>, from <code>list[1]</code> to <code>list[#list]</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.sort&quot;]">View documents</a></p>
<h2>unpack</h2>
<pre><code class="language-lua">function table.unpack(list: &lt;T&gt;[], i?: integer, j?: integer)
  -&gt; ...&lt;T&gt;
</code></pre>
<p>Returns the elements from the given list. This function is equivalent to</p>
<pre><code class="language-lua">    return list[i], list[i+1], ···, list[j]
</code></pre>
<p>By default, <code>i</code> is <code>1</code> and <code>j</code> is <code>#list</code>.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-table.unpack&quot;]">View documents</a></p>
<hr>
<h1>text_input_event</h1>
<h2>text</h2>
<pre><code class="language-lua">string
</code></pre>
<hr>
<h1>text_input_event</h1>
<pre><code class="language-lua">text_input_event
</code></pre>
<pre><code class="language-lua">text_input_event
</code></pre>
<hr>
<h1>textnodeObj</h1>
<hr>
<h1>textureObj</h1>
<hr>
<h1>thread</h1>
<hr>
<h1>tonumber</h1>
<pre><code class="language-lua">function tonumber(e: any)
  -&gt; number?
</code></pre>
<hr>
<h1>tostring</h1>
<pre><code class="language-lua">function tostring(v: any)
  -&gt; string
</code></pre>
<hr>
<h1>touch_event</h1>
<h2>action_index</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>count</h2>
<pre><code class="language-lua">integer
</code></pre>
<h2>pointers</h2>
<pre><code class="language-lua">pointer[]
</code></pre>
<hr>
<h1>touch_event</h1>
<pre><code class="language-lua">touch_event
</code></pre>
<pre><code class="language-lua">touch_event
</code></pre>
<hr>
<h1>true</h1>
<hr>
<h1>type</h1>
<hr>
<h1>type</h1>
<pre><code class="language-lua">function type(v: any)
  -&gt; type: &quot;boolean&quot;|&quot;function&quot;|&quot;nil&quot;|&quot;number&quot;|&quot;string&quot;...(+3)
</code></pre>
<hr>
<h1>unknown</h1>
<hr>
<h1>unpack</h1>
<pre><code class="language-lua">function unpack(list: &lt;T&gt;[], i?: integer, j?: integer)
  -&gt; ...&lt;T&gt;
</code></pre>
<pre><code class="language-lua">function unpack(list: { [1]: &lt;T1&gt;, [2]: &lt;T2&gt;, [3]: &lt;T3&gt;, [4]: &lt;T4&gt;, [5]: &lt;T5&gt;, [6]: &lt;T6&gt;, [7]: &lt;T7&gt;, [8]: &lt;T8&gt;, [9]: &lt;T9&gt; })
  -&gt; &lt;T1&gt;
  2. &lt;T2&gt;
  3. &lt;T3&gt;
  4. &lt;T4&gt;
  5. &lt;T5&gt;
  6. &lt;T6&gt;
  7. &lt;T7&gt;
  8. &lt;T8&gt;
  9. &lt;T9&gt;
</code></pre>
<hr>
<h1>userdata</h1>
<hr>
<h1>utf8</h1>
<pre><code class="language-lua">utf8lib
</code></pre>
<hr>
<h1>utf8.char</h1>
<pre><code class="language-lua">function utf8.char(code: integer, ...integer)
  -&gt; string
</code></pre>
<hr>
<h1>utf8.codepoint</h1>
<pre><code class="language-lua">function utf8.codepoint(s: string, i?: integer, j?: integer, lax?: boolean)
  -&gt; code: integer
  2. ...integer
</code></pre>
<hr>
<h1>utf8.codes</h1>
<pre><code class="language-lua">function utf8.codes(s: string, lax?: boolean)
  -&gt; fun(s: string, p: integer):integer, integer
</code></pre>
<hr>
<h1>utf8.len</h1>
<pre><code class="language-lua">function utf8.len(s: string, i?: integer, j?: integer, lax?: boolean)
  -&gt; integer?
  2. errpos: integer?
</code></pre>
<hr>
<h1>utf8.offset</h1>
<pre><code class="language-lua">function utf8.offset(s: string, n: integer, i?: integer)
  -&gt; p: integer
</code></pre>
<hr>
<h1>utf8lib</h1>
<h2>char</h2>
<pre><code class="language-lua">function utf8.char(code: integer, ...integer)
  -&gt; string
</code></pre>
<p>Receives zero or more integers, converts each one to its corresponding UTF-8 byte sequence and returns a string with the concatenation of all these sequences.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.char&quot;]">View documents</a></p>
<h2>charpattern</h2>
<pre><code class="language-lua">string
</code></pre>
<p>The pattern which matches exactly one UTF-8 byte sequence, assuming that the subject is a valid UTF-8 string.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.charpattern&quot;]">View documents</a></p>
<h2>codepoint</h2>
<pre><code class="language-lua">function utf8.codepoint(s: string, i?: integer, j?: integer, lax?: boolean)
  -&gt; code: integer
  2. ...integer
</code></pre>
<p>Returns the codepoints (as integers) from all characters in <code>s</code> that start between byte position <code>i</code> and <code>j</code> (both included).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.codepoint&quot;]">View documents</a></p>
<h2>codes</h2>
<pre><code class="language-lua">function utf8.codes(s: string, lax?: boolean)
  -&gt; fun(s: string, p: integer):integer, integer
</code></pre>
<p>Returns values so that the construction</p>
<pre><code class="language-lua">for p, c in utf8.codes(s) do
    body
end
</code></pre>
<p>will iterate over all UTF-8 characters in string s, with p being the position (in bytes) and c the code point of each character. It raises an error if it meets any invalid byte sequence.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.codes&quot;]">View documents</a></p>
<h2>len</h2>
<pre><code class="language-lua">function utf8.len(s: string, i?: integer, j?: integer, lax?: boolean)
  -&gt; integer?
  2. errpos: integer?
</code></pre>
<p>Returns the number of UTF-8 characters in string <code>s</code> that start between positions <code>i</code> and <code>j</code> (both inclusive).</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.len&quot;]">View documents</a></p>
<h2>offset</h2>
<pre><code class="language-lua">function utf8.offset(s: string, n: integer, i?: integer)
  -&gt; p: integer
</code></pre>
<p>Returns the position (in bytes) where the encoding of the <code>n</code>-th character of <code>s</code> (counting from position <code>i</code>) starts.</p>
<p><a href="command:extension.lua.doc?[&quot;en-us/54/manual.html/pdf-utf8.offset&quot;]">View documents</a></p>
<hr>
<h1>vbuf</h1>
<hr>
<h1>video_mode</h1>
<h2>blue_bits</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of bits for the blue channel</p>
<h2>green_bits</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of bits for the green channel</p>
<h2>height</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The video height</p>
<h2>red_bits</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The number of bits for the red channel</p>
<h2>refresh_rate</h2>
<pre><code class="language-lua">number
</code></pre>
<p>The refresh rate in Hz</p>
<h2>width</h2>
<pre><code class="language-lua">integer
</code></pre>
<p>The video width</p>
<hr>
<h1>video_mode</h1>
<pre><code class="language-lua">video_mode
</code></pre>
<pre><code class="language-lua">video_mode
</code></pre>
<hr>
<h1>viewportObj</h1>
<hr>
<h1>warn</h1>
<pre><code class="language-lua">function warn(message: string, ...any)
</code></pre>
<hr>
<h1>xpcall</h1>
<pre><code class="language-lua">function xpcall(f: fun(...any):...unknown, msgh: function, arg1?: any, ...any)
  -&gt; success: boolean
  2. result: any
  3. ...any
</code></pre>