nCine Lua API

animated_sprite

add_animation()

add_child()

animation_index()

clear_animations()

delete()

frame()

get_abs_anchor_point()

get_alpha()

get_anchor_point()

get_color()

get_dest_blending_factor()

get_height()

get_layer()

get_parent()

get_position()

get_rotation()

get_scale()

get_size()

get_src_blending_factor()

get_texrect()

get_texture()

get_width()

is_blending_enabled()

is_enabled()

is_flipped_x()

is_flipped_y()

is_paused()

new()

num_animations()

remove_child()

set_abs_anchor_point()

set_alpha()

set_anchor_point()

set_animation_index()

set_blending_enabled()

set_blending_factors()

set_blending_preset()

set_color()

set_enabled()

set_flipped_x()

set_flipped_y()

set_frame()

set_height()

set_layer()

set_parent()

set_paused()

set_position()

set_rotation()

set_scale()

set_scale_x()

set_scale_y()

set_size()

set_texrect()

set_texture()

set_width()

unlink_child()

application

get_auto_suspension()

get_debugoverlay_settings()

get_height()

get_rendering_settings()

get_width()

interval()

is_suspended()

quit()

rootnode()

screen_dimensions()

set_auto_suspension()

set_debugoverlay_settings()

set_rendering_settings()

set_suspended()

audio_device

freeze_players()

get_gain()

get_player()

name()

num_players()

pause_players()

set_gain()

stop_players()

unfreeze_players()

audiobuffer

buffer_id()

buffer_size()

delete()

frequency()

new()

num_channels()

audiobuffer_player

buffer_id()

buffer_size()

delete()

frequency()

get_gain()

get_pitch()

get_position()

is_looping()

is_paused()

is_playing()

is_stopped()

new()

num_channels()

pause()

play()

set_gain()

set_looping()

set_pitch()

set_position()

source_id()

stop()

audiostream_player

buffer_id()

buffer_size()

delete()

frequency()

get_gain()

get_pitch()

get_position()

is_looping()

is_paused()

is_playing()

is_stopped()

new()

num_channels()

pause()

play()

set_gain()

set_looping()

set_pitch()

set_position()

source_id()

stop()

blending_factor

CONSTANT_ALPHA: 12
CONSTANT_COLOR: 10
DST_ALPHA: 8
DST_COLOR: 4
ONE: 1
ONE_MINUS_CONSTANT_ALPHA: 13
ONE_MINUS_CONSTANT_COLOR: 11
ONE_MINUS_DST_ALPHA: 9
ONE_MINUS_DST_COLOR: 5
ONE_MINUS_SRC_ALPHA: 7
ONE_MINUS_SRC_COLOR: 3
SRC_ALPHA: 6
SRC_ALPHA_SATURATE: 14
SRC_COLOR: 2
ZERO: 0

blending_preset

ADDITIVE: 3
ALPHA: 1
DISABLED: 0
MULTIPLY: 4
PREMULTIPLIED_ALPHA: 2

color

add()

create()

mul()

sub()

font

base()

delete()

line_height()

new()

num_glyphs()

num_kernings()

texture()

texture_size()

fs

absolute_join_path()

absolute_path()

add_permissions()

basename()

change_permissions()

copy()

create_dir()

delete_empty_dir()

delete_file()

dirname()

exists()

file_size()

get_current_dir()

get_datapath()

get_extension()

get_home_dir()

get_savepath()

has_extension()

is_directory()

is_executable()

is_file()

is_hidden()

is_readable()

is_readable_file()

is_writable()

is_writable_file()

join_path()

last_access_time()

last_modification_time()

logical_drive_strings()

logical_drives()

permissions()

remove_permissions()

rename()

set_current_dir()

set_hidden()

input

add_joymappings_from_file()

add_joymappings_from_strings()

deadzone_normalize()

get_mouse_cursor_mode()

joy_axis_normvalue()

joy_axis_value()

joy_button_pressed()

joy_guid()

joy_hat_state()

joy_mapped()

joy_name()

joy_num_axes()

joy_num_buttons()

joy_num_hats()

joy_present()

joy_state()

joymapped_state()

key_down()

key_state()

mouse_state()

set_mouse_cursor_mode()

joy_axis

LTRIGGER: 4
LX: 0
LY: 1
RTRIGGER: 5
RX: 2
RY: 3
UNKNOWN: -1

joy_button

A: 0
B: 1
BACK: 4
DPAD_DOWN: 12
DPAD_LEFT: 13
DPAD_RIGHT: 14
DPAD_UP: 11
GUIDE: 5
LBUMPER: 9
LSTICK: 7
RBUMPER: 10
RSTICK: 8
START: 6
UNKNOWN: -1
X: 2
Y: 3

joy_dead_zone

LEFT_STICK: 0.23953978717327
RIGHT_STICK: 0.26517534255981
TRIGGER: 0.00091555528342724

joy_hat_state

CENTERED: 0
DOWN: 4
LEFT: 8
LEFT_DOWN: 12
LEFT_UP: 9
RIGHT: 2
RIGHT_DOWN: 6
RIGHT_UP: 3
UP: 1

keymod

ALT: 768
CAPS: 8192
CTRL: 192
LALT: 256
LCTRL: 64
LSHIFT: 1
LSUPER: 1024
MODE: 16384
NONE: 0
NUM: 4096
RALT: 512
RCTRL: 128
RSHIFT: 2
RSUPER: 2048
SHIFT: 3
SUPER: 3072
SYM: 32768

keysym

A: 26
AMPERSAND: 113
APPLICATION: 126
APP_SWITCH: 212
ASTERISK: 116
AT: 122
AVR_INPUT: 207
AVR_POWER: 206
B: 27
BACK: 135
BACKQUOTE: 25
BACKSLASH: 23
BACKSPACE: 0
BOOKMARK: 199
BUTTON_1: 213
BUTTON_10: 222
BUTTON_11: 223
BUTTON_12: 224
BUTTON_13: 225
BUTTON_14: 226
BUTTON_15: 227
BUTTON_16: 228
BUTTON_2: 214
BUTTON_3: 215
BUTTON_4: 216
BUTTON_5: 217
BUTTON_6: 218
BUTTON_7: 219
BUTTON_8: 220
BUTTON_9: 221
BUTTON_A: 161
BUTTON_B: 162
BUTTON_C: 163
BUTTON_L1: 167
BUTTON_L2: 169
BUTTON_MODE: 175
BUTTON_R1: 168
BUTTON_R2: 170
BUTTON_SELECT: 174
BUTTON_START: 173
BUTTON_THUMBL: 171
BUTTON_THUMBR: 172
BUTTON_X: 164
BUTTON_Y: 165
BUTTON_Z: 166
C: 28
CALL: 136
CAMERA: 143
CAPS_LOCK: 95
CAPTIONS: 200
CARET: 123
CHANNEL_DOWN: 192
CHANNEL_UP: 191
CLEAR: 108
COLON: 117
COMMA: 7
D: 29
DELETE: 52
DOLLAR: 112
DOWN: 71
DPAD_CENTER: 140
DVR: 198
E: 30
END: 76
ENDCALL: 137
ENVELOPE: 146
EQUALS: 119
ESCAPE: 3
EXCLAIM: 109
EXPLORER: 145
F: 31
F1: 79
F10: 88
F11: 89
F12: 90
F13: 91
F14: 92
F2: 80
F3: 81
F4: 82
F5: 93
F6: 84
F7: 85
F8: 86
F9: 87
FOCUS: 149
FORWARD: 180
FORWARD_DEL: 176
FUNCTION_KEY: 177
G: 32
GREATER: 120
GUIDE: 197
H: 33
HASH: 111
HEADSETHOOK: 148
HELP: 127
HOME: 75
I: 34
INFO: 190
INSERT: 74
J: 35
K: 36
KP0: 53
KP1: 54
KP2: 55
KP3: 56
KP4: 57
KP5: 58
KP6: 59
KP7: 60
KP8: 61
KP9: 62
KP_COMMA: 186
KP_DIVIDE: 64
KP_ENTER: 68
KP_EQUALS: 69
KP_LEFTPAREN: 187
KP_MINUS: 66
KP_MULTIPLY: 65
KP_PERIOD: 63
KP_PLUS: 67
KP_RIGHTPAREN: 188
L: 37
LALT: 102
LCTRL: 100
LEFT: 73
LEFTBRACKET: 22
LEFTPAREN: 114
LESS: 118
LSHIFT: 98
LSUPER: 104
M: 38
MEDIA_CLOSE: 183
MEDIA_EJECT: 184
MEDIA_FAST_FORWARD: 157
MEDIA_NEXT: 154
MEDIA_PAUSE: 182
MEDIA_PLAY: 181
MEDIA_PLAY_PAUSE: 152
MEDIA_PREVIOUS: 155
MEDIA_RECORD: 185
MEDIA_REWIND: 156
MEDIA_STOP: 153
MENU: 107
MINUS: 8
MODE: 125
MOVE_END: 179
MOVE_HOME: 178
MUTE: 158
N: 39
N0: 11
N1: 12
N2: 13
N3: 14
N4: 15
N5: 16
N6: 17
N7: 18
N8: 19
N9: 20
NOTIFICATION: 150
NUM: 147
NUM_LOCK: 94
O: 40
P: 41
PAGEDOWN: 78
PAGEUP: 77
PAUSE: 106
PERIOD: 9
PICTSYMBOLS: 159
PLUS: 6
POUND: 139
POWER: 129
PRINTSCREEN: 105
PROG_BLUE: 211
PROG_GREEN: 209
PROG_RED: 208
PROG_YELLOW: 210
Q: 42
QUESTION: 121
QUOTE: 5
QUOTEDBL: 110
R: 43
RALT: 101
RCTRL: 99
RETURN: 2
RIGHT: 72
RIGHTBRACKET: 24
RIGHTPAREN: 115
RSHIFT: 97
RSUPER: 103
S: 44
SCROLL_LOCK: 96
SEARCH: 151
SEMICOLON: 21
SETTINGS: 201
SLASH: 10
SOFT_LEFT: 133
SOFT_RIGHT: 134
SPACE: 4
STAR: 138
STB_INPUT: 205
STB_POWER: 204
SWITCH_CHARSET: 160
SYM: 144
SYSREQ: 128
T: 45
TAB: 1
TV: 195
TV_INPUT: 203
TV_POWER: 202
U: 46
UNDERSCORE: 124
UNDO: 130
UNKNOWN: -1
UP: 70
V: 47
VOLUME_DOWN: 142
VOLUME_MUTE: 189
VOLUME_UP: 141
W: 48
WINDOW: 196
WORLD1: 131
WORLD2: 132
X: 49
Y: 50
Z: 51
ZOOM_IN: 193
ZOOM_OUT: 194

layer_base

HIGHEST: 65535
HUD: 32767
LOWEST: 0
SCENE: 0

log

debug()

error()

fatal()

info()

verbose()

warn()

log_level

DEBUG: 2
ERROR: 5
FATAL: 6
INFO: 3
OFF: 7
UNKNOWN: 0
VERBOSE: 1
WARN: 4

loop_mode

DISABLED: 0
ENABLED: 1

mesh_sprite

add_child()

copy_indices()

copy_vertices()

create_vertices_from_texels()

delete()

get_abs_anchor_point()

get_alpha()

get_anchor_point()

get_color()

get_dest_blending_factor()

get_height()

get_layer()

get_parent()

get_position()

get_rotation()

get_scale()

get_size()

get_src_blending_factor()

get_texrect()

get_texture()

get_width()

is_blending_enabled()

is_enabled()

is_flipped_x()

is_flipped_y()

new()

num_indices()

num_vertices()

remove_child()

set_abs_anchor_point()

set_alpha()

set_anchor_point()

set_blending_enabled()

set_blending_factors()

set_blending_preset()

set_color()

set_enabled()

set_flipped_x()

set_flipped_y()

set_height()

set_indices()

set_layer()

set_parent()

set_position()

set_rotation()

set_scale()

set_scale_x()

set_scale_y()

set_size()

set_texrect()

set_texture()

set_vertices()

set_width()

unlink_child()

mouse_button

FIFTH: 4
FOURTH: 3
LEFT: 0
MIDDLE: 1
RIGHT: 2

mouse_cursor_mode

DISABLED: 2
HIDDEN: 1
NORMAL: 0

particle_system

add_child()

add_color_affector()

add_position_affector()

add_rotation_affector()

add_size_affector()

add_velocity_affector()

clear_affectors()

delete()

emit_particles()

get_abs_anchor_point()

get_alpha()

get_color()

get_in_local_space()

get_parent()

get_position()

get_rotation()

get_scale()

is_enabled()

kill_particles()

new()

num_alive_particles()

num_particles()

remove_child()

set_abs_anchor_point()

set_alpha()

set_anchor_point()

set_blending_factors()

set_blending_preset()

set_color()

set_enabled()

set_flipped_x()

set_flipped_y()

set_in_local_space()

set_layer()

set_parent()

set_position()

set_rotation()

set_scale()

set_scale_x()

set_scale_y()

set_texture()

set_texture_rect()

unlink_child()

permission

EXECUTE: 4
READ: 1
WRITE: 2

rect

create()

create_center_size()

rewind_mode

BACKWARD: 1
FROM_START: 0

sprite

add_child()

delete()

get_abs_anchor_point()

get_alpha()

get_anchor_point()

get_color()

get_dest_blending_factor()

get_height()

get_layer()

get_parent()

get_position()

get_rotation()

get_scale()

get_size()

get_src_blending_factor()

get_texrect()

get_texture()

get_width()

is_blending_enabled()

is_enabled()

is_flipped_x()

is_flipped_y()

new()

remove_child()

set_abs_anchor_point()

set_alpha()

set_anchor_point()

set_blending_enabled()

set_blending_factors()

set_blending_preset()

set_color()

set_enabled()

set_flipped_x()

set_flipped_y()

set_height()

set_layer()

set_parent()

set_position()

set_rotation()

set_scale()

set_scale_x()

set_scale_y()

set_size()

set_texrect()

set_texture()

set_width()

unlink_child()

start()

tex_filtering

LINEAR: 1
LINEAR_MIPMAP_LINEAR: 5
LINEAR_MIPMAP_NEAREST: 3
NEAREST: 0
NEAREST_MIPMAP_LINEAR: 4
NEAREST_MIPMAP_NEAREST: 2