├── LICENSE ├── README.md └── definitions ├── grandMA3_lua_enums.lua └── grandMA3_lua_functions.lua /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 jefffarrow 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # grandMA3_lua_functions 2 | A library of grandMA3 specific Lua functions, formatted for use with Visual Studio Code & the [LuaLS language server](https://luals.github.io/) by [sumneko](https://marketplace.visualstudio.com/publishers/sumneko). 3 | 4 | ## USAGE 5 | Place `grandMA3_lua_functions.lua` in your Visual Studio Code workspace, in a directory named `definition`. 6 | 7 | This library is derived from the `grandMA3_lua_functions.txt` file that is generated in the grandMA3 application by executing the `HelpLua` command. 8 | 9 | 10 | OPEN ALPHA 11 | 12 | This project is not official or affilated with MA Lighting International GmbH. 13 | 14 | Contributions / Corrections / Collaboration all welcomed. 15 | 16 | Create a [GitHub Issue](https://github.com/jefffarrow/grandMA3_lua_functions/issues/new/choose) if you have something to share. 17 | -------------------------------------------------------------------------------- /definitions/grandMA3_lua_functions.lua: -------------------------------------------------------------------------------- 1 | --MA3 Software version: 2.2.1.1 2 | 3 | --updated 2025-10-16 4 | 5 | ---@meta 6 | 7 | ---@class LuaFileSystem 8 | local lfs = {} 9 | 10 | ---@alias enum enum # 11 | ---@alias value value # 12 | ---@alias nothing nothing # no feedback to MA system monitor 13 | ---@alias result result # MA system monitor restult (Ok, Syntax Error, Illegal Command...) 14 | ---@alias light_userdata lightuserdata # MA UID 15 | ---@alias handle lightuserdata # MA UID 16 | ---@alias double double # 64-bit floating-point number (C) 17 | ---@alias float float # 64-bit floating-point number (C) 18 | ---@alias pCertificate pCertificate # OverallDeviceCertificate 19 | ---@alias LuaInteger LuaInteger # The integer that correlates to an objects handle 20 | 21 | --Object-Free API 22 | 23 | ---@return nothing 24 | ---@param ... string # string:formatted_command ... 25 | function Echo(...) end 26 | 27 | ---@return nothing 28 | ---@param ... string # string:formatted_command ... 29 | function ErrEcho(...) end 30 | 31 | ---@return nothing 32 | ---@param ... string # string:formatted_command ... 33 | function Printf(...) end 34 | 35 | ---@return nothing 36 | ---@param ... string # string:formatted_command ... 37 | function ErrPrintf(...) end 38 | 39 | ---@return string # command_execution_result ('Ok', 'Syntax Error', 'Illegal Command', ...) 40 | ---@param ... string # string:formatted_command[ ,light_userdata:undo], ... 41 | function Cmd(...) end 42 | 43 | ---@return nothing 44 | ---@param ... string # string:command[, light_userdata:undo[, light_userdata:target]] 45 | function CmdIndirect(...) end 46 | 47 | ---@return nothing 48 | ---@param ... string # string:command[, light_userdata:undo[, light_userdata:target]] 49 | function CmdIndirectWait(...) end 50 | 51 | ---@return string # ostype 52 | function HostOS() end 53 | 54 | ---@return string # hosttype 55 | function HostType() end 56 | 57 | ---@return string # hostsubtype 58 | function HostSubType() end 59 | 60 | ---@return string # serialnumber 61 | function SerialNumber() end 62 | 63 | ---@return handle 64 | function OverallDeviceCertificate() end 65 | 66 | ---@return boolean # success 67 | ---@param ip string # string:ip, string:command 68 | ---@param command string 69 | function RemoteCommand(ip, command) end 70 | 71 | ---@return boolean # success 72 | ---@param queue_name string 73 | function endOpenMessageQueue(queue_name) end 74 | 75 | ---@return boolean # success 76 | ---@param queue_name string 77 | function CloseMessageQueue(queue_name) end 78 | 79 | ---@return boolean # success 80 | ---@param station string 81 | ---@param channel_name string 82 | ---@param data table 83 | function SendLuaMessage(station, channel_name, data) end 84 | 85 | ---@return string # releasetype 86 | function ReleaseType() end 87 | 88 | ---@return string # devmode3d 89 | function DevMode3d() end 90 | 91 | ---@return string # version 92 | function Version() end 93 | 94 | ---@return table # build_details 95 | function BuildDetails() end 96 | 97 | ---@return string # showfile_status 98 | function GetShowFileStatus() end 99 | 100 | ---@return table # config_details 101 | function ConfigTable() end 102 | 103 | ---@return handle 104 | function CmdObj() end 105 | 106 | ---@return handle 107 | function Root() end 108 | 109 | ---@return handle 110 | function Pult() end 111 | 112 | ---@return handle 113 | function DefaultDisplayPositions() end 114 | 115 | ---@return handle 116 | function Patch() end 117 | 118 | ---@return handle 119 | function FixtureType() end 120 | 121 | ---@return handle 122 | function ShowData() end 123 | 124 | ---@return handle 125 | function ShowSettings() end 126 | 127 | ---@return handle 128 | function DataPool() end 129 | 130 | ---@return handle 131 | function MasterPool() end 132 | 133 | ---@return handle 134 | function DeviceConfiguration() end 135 | 136 | ---@return handle 137 | function Programmer() end 138 | 139 | ---@return handle 140 | function ProgrammerPart() end 141 | 142 | ---@return handle 143 | function Selection() end 144 | 145 | ---@return handle 146 | function CurrentUser() end 147 | 148 | ---@return handle 149 | function CurrentProfile() end 150 | 151 | ---@return handle 152 | function CurrentEnvironment() end 153 | 154 | ---@return handle 155 | function CurrentScreenConfig() end 156 | 157 | ---@return handle 158 | function CurrentExecPage() end 159 | 160 | ---@return handle 161 | function SelectedSequence() end 162 | 163 | ---@return handle 164 | function GetCurrentCue() end 165 | 166 | ---@return handle 167 | function SelectedTimecode() end 168 | 169 | ---@return handle 170 | function SelectedLayout() end 171 | 172 | ---@return handle 173 | function SelectedTimer() end 174 | 175 | ---@return handle 176 | function GetSelectedAttribute() end 177 | 178 | ---@return handle 179 | function SelectedFeature() end 180 | 181 | ---@return handle 182 | function SelectedDrive() end 183 | 184 | ---@return handle # executor, handle # page 185 | ---@param executor integer # integer:executor 186 | function GetExecutor(executor) end 187 | 188 | ---@return nothing 189 | ---@param executor handle # light_userdata:executor 190 | function LoadExecConfig(executor) end 191 | 192 | ---@return nothing 193 | ---@param executor handle # light_userdata:executor 194 | function SaveExecConfig(executor) end 195 | 196 | ---@return integer # first subfixture index 197 | ---@return integer # x 198 | ---@return integer # y 199 | ---@return integer # z 200 | function SelectionFirst() end 201 | 202 | ---@return integer # next subfixture index 203 | ---@return integer # x 204 | ---@return integer # y 205 | ---@return integer # z 206 | ---@param current_subfixture_index integer 207 | function SelectionNext(current_subfixture_index) end 208 | 209 | ---@return integer # amount_of_selected_subfixtures 210 | function SelectionCount() end 211 | 212 | ---@return integer # min 213 | ---@return integer # max 214 | ---@return integer # index 215 | ---@return integer # block 216 | ---@return integer # group 217 | function SelectionComponentX() end 218 | 219 | ---@return integer # min 220 | ---@return integer # max 221 | ---@return integer # index 222 | ---@return integer # block 223 | ---@return integer # group 224 | function SelectionComponentY() end 225 | 226 | ---@return integer # min 227 | ---@return integer # max 228 | ---@return integer # index 229 | ---@return integer # block 230 | ---@return integer # group 231 | function SelectionComponentZ() end 232 | 233 | ---@return integer # subfixture_count 234 | function GetSubfixtureCount() end 235 | 236 | ---@return handle # subfixture 237 | ---@param subfixture_index integer # integer:subfixture_index 238 | function GetSubfixture(subfixture_index) end 239 | 240 | ---@return integer # ui_channel_count 241 | function GetUIChannelCount() end 242 | 243 | ---@return integer # rt_channel_count 244 | function GetRTChannelCount() end 245 | 246 | ---@return integer # attribute_count 247 | function GetAttributeCount() end 248 | 249 | ---@return table|nil # {integer:ui_channels} or {handle:ui_channels} 250 | ---@param subfixture? integer|light_userdata 251 | ---@param return_as_handles? boolean 252 | function GetUIChannels(subfixture, return_as_handles) end 253 | 254 | ---@return table|nil # {integer:rt_channels} or {handle:rt_channels} 255 | ---@param reference_to_fixture_object integer|light_userdata 256 | ---@param return_as_handles? boolean 257 | function GetRTChannels(reference_to_fixture_object, return_as_handles) end 258 | 259 | ---@return table # ui_channel_descriptor 260 | ---@param subfixture_reference integer|light_userdata 261 | ---@param attribute integer|string 262 | function GetUIChannel(subfixture_reference, attribute) end 263 | 264 | ---@return table # rt_channel_descriptor 265 | ---@param rt_channel_index integer # integer:rt_channel_index 266 | function GetRTChannel(rt_channel_index) end 267 | 268 | ---@return handle # reference_to_attribute 269 | ---@param ui_channel_index integer # integer:ui channel index 270 | function GetAttributeByUIChannel(ui_channel_index) end 271 | 272 | ---@return handle # fixture 273 | ---@param dmxmode handle # light_userdata:dmxmode 274 | function FirstDmxModeFixture(dmxmode) end 275 | 276 | ---@return handle # fixture 277 | ---@param fixture handle # light_userdata:fixture 278 | function NextDmxModeFixture(fixture) end 279 | 280 | ---@return integer # attribute_index 281 | ---@param attribute_name string # string:attribute_name 282 | function GetAttributeIndex(attribute_name) end 283 | 284 | ---@return integer # ui_channel_index 285 | ---@param subfixture_index integer # integer:subfixture_index, integer:attribute_index 286 | ---@param attribute_index integer 287 | function GetUIChannelIndex(subfixture_index, attribute_index) end 288 | 289 | ---@return integer # channel_function_index 290 | ---@param ui_channel_index integer # integer:ui_channel_index, integer:attribute_index 291 | ---@param attribute_index integer 292 | function GetChannelFunctionIndex(ui_channel_index, attribute_index) end 293 | 294 | ---@return handle 295 | ---@param ui_channel_index integer # integer:ui_channel_index, integer:attribute_index 296 | ---@param attribute_index integer 297 | function GetChannelFunction(ui_channel_index, attribute_index) end 298 | 299 | ---@return string # full_name 300 | ---@param shortName string # string:shortName 301 | function GetTokenName(shortName) end 302 | 303 | ---@return string # full_name 304 | ---@param token_index integer # integer:token_index 305 | function GetTokenNameByIndex(token_index) end 306 | 307 | ---@return nothing 308 | ---@param uichannelindex handle 309 | ---@param ProgPhaserArray {} # {[abs_preset][rel_preset][fade][delay][speed][phase][measure][gridpos] {[function:] [absolute][absolute_value][relative] [accel][accel_type][decel][decel_type] [trans][width] [integrated]}*} 310 | function SetProgPhaser(uichannelindex, ProgPhaserArray) end 311 | 312 | ---@return nothing 313 | ---@param uichannelindex number 314 | ---@param step number 315 | ---@param PhaserValueArray function # {[function] [absolute][absolute_value][relative] [accel][accel_type][decel][decel_type>] [trans][width] [integrated]}) 316 | function SetProgPhaserValue(uichannelindex, step, PhaserValueArray) end 317 | 318 | ---@return table # {[abs_preset][rel_preset][fade][delay][speed][phase][measure][gridpos][mask_active_phaser][mask_active_value][mask_individual] {[function] [absolute][absolute_value][relative] [accel][accel_type][decel][decel_type] [trans][width] [integrated]}*} 319 | ---@param uichannelindex number 320 | ---@param phaser_only boolean 321 | function GetProgPhaser(uichannelindex, phaser_only) end 322 | 323 | ---@return table # {[function] [absolute][absolute_value][relative] [accel][accel_type][decel][decel_type] [trans][width] [integrated]} 324 | ---@param uichannelindex number 325 | ---@param step number 326 | function GetProgPhaserValue(uichannelindex, step) end 327 | 328 | ---@return integer # flag 329 | ---|"'RGB'" # the caracter 330 | ---|"'xyY'" # the caracter 331 | ---|"'Lab'" # the caracter 332 | ---|"'XYZ'" # the caracter 333 | ---|"'HSB'" # the caracter 334 | ---@param color_model string 335 | ---@param tripel1 float 336 | ---@param tripel2 float 337 | ---@param tripel3 float 338 | ---@param brightness float 339 | ---@param quality float 340 | ---@param const_brightness boolean 341 | function SetColor(color_model, tripel1, tripel2, tripel3, brightness, quality, const_brightness) end 342 | 343 | ---@return table # phaser_data 344 | ---@param preset_handle handle # light_userdata:preset_handle[, boolean:phasers_only(default=false)[, boolean:by_fixtures(default=true)]] 345 | ---@param phasers_only? boolean 346 | ---@param by_fixtures? boolean 347 | function GetPresetData(preset_handle, phasers_only, by_fixtures) end 348 | 349 | ---@return integer # flag 350 | function ColMeasureDeviceDarkCalibrate() end 351 | 352 | ---@return table # values 353 | function ColMeasureDeviceDoMeasurement() end 354 | 355 | ---@return handle 356 | ---@param address string # string:address 357 | function GetObject(address) end 358 | 359 | ---@return table # {handle:handles} 360 | ---@param address string # string:address[, {['selected_as_default'=boolean:enabled], ['reverse_order'=boolean:enabled]} 361 | function ObjectList(address) end 362 | 363 | ---@return handle 364 | ---@param address? string # string:address[, light_userdata:base_handle] 365 | ---@param base_handle? handle 366 | function FromAddr(address, base_handle) end 367 | 368 | ---@return string # address 369 | ---@param handle handle # light_userdata:handle, boolean:with_name 370 | ---@param with_name boolean 371 | ---@param use_visible_addr? boolean 372 | function ToAddr(handle, with_name, use_visible_addr) end 373 | 374 | ---@return handle 375 | ---@param handle integer # integer:handle 376 | function IntToHandle(handle) end 377 | 378 | ---@return integer # handle 379 | ---@param handle handle # light_userdata:handle 380 | function HandleToInt(handle) end 381 | 382 | ---@return handle 383 | ---@param handle string # string:handle(in H#... format) 384 | function StrToHandle(handle) end 385 | 386 | ---@return string # handle(in H#... format) 387 | ---@param handle handle # light_userdata:handle 388 | function HandleToStr(handle) end 389 | 390 | ---@return boolean # valid 391 | ---@param handle handle # light_userdata:handle 392 | function IsObjectValid(handle) end 393 | 394 | ---@return boolean # success 395 | ---@param file_name string # string:file_name, table:export_data 396 | ---@param export_data table 397 | function Export(file_name, export_data) end 398 | 399 | ---@return table # content 400 | ---@param file_name string # string:file_name 401 | function Import(file_name) end 402 | 403 | ---@return boolean # success 404 | ---@param file_name string # string:file_name, table:export_data 405 | ---@param export_data table 406 | function ExportJson(file_name, export_data) end 407 | 408 | ---@return boolean # success 409 | ---@param file_name string # string:file_name, table:export_data 410 | ---@param export_data table 411 | function ExportCSV(file_name, export_data) end 412 | 413 | ---@return integer # hook_id 414 | ---@param callback function # function:callback, light_userdata:handle, light_userdata:plugin_handle[, light_userdata:target] 415 | ---@param handle handle 416 | ---@param plugin_handle? handle 417 | ---@param target? handle 418 | function HookObjectChange(callback, handle, plugin_handle, target) end 419 | 420 | ---@return boolean # true or nothing 421 | ---@param handle handle # light_userdata:handle[ ,integer:change_level_threshold] 422 | ---@param change_level_threshold? integer 423 | function PrepareWaitObjectChange(handle, change_level_threshold) end 424 | 425 | ---@return nothing 426 | ---@param hook_id integer # integer:hook_id 427 | function Unhook(hook_id) end 428 | 429 | ---@return integer # amount of removed hooks 430 | ---@param callback function # function:callback(can be nil), light_userdata:handle to target(can be nil), light_userdata:handle to context (can be nil) 431 | ---@param handle_to_target handle 432 | ---@param handle_to_context handle 433 | function UnhookMultiple(callback, handle_to_target, handle_to_context) end 434 | 435 | ---@return nothing 436 | function DumpAllHooks() end 437 | 438 | ---@return string # path 439 | ---@param path_type string 440 | ---@param create? boolean 441 | function GetPath(path_type_or_integer, path_type, create) end 442 | 443 | ---@return string # path_type_name 444 | ---@param target_object handle # light_userdata:target_object[ ,integer:content_type (Enums.PathContentType)] 445 | ---@param content_type_? integer 446 | function GetPathType(target_object, content_type_) end 447 | 448 | ---@return string # overwritten_path 449 | ---@param path_type string 450 | ---@param path? string 451 | ---@param create? boolean 452 | function GetPathOverrideFor(path_type_or_integer, path_type, path, create) end 453 | 454 | ---@return string # seperator 455 | function GetPathSeparator() end 456 | 457 | ---@return boolean # result 458 | ---@param path string # string:path 459 | function FileExists(path) end 460 | 461 | ---@return boolean #result 462 | ---@param source_path string 463 | ---@param destination_path string 464 | function CopyFile(source_path, destination_path) end 465 | 466 | ---@return boolean # result 467 | ---@param path string # string:path 468 | function CreateDirectoryRecursive(path) end 469 | 470 | ---@return nothing 471 | function SyncFS() end 472 | 473 | ---@return table # table of {name:string, size:int, time:int} 474 | ---@param path string # string:path[ ,string:filter] 475 | ---@param filter? string 476 | function DirList(path, filter) end 477 | 478 | ---@return integer # progressbar_index 479 | ---@param name string # string:name 480 | function StartProgress(name) end 481 | 482 | ---@return nothing 483 | ---@param progressbar_index integer # integer:progressbar_index 484 | function StopProgress(progressbar_index) end 485 | 486 | ---@return nothing 487 | ---@param progressbar_index integer # integer:progressbar_index, string:text 488 | ---@param text string 489 | function SetProgressText(progressbar_index, text) end 490 | 491 | ---@return nothing 492 | ---@param progressbar_index integer # integer:progressbar_index, integer:start, integer:end 493 | ---@param start integer 494 | ---@param eNd integer 495 | function SetProgressRange(progressbar_index, start, eNd) end 496 | 497 | ---@return nothing 498 | ---@param progressbar_index integer # integer:progressbar_index, integer:value 499 | ---@param value integer 500 | function SetProgress(progressbar_index, value) end 501 | 502 | ---@return nothing 503 | ---@param progressbar_index? integer # integer:progressbar_index[, integer:delta] 504 | ---@param delta? integer 505 | function IncProgress(progressbar_index, delta) end 506 | 507 | ---@return integer # column_id 508 | ---@param handle handle # light_userdata:handle, string:property_name 509 | ---@param property_name string 510 | function GetPropertyColumnId(handle, property_name) end 511 | 512 | ---@return integer # column_id 513 | ---@param handle handle # light_userdata:handle, light_userdata:attribute 514 | ---@param attribute handle 515 | function GetAttributeColumnId(handle, attribute) end 516 | 517 | ---@return nothing 518 | ---@param display_index integer # integer:display_index, string:type('press', 'char', 'release')[ ,string:char(for type 'char') or string:keycode, boolean:shift, boolean:ctrl, boolean:alt, boolean:numlock] 519 | ---@param type string 520 | ---|"'press'" 521 | ---|"'char'" 522 | ---|"'release'" 523 | ---@param keycode string 524 | ---|"'char'" # the caracter 525 | ---|"'keycode'" # the keycode 526 | ---@param shift boolean 527 | ---@param ctrl boolean 528 | ---@param alt boolean 529 | ---@param numlock boolean 530 | function Keyboard(display_index, type, char_or_string, keycode, shift, ctrl, alt, numlock) end 531 | 532 | ---@return nothing 533 | ---@param display_index integer # integer:display_index, string:type('press', 'move', 'release')[ ,string:button('Left', 'Middle', 'Right' for 'press', 'release') or integer:abs_x, integer:abs_y)] 534 | ---@param type string 535 | ---@param button? string 536 | ---@param abs_x? integer 537 | ---@param abs_y? integer 538 | function Mouse(display_index, type, button, abs_x, abs_y) end 539 | 540 | ---@return nothing 541 | ---@param display_index integer # integer:display_index, string:type('press', 'move', 'release'), integer:touch_id, integer:abs_x, integer:abs_y 542 | ---@param type string 543 | ---|"'press'" 544 | ---|"'move'" 545 | ---|"'release'" 546 | ---@param touch_id integer 547 | ---@param abs_x integer 548 | ---@param abs_y integer 549 | function Touch(display_index, type, touch_id, abs_x, abs_y) end 550 | 551 | ---@return integer # time 552 | function Time() end 553 | 554 | ---@return handle 555 | function MouseObj() end 556 | 557 | ---@return handle 558 | function TouchObj() end 559 | 560 | ---@return handle 561 | function KeyboardObj() end 562 | 563 | ---@return nothing 564 | ---@param timer_function function # function:timer_function, integer:delay_time, integer:max_count[, function:cleanup][, light_userdata:context object] 565 | ---@param delay_time integer 566 | ---@param max_count integer 567 | ---@param cleanup? function 568 | ---@param context_object? handle 569 | function Timer(timer_function, delay_time, max_count, cleanup, context_object) end 570 | 571 | ---@return integer # absolute_address 572 | ---@param patch handle # light_userdata:patch, integer:starting_address, integer:footprint 573 | ---@param starting_address integer 574 | ---@param footprint integer 575 | function FindBestDMXPatchAddr(patch, starting_address, footprint) end 576 | 577 | ---@return boolean # no_collision_found 578 | ---@param dmx_mode handle # light_userdata:dmx_mode, string:dmx_address[ ,integer:count[ ,integer:break_index]] 579 | ---@param dmx_address? string 580 | ---@param count? integer 581 | ---@param break_index? integer 582 | function CheckDMXCollision(dmx_mode, dmx_address, count, break_index) end 583 | 584 | ---@return boolean # no_collision_found 585 | ---@param fid integer # integer:fid[, integer:count[, integer:type]] 586 | ---@param count? integer 587 | ---@param type? integer 588 | function CheckFIDCollision(fid, count, type) end 589 | 590 | ---@return integer # dmx_value 591 | ---@param address integer # integer:address[ ,integer:universe, boolean:mode_percent] 592 | ---@param universe? integer 593 | ---@param mode_percent? boolean 594 | function GetDMXValue(address, universe, mode_percent) end 595 | 596 | ---@return table # {integer:dmx_values} 597 | ---@param universe integer # integer:universe[ ,boolean:modePercent] 598 | ---@param modePercent? boolean 599 | function GetDMXUniverse(universe, modePercent) end 600 | 601 | ---@return nothing 602 | ---@param usb_device_object_handle handle # light_userdata:usb_device_object_handle, table:led_values 603 | ---@param led_values table 604 | function SetLED(usb_device_object_handle, led_values) end 605 | 606 | ---@return table of boolean # state 607 | ---@param usb_device_object_handle handle # light_userdata:usb_device_object_handle 608 | function GetButton(usb_device_object_handle) end 609 | 610 | ---@return handle # undo_handle 611 | ---@param undo_text string # string:undo_text 612 | function CreateUndo(undo_text) end 613 | 614 | ---@return boolean # closed (true if was closed, false - if it's still in use) 615 | ---@param undo_handle handle # light_userdata:undo_handle 616 | function CloseUndo(undo_handle) end 617 | 618 | ---@return boolean # desk_is_locked 619 | function DeskLocked() end 620 | 621 | ---@return boolean # need_show_save 622 | function NeedShowSave() end 623 | 624 | ---@return nothing 625 | ---@param handle handle # light_userdata:handle 626 | function RefreshLibrary(handle) end 627 | 628 | ---@return nothing 629 | ---@param associated_context handle # light_userdata:associated_context 630 | function SelectionNotifyBegin(associated_context) end 631 | 632 | ---@return nothing 633 | ---@param object_to_notify_about handle # light_userdata:object_to_notify_about 634 | function SelectionNotifyObject(object_to_notify_about) end 635 | 636 | ---@return nothing 637 | ---@param associated_context handle # light_userdata:associated_context 638 | function SelectionNotifyEnd(associated_context) end 639 | 640 | ---@return integer # amount of multi-patch fixtures created 641 | ---@param array_of_fixture_handles table 642 | ---@param count integer 643 | ---@param undo_text? string 644 | function CreateMultiPatch(array_of_fixture_handles, count, undo_text) end 645 | 646 | 647 | ---@return handle # global_variables 648 | function GlobalVars() end 649 | 650 | ---@return handle # user_variables 651 | function UserVars() end 652 | 653 | ---@return handle # plugin_preferences 654 | ---@param plugin_name? string # [string:plugin_name] 655 | function PluginVars(plugin_name) end 656 | 657 | ---@return handle # addon_variables 658 | ---@param addon_name string # string:addon_name 659 | function AddonVars(addon_name) end 660 | 661 | ---@return boolean # success 662 | ---@param variables handle # light_userdata:variables, string:varname, value 663 | ---@param varname string 664 | ---@param value string|integer|float 665 | function SetVar(variables, varname, value) end 666 | 667 | ---@return value 668 | ---@param variables handle # light_userdata:variables, string:varname 669 | ---@param varname string 670 | function GetVar(variables, varname) end 671 | 672 | ---@return boolean # success 673 | ---@param variables handle # light_userdata:variables, string:varname 674 | ---@param varname string 675 | function DelVar(variables, varname) end 676 | 677 | ---@return boolean # success, string # result text 678 | ---@param expectations table # table:expectations 679 | function TestPlaybackOutput(expectations) end 680 | 681 | ---@return boolean # success, string # result text 682 | ---@param expectations table # table:expectations 683 | function TestPlaybackOutputSteps(expectations) end 684 | 685 | ---@return table | boolean, result #table with results | boolean:false, string:result text 686 | ---@param sampling_points table 687 | function SampleOutput(sampling_points) end 688 | 689 | ---@return table # table of {string:function_name, string:arguments, string:return_values} 690 | function GetApiDescriptor() end 691 | 692 | ---@return table # table of {string:function_name, string:arguments, string:return_values} 693 | function GetObjApiDescriptor() end 694 | 695 | ---@return integer # internal_line_number 696 | function GetTextScreenLine(nothing) end 697 | 698 | ---@return integer # internal_line_count 699 | ---@param starting_internal_line_number integer 700 | function GetTextScreenLineCount(starting_internal_line_number) end 701 | 702 | ---@return float # fps 703 | function GetDebugFPS() end 704 | 705 | ---@return integer # current_value_in_percent 706 | ---@param type string 707 | ---|"'MEMORY'" 708 | ---|"'CPU'" 709 | ---|"'CPUTEMP'" 710 | ---|"'GPUTEMP'" 711 | ---|"'SYSTEMP'" 712 | ---|"'FANRPM'" 713 | function GetSample(type) end 714 | 715 | -- {handle to DMX mode, amount [,undo][,parent][,insert_index][,idtype][,cid][,fid][,name][,layer][,class][,patch:{array 1..8: string address}]} 716 | ---@return true|nil # true on success or nil 717 | ---@param handle_to_DMX_mode handle 718 | ---@param amount integer 719 | ---@param undo? string 720 | ---@param parent? handle 721 | ---@param insert_index? integer 722 | ---@param idtype? string 723 | ---@param cid? string 724 | ---@param fid? string 725 | ---@param name? string 726 | ---@param layer? string 727 | ---@param class? string 728 | ---@param patch? table # {array 1..8: string address} 729 | function AddFixtures(handle_to_DMX_mode, amount, undo, parent, insert_index, idtype, cid, fid, name, layer, class, patch) end 730 | 731 | ---@return boolean # result 732 | ---@param class_name string # string:class_name 733 | function ClassExists(class_name) end 734 | 735 | ---@return boolean # result 736 | ---@param derived_name string # string:derived_name, string:base_name 737 | ---@param base_name string 738 | function IsClassDerivedFrom(derived_name, base_name) end 739 | 740 | ---@return integer|nil # result or nothing 741 | ---@param class_name string # string:class_name 742 | function GetClassDerivationLevel(class_name) end 743 | 744 | ---@return string # value 745 | ---@param title? string # [string:title[, string:value[, integer:x[, integer:y]]]] 746 | ---@param value? string 747 | ---@param x? integer 748 | ---@param y? integer 749 | function TextInput(title, value, x, y) end 750 | 751 | ---@return integer # selected_index 752 | ---@return string # selected_value 753 | ---@param popUpTable table # {title:str, caller:handle, items:table:{{'str'|'int'|'lua'|'handle', name, type-dependent}...}, selectedValue:str, x:int, y:int, target:handle, render_options:{left_icon, number, right_icon}, useTopLeft:bool, properties:{prop:value}, add_args:{FilterSupport='Yes'/'No'}} 754 | function PopupInput(popUpTable) end 755 | 756 | ---@return boolean # result 757 | ---@param title string # [string:title [,string:message [,integer:display_index [,boolean:showCancel]]]] 758 | ---@param message? string 759 | ---@param display_index? integer 760 | ---@param showCancel? boolean 761 | function Confirm(title,message, display_index, showCancel) end 762 | 763 | ---@return handle # display_handle 764 | ---@param display_index integer # integer:display_index 765 | function GetDisplayByIndex(display_index) end 766 | 767 | ---@return integer # wingID 768 | ---@return boolean # isExtension 769 | function GetRemoteVideoInfo() end 770 | 771 | ---@return handle|nil # handle to UI object or nil 772 | ---@param display_index integer 773 | ---@param position table # {x=integer:x_position,y=integer:y_position} 774 | function GetUIObjectAtPosition(display_index, position) end 775 | 776 | ---@return nothing 777 | ---@param display_index integer 778 | ---@param position table # {x=integer:x_position,y=integer:y_position}, integer:duration in ms) 779 | function DrawPointer(display_index, position) end 780 | 781 | ---@return boolean # true on success, nil on timeout 782 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject[, number:seconds to wait] 783 | ---@param seconds_to_wait? number 784 | function WaitObjectDelete(handle_to_UIObject, seconds_to_wait) end 785 | 786 | ---@return handle # display_handle 787 | function GetFocus() end 788 | 789 | ---@return handle # display_handle 790 | function GetFocusDisplay() end 791 | 792 | ---@return handle to DisplayCollect 793 | function GetDisplayCollect() end 794 | 795 | ---@return nothing 796 | ---@param handle? handle # [light_userdata:handle] 797 | function FindBestFocus(handle) end 798 | 799 | ---@return nothing 800 | ---@param backwards? boolean # [bool:backwards(false)[, int(Focus::Reason):reason(UserTabKey)]] 801 | function FindNextFocus(backwards) end 802 | 803 | ---@return nothing 804 | function CloseAllOverlays() end 805 | 806 | ---@return handle # to top modal overlay 807 | function GetTopModal() end 808 | 809 | ---@return handle # to top overlay on the display 810 | ---@param display_index integer # integer:display_index 811 | function GetTopOverlay(display_index) end 812 | 813 | ---@return handle|nil # to modal overlay or nil on failure(timeout) 814 | ---@param seconds_to_wait? number # [number:seconds to wait] 815 | function WaitModal(seconds_to_wait) end 816 | 817 | ---@return nothing 818 | ---@param block boolean # boolean:block 819 | function SetBlockInput(block) end 820 | 821 | ---@return handle to texture found 822 | ---@param texture_name string # string:texture name 823 | function FindTexture(texture_name) end 824 | 825 | ---@return handle 826 | ---@param handle_to_ScreenConfig handle # light_userdata:handle to ScreenConfig 827 | function GetScreenContent(handle_to_ScreenConfig) end 828 | 829 | ---@class MBTable table # The input to the function must be formatted as a table using key-value pairs. The needed elements have default values that will be used if not overwritten. The values can be defined in any order if the key is defined. 830 | ---@field title? string # This is the title of the pop-up message box. 831 | ---@field backColor? string # This is the color of the frame or border of the pop-up. The value is a number or string that refers to the UI Colors in the color theme 832 | ---@field timeout? integer # The timeout value is an integer that indicates how long the message box is displayed in milliseconds. It will show a countdown timer at the top of the message area 833 | ---@field timeoutResultCancel? boolean # This element can change the return to mimic a cancel of the pop-up, which returns a false instead of a true for the success element 834 | ---@field timeoutResultID? integer # When the timeout closes the pop-up with the success value = true, a special return result can be defined 835 | ---@field icon? string # This is an icon that can be shown in the upper left corner of the pop-up. The value can be an integer or a string that refers to the number or name of a texture image 836 | ---@field titleTextColor? string # This is the text color for the title text. The value is a number or string that refers to the UI Colors in the color theme. 837 | ---@field messageTextColor? string # This is the text color for the message text. The value is a number or string that refers to the UI Colors in the color theme 838 | ---@field autoCloseOnInput? boolean # When set to true (default) the message box will close when pressing Please. If set to false, pressing Please will set the focus to the next text input when the focus is already in a text input 839 | ---@field message? string # This message text string is displayed in the main part of the pop-up. A new line can be created by adding a "\n" in the text 840 | ---@field message_align_h? integer # (Enums.AlignmentH) 841 | ---@field message_align_v? integer# (Enums.AlignmentV) 842 | ---@field display? integer|lightuserdata # where to locate the MessageBox 843 | ---@field commands_value? integer # This integer value will be returned as the result value 844 | ---@field commands_name? string # This is a string which will be shown on the button 845 | ---@field commands_order? integer # To define the order, the parameter order needs to be added with an integer value 846 | ---@field inputs_name? string # the text will be shown as a label for the input field 847 | ---@field inputs_value? string # default input value for the input field 848 | ---@field inputs_blackFilter? string # defines input characters that are not allowed 849 | ---@field inputs_whiteFilter? string # defines which input characters are allowed 850 | ---@field inputs_vkPlugin? string # name of the input pop-up, which is opened if the on-screen keyboard icon is tapped 851 | ---@field inputs_maxTextLength? integer # defines the maximum number of characters for the input 852 | ---@field inputs_order? integer # To define the order, the parameter order needs to be added with an integer value 853 | ---@field states_name? string # the text will be shown on the button 854 | ---@field states_state? boolean # the initial state of the button checkbox 855 | ---@field states_order? integer # To define the order, the parameter order needs to be added with an integer value 856 | ---@field selectors_name? string # the text will be shown on the button (swipe button) or as a label above the buttons (radio buttons) 857 | ---@field selectors_selectedValue? integer # defines the default selected value 858 | ---@field selectors_values? table # a table containing the different values available for the selector button. Each value element in the table has the following structure: ["string"]=integer The string is the name displayed for the value. The integer is the value returned and the one used for selectedValue 859 | ---@field selectors_type? integer # 0-swipe, 1-radio 860 | ---@field selectors_order? integer # To define the order, the parameter order needs to be added with an integer value 861 | 862 | ---@param mbTable MBTable 863 | ---@return table # {boolean:success, integer:result, inputs:{array of [string:name] = string:value}, states:{array of [string:name] = boolean:state}, selectors:{array of [string:name] = integer:selected-value}} 864 | function MessageBox(mbTable) end 865 | 866 | ---@return boolean 867 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 868 | function FSExtendedModeHasDots(handle_to_UIGrid) end 869 | 870 | 871 | 872 | --Object-Free API 873 | 874 | ---@return string # address 875 | ---@param handle handle # light_userdata:handle,boolean:with_name 876 | ---@param with_name boolean 877 | ---@param use_visible_addr? boolean 878 | function ToAddr(handle, with_name, use_visible_addr) end 879 | 880 | ---@return string # information 881 | ---@param handle handle # light_userdata:handle 882 | function Dump(handle) end 883 | 884 | ---@return string # numeric_root_address 885 | ---@param handle handle # light_userdata:handle[, light_userdata:base_handle[, boolean:force_parent-based_address[, boolean:force_commandline_index-based_address]]] 886 | ---@param base_handle? handle 887 | ---@param force_parent_based_address? boolean 888 | ---@param force_commandline_index_based_address? boolean 889 | function Addr(handle, base_handle, force_parent_based_address, force_commandline_index_based_address) end 890 | 891 | ---@return string # numeric_root_address 892 | ---@param handle handle # light_userdata:handle, light_userdata:base_handle[, boolean:escape_names]] 893 | ---@param base_handle? handle 894 | ---@param escape_names? boolean 895 | function AddrNative(handle, base_handle, escape_names) end 896 | 897 | ---@return integer # index 898 | ---@param handle handle # light_userdata:handle 899 | function Index(handle) end 900 | 901 | ---@return handle # parent_handle 902 | ---@param handle handle # light_userdata:handle 903 | function Parent(handle) end 904 | 905 | ---@return integer # child_count 906 | ---@param handle handle # light_userdata:handle 907 | function Count(handle) end 908 | 909 | ---@return integer # child_count 910 | ---@param handle handle # light_userdata:handle 911 | function MaxCount(handle) end 912 | 913 | ---@return boolean # is_equal, string # what_differs 914 | ---@param handle_x handle # light_userdata:handle, light_userdata:handle 915 | ---@param handle_y handle 916 | function Compare(handle_x, handle_y) end 917 | 918 | ---@return nothing 919 | ---@param handle handle # light_userdata:handle, integer:size 920 | ---@param size integer 921 | function Resize(handle, size) end 922 | 923 | ---@return handle # child_handle 924 | ---@param handle handle # light_userdata:handle, integer:index(1-based) 925 | ---@param index integer 926 | function Ptr(handle, index) end 927 | 928 | ---@return handle # child_handle 929 | ---@param handle handle # light_userdata:handle, integer:index(1-based) 930 | ---@param index integer 931 | function CmdlinePtr(handle, index) end 932 | 933 | ---@return table # {handle:child_handles} 934 | ---@param handle handle # light_userdata:handle 935 | function Children(handle) end 936 | 937 | ---@return table # {handle:child_handles} 938 | ---@param handle handle # light_userdata:handle 939 | function CmdlineChildren(handle) end 940 | 941 | ---@return handle # current_child or nothing 942 | ---@param handle handle # light_userdata:handle 943 | function CurrentChild(handle) end 944 | 945 | ---@return handle # child_handle 946 | ---@param handle handle # light_userdata:handle, integer:child_index(1-based)[, string:class[, light_userdata:undo]] 947 | ---@param child_index? integer 948 | ---@param class? string 949 | ---@param undo? handle 950 | function Create(handle, child_index, class, undo) end 951 | 952 | ---@return handle # child_handle 953 | ---@param handle handle # light_userdata:handle[, string:class[, light_userdata:undo[, integer:count]]] 954 | ---@param class? string 955 | ---@param undo? handle 956 | ---@param count? integer 957 | function Append(handle, class, undo, count) end 958 | 959 | ---@return handle # child_handle 960 | ---@param handle handle # light_userdata:handle[, string:class[, light_userdata:undo]] 961 | ---@param class? string 962 | ---@param undo? handle 963 | function Acquire(handle, class, undo) end 964 | 965 | ---@deprecated # use : Acquire 966 | ---@return handle # child_handle 967 | ---@param handle handle # light_userdata:handle[, string:class[, light_userdata:undo]] 968 | ---@param class? string 969 | ---@param undo? handle 970 | function Aquire(handle, class, undo) end 971 | 972 | ---@return nothing 973 | ---@param handle handle # light_userdata:handle, integer:child_index(1-based)[, light_userdata:undo] 974 | ---@param child_index? integer 975 | ---@param undo? handle 976 | function Delete(handle, child_index, undo) end 977 | 978 | ---@return handle # child_handle 979 | ---@param handle handle # light_userdata:handle, integer:child_index(1-based)[, string:class[, light_userdata:undo[, integer:count]]] 980 | ---@param child_index? integer 981 | ---@param class? string 982 | ---@param undo? handle 983 | ---@param count? integer 984 | function Insert(handle, child_index, class, undo, count) end 985 | 986 | ---@return nothing 987 | ---@param handle handle # light_userdata:handle, integer:child_index(1-based)[, light_userdata:undo] 988 | ---@param child_index? integer 989 | ---@param undo? handle 990 | function Remove(handle, child_index, undo) end 991 | 992 | ---@return nothing 993 | ---@param dst_handle handle # light_userdata:dst_handle, light_userdata:src_handle[, light_userdata:undo] 994 | ---@param src_handle? handle 995 | ---@param undo? handle 996 | function Copy(dst_handle, src_handle, undo) end 997 | 998 | ---@return nothing 999 | ---@param handle handle # light_userdata:handle, handle:object_to_check 1000 | ---@param object_to_check handle 1001 | function HasParent(handle, object_to_check) end 1002 | 1003 | ---@return nothing 1004 | ---@param handle handle # light_userdata:handle, string:change_level_enum_name 1005 | ---@param change_level_enum_name string 1006 | function Changed(handle, change_level_enum_name) end 1007 | 1008 | ---@return boolean # object_is_empty 1009 | ---@param handle handle # light_userdata:handle 1010 | function IsEmpty(handle) end 1011 | 1012 | ---@return boolean # object_is_locked 1013 | ---@param handle handle # light_userdata:handle 1014 | function IsLocked(handle) end 1015 | 1016 | ---@return nothing 1017 | ---@param handle handle # light_userdata:handle 1018 | function PrepareAccess(handle) end 1019 | 1020 | ---@return nothing 1021 | ---@param handle handle # light_userdata:handle, string:property_name, string:property_value[, integer:override_change_level(Enums.ChangeLevel)] 1022 | ---@param property_name string 1023 | ---@param property_value? string 1024 | ---@param override_change_level? integer 1025 | function Set(handle, property_name, property_value, override_change_level) end 1026 | 1027 | ---@return nothing 1028 | ---@param handle_of_parent handle # light_userdata:handle_of_parent, string:property_name, string:property_value[, boolean:recursive (default: false)] 1029 | ---@param property_name string 1030 | ---@param property_value? string 1031 | ---@param recursive? boolean 1032 | function SetChildren(handle_of_parent, property_name, property_value, recursive) end 1033 | 1034 | ---@return nothing 1035 | ---@param handle_of_parent handle # light_userdata:handle_of_parent, string:property_name, string:property_value[, boolean:recursive (default: false)] 1036 | ---@param property_name string 1037 | ---@param property_value? string 1038 | ---@param recursive? boolean 1039 | function SetChildrenRecursive(handle_of_parent, property_name, property_value, recursive) end 1040 | 1041 | ---@return handle|string # child or string # property (if 'role' provided - always string) 1042 | ---@param handle handle # light_userdata:handle, string:property_name[, integer:role(Enums.Roles)] 1043 | ---@param property_name string 1044 | ---@param role? integer 1045 | function Get(handle, property_name, role) end 1046 | 1047 | ---@return integer # property_count 1048 | ---@param handle handle # light_userdata:handle 1049 | function PropertyCount(handle) end 1050 | 1051 | ---@return string # property_name 1052 | ---@param handle handle # light_userdata:handle, integer:property_index 1053 | ---@param property_index integer 1054 | function PropertyName(handle, property_index) end 1055 | 1056 | ---@return string # property_type 1057 | ---@param handle handle # light_userdata:handle, integer:property_index 1058 | ---@param property_index integer 1059 | function PropertyType(handle, property_index) end 1060 | 1061 | ---@return table # {'ReadOnly'=boolean:read_only_flag, 'ExportIgnore'=boolean:export_ignore_flag, 'ImportIgnore'=boolean:import_ignore_flag, 'EnumCollection'=string:enum_collection_name} 1062 | ---@param handle handle # light_userdata:handle, integer:property_index 1063 | ---@param property_index integer 1064 | function PropertyInfo(handle, property_index) end 1065 | 1066 | ---@return boolean # result 1067 | ---@param handle handle # light_userdata:handle 1068 | function IsValid(handle) end 1069 | 1070 | ---@return boolean # result 1071 | ---@param handle handle # light_userdata:handle 1072 | function IsClass(handle) end 1073 | 1074 | ---@return string # class_name 1075 | ---@param handle handle # light_userdata:handle 1076 | function GetClass(handle) end 1077 | 1078 | ---@return string # class_name 1079 | ---@param handle handle # light_userdata:handle 1080 | function GetChildClass(handle) end 1081 | 1082 | ---@return handle 1083 | ---@param handle handle # light_userdata:handle 1084 | function GetAssignedObj(handle) end 1085 | 1086 | ---@return boolean # result 1087 | ---@param handle handle # light_userdata:handle 1088 | function HasEditSettingUI(handle) end 1089 | 1090 | ---@return boolean # result 1091 | ---@param handle handle # light_userdata:handle 1092 | function HasEditUI(handle) end 1093 | 1094 | ---@return string # ui_editor_name 1095 | ---@param handle handle # light_userdata:handle 1096 | function GetUIEditor(handle) end 1097 | 1098 | ---@return string # ui_settings_name 1099 | ---@param handle handle # light_userdata:handle 1100 | function GetUISettings(handle) end 1101 | 1102 | ---@return handle # found_handle 1103 | ---@param search_start_handle handle # light_userdata:search_start_handle, string:search_class_name 1104 | ---@param search_class_name string 1105 | function FindParent(search_start_handle, search_class_name) end 1106 | 1107 | ---@return handle # found_handle 1108 | ---@param search_start_handle handle # light_userdata:search_start_handle, string:search_name[, string:search_class_name] 1109 | ---@param search_name? string 1110 | ---@param search_class_name? string 1111 | function Find(search_start_handle, search_name, search_class_name) end 1112 | 1113 | ---@return handle # found_handle 1114 | ---@param search_start_handle handle # light_userdata:search_start_handle, string:search_name[, string:search_class_name] 1115 | ---@param search_name? string 1116 | ---@param search_class_name? string 1117 | function FindRecursive(search_start_handle, search_name, search_class_name) end 1118 | 1119 | ---@return handle # found_handle 1120 | ---@param search_start_handle handle # light_userdata:search_start_handle, string:search_name 1121 | ---@param search_name string 1122 | function FindWild(search_start_handle, search_name) end 1123 | 1124 | ---@return boolean # success 1125 | ---@param handle handle # light_userdata:handle, string:file_path, string:file_name 1126 | ---@param file_path string 1127 | ---@param file_name string 1128 | function Import(handle, file_path, file_name) end 1129 | 1130 | ---@return boolean # success 1131 | ---@param handle handle # light_userdata:handle, string:file_path, string:file_name 1132 | ---@param file_path string 1133 | ---@param file_name string 1134 | function Export(handle, file_path, file_name) end 1135 | 1136 | ---@return string # file_name 1137 | ---@param handle handle # light_userdata:handle[, boolean:camel_case_to_file_name] 1138 | ---@param camel_case_to_file_name? boolean 1139 | function GetExportFileName(handle, camel_case_to_file_name) end 1140 | 1141 | ---@return boolean # success 1142 | ---@param handle handle # light_userdata:handle, string:file_path, string:file_name 1143 | ---@param file_path string 1144 | ---@param file_name string 1145 | function Load(handle, file_path, file_name) end 1146 | 1147 | ---@return boolean # success 1148 | ---@param handle handle # light_userdata:handle, string:file_path, string:file_name 1149 | ---@param file_path string 1150 | ---@param file_name string 1151 | function Save(handle, file_path, file_name) end 1152 | 1153 | ---@return nothing 1154 | ---@param handle handle # light_userdata:handle, light_userdata:dest_handle, boolean:focus_search_allowed(default:true) 1155 | ---@param dest_handle handle 1156 | ---@param focus_search_allowed boolean 1157 | function CommandCall(handle, dest_handle, focus_search_allowed) end 1158 | 1159 | ---@return nothing 1160 | ---@param handle handle # light_userdata:handle 1161 | function CommandAt(handle) end 1162 | 1163 | ---@return nothing 1164 | ---@param handle handle # light_userdata:handle 1165 | function CommandDelete(handle) end 1166 | 1167 | ---@return nothing 1168 | ---@param handle handle # light_userdata:handle 1169 | function CommandStore(handle) end 1170 | 1171 | ---@return nothing 1172 | ---@param handle handle # light_userdata:handle 1173 | function CommandCreateDefaults(handle) end 1174 | 1175 | ---@return nothing 1176 | ---@param handle handle # light_userdata:handle, {[float:value[0..100]], [boolean:faderEnabled], [string:token(Fader*)]} 1177 | ---@param value? table 1178 | function SetFader(handle, value) end 1179 | 1180 | ---@return float # value[0..100] 1181 | ---@param handle handle # light_userdata:handle, {[string:token(Fader*)], [integer:index]} 1182 | ---@param token? table 1183 | function GetFader(handle, token) end 1184 | 1185 | ---@return string # text 1186 | ---@param handle handle # light_userdata:handle, {[string:token(Fader*)], [integer:index]} 1187 | ---@param token? table 1188 | function GetFaderText(handle, token) end 1189 | 1190 | ---@return integer # count 1191 | ---@param handle handle # light_userdata:handle 1192 | function GetLineCount(handle) end 1193 | 1194 | ---@return string # line_content 1195 | ---@param handle handle # light_userdata:handle, integer:line_number 1196 | ---@param line_number integer 1197 | function GetLineAt(handle, line_number) end 1198 | 1199 | ---@return boolean # result 1200 | ---@param handle handle # light_userdata:handle 1201 | function HasActivePlayback(handle) end 1202 | 1203 | ---@return boolean # result 1204 | ---@param handle handle # light_userdata:handle 1205 | function HasReferences(handle) end 1206 | 1207 | ---@return boolean # result 1208 | ---@param handle handle # light_userdata:handle 1209 | function HasDependencies(handle) end 1210 | 1211 | ---@return table # {handle:handle} 1212 | ---@param handle handle # light_userdata:handle 1213 | function GetReferences(handle) end 1214 | 1215 | ---@return table # {handle:handle} 1216 | ---@param handle handle # light_userdata:handle 1217 | function GetDependencies(handle) end 1218 | 1219 | ---@return nothing 1220 | ---@param handle handle # light_userdata:handle, string:name_value 1221 | ---@param name_value string 1222 | function InputSetTitle(handle, name_value) end 1223 | 1224 | ---@return nothing 1225 | ---@param handle handle # light_userdata:handle, string:value 1226 | ---@param value string 1227 | function InputSetValue(handle, value) end 1228 | 1229 | ---@return nothing 1230 | ---@param handle handle # light_userdata:handle, string:name_value 1231 | ---@param name_value string 1232 | function InputSetEditTitle(handle, name_value) end 1233 | 1234 | ---@return nothing 1235 | ---@param handle handle # light_userdata:handle, string:parameter name, string:parameter value 1236 | ---@param parameter_name string 1237 | ---@param parameter_value string 1238 | function InputSetAdditionalParameter(handle, parameter_name, parameter_value) end 1239 | 1240 | ---@return nothing 1241 | ---@param handle handle # light_userdata:handle 1242 | function InputRun(handle) end 1243 | 1244 | ---@return any 1245 | ---@param handle handle # light_userdata:handle, string:function name[, ...parameters to function] 1246 | ---@param function_name? string 1247 | function InputCallFunction(handle, function_name) end 1248 | 1249 | ---@return true or nil 1250 | ---@param handle handle # light_userdata:handle, string:function name 1251 | ---@param function_name string 1252 | function InputHasFunction(handle, function_name) end 1253 | 1254 | ---@return nothing 1255 | ---@param handle handle # light_userdata:handle, integer:length 1256 | ---@param length integer 1257 | function InputSetMaxLength(handle, length) end 1258 | 1259 | ---@return nothing 1260 | ---@param handle handle # light_userdata:handle, string:name, string:value[, {[left={...}][right={...}]}:appearance] 1261 | ---@param name string 1262 | ---@param value? string 1263 | ---@param appearance? table 1264 | function AddListStringItem(handle, name, value, appearance) end 1265 | 1266 | ---@return nothing 1267 | ---@param handle handle # light_userdata:handle, string:name, string:value, light_userdata:target handle[,{[left={...}][right={...}]}:appearance] 1268 | ---@param name string 1269 | ---@param value string 1270 | ---@param target_handle? handle 1271 | ---@param appearance? table 1272 | function AddListPropertyItem(handle, name, value, target_handle, appearance) end 1273 | 1274 | ---@return nothing 1275 | ---@param handle handle # light_userdata:handle, string:name, number:value[,light_userdata:base handle[, {[left={...}][right={...}]}:appearance]] 1276 | ---@param name string 1277 | ---@param value? number 1278 | ---@param base_handle? handle 1279 | ---@param appearance? table 1280 | function AddListNumericItem(handle, name, value, base_handle, appearance) end 1281 | 1282 | ---@return nothing 1283 | ---@param handle handle # light_userdata:handle, string:name, string:value/function name, lua_function:callback reference[, :argument to pass to callback[, {[left={...}][right={...}]}:appearance]] 1284 | ---@param name string 1285 | ---@param value_or_function_name string 1286 | ---@param callback_reference? string 1287 | ---@param argument_to_pass_to_callback? string 1288 | function AddListLuaItem(handle, name, value_or_function_name, callback_reference, argument_to_pass_to_callback) end 1289 | 1290 | ---@return nothing 1291 | ---@param handle handle # (light_userdata:handle, light_userdata:target object[, (string: explicit name[, {[boolean:appearance],[left={...}][right={...}]}:appearance] | enum{Roles}: role [, :boolean: extended_name[, {[left={...}][right={...}]}:appearance]])]) 1292 | ---@param target_object handle 1293 | ---@param explicit_name? string 1294 | ---@param appearance? table 1295 | function AddListObjectItem(handle, target_object, explicit_name, appearance) end 1296 | 1297 | ---@return nothing 1298 | ---@param handle handle # light_userdata:handle, table{item={[1]=name, [2]=value}, ...} 1299 | function AddListStringItems(handle) end 1300 | 1301 | ---@return nothing 1302 | ---@param handle handle # light_userdata:handle, table{item={[1]=name, [2]=property name, [3]=target handle}, ...} 1303 | function AddListPropertyItems(handle) end 1304 | 1305 | ---@return nothing 1306 | ---@param handle handle # light_userdata:handle, table{item={[1]=name, [2]=integer:value}, ...} 1307 | function AddListNumericItems(handle) end 1308 | 1309 | ---@return nothing 1310 | ---@param handle handle # light_userdata:handle, table{item={[1]=name, [2]=value/function name, [3]=callback reference[, [4]=argument of any lua type to pass to callback]}, ...} 1311 | function AddListLuaItems(handle) end 1312 | 1313 | ---@return nothing 1314 | ---@param handle handle # light_userdata:handle, light_userdata:parent[, enum{Roles}:role] 1315 | ---@param parent? handle 1316 | ---@param role? table 1317 | function AddListChildren(handle, parent, role) end 1318 | 1319 | ---@return nothing 1320 | ---@param handle handle # light_userdata:handle, light_userdata:parent[, enum{Roles}:role] 1321 | ---@param parent? handle 1322 | ---@param role? table 1323 | function AddListChildrenNames(handle, parent, role) end 1324 | 1325 | ---@return nothing 1326 | ---@param handle handle # light_userdata:handle, light_userdata:parent[, enum{Roles}:role] 1327 | ---@param parent? handle 1328 | ---@param role? table 1329 | function AddListRecursiveNames(handle, parent, role) end 1330 | 1331 | ---@return nothing 1332 | ---@param handle handle # light_userdata:handle, string:name 1333 | ---@param name string 1334 | function RemoveListItem(handle, name) end 1335 | 1336 | ---@return nothing 1337 | ---@param handle handle # light_userdata:handle 1338 | function ClearList(handle) end 1339 | 1340 | ---@return nothing 1341 | ---@param handle handle # light_userdata:handle, string:name_value 1342 | ---@param name_value string 1343 | function SelectListItemByName(handle, name_value) end 1344 | 1345 | ---@return nothing 1346 | ---@param handle handle # light_userdata:handle, string:value 1347 | ---@param value string 1348 | function SelectListItemByValue(handle, value) end 1349 | 1350 | ---@return nothing 1351 | ---@param handle handle # light_userdata:handle, integer:index(1-based) 1352 | ---@param index integer 1353 | function SelectListItemByIndex(handle, index) end 1354 | 1355 | ---@return nothing 1356 | ---@param handle handle # light_userdata:handle, integer:index 1357 | ---@param index integer 1358 | function IsListItemEnabled(handle, index) end 1359 | 1360 | ---@return nothing 1361 | ---@param handle handle # light_userdata:handle, integer:index[, bool:enable(default:true)] 1362 | ---@param index? integer 1363 | ---@param enable? boolean 1364 | function SetEnabledListItem(handle, index, enable) end 1365 | 1366 | ---@return nothing 1367 | ---@param handle handle # light_userdata:handle, integer:index 1368 | ---@param index integer 1369 | function IsListItemEmpty(handle, index) end 1370 | 1371 | ---@return nothing 1372 | ---@param handle handle # light_userdata:handle, integer:index[, bool:empty(default:true)] 1373 | ---@param index? integer 1374 | ---@param empty? boolean 1375 | function SetEmptyListItem(handle, index, empty) end 1376 | 1377 | ---@return string # value 1378 | ---@param handle handle # light_userdata:handle, integer:index 1379 | ---@param index integer 1380 | function GetListItemValueStr(handle, index) end 1381 | 1382 | ---@return nothing 1383 | ---@param handle handle # light_userdata:handle, integer:index, string:value 1384 | ---@param index integer 1385 | ---@param value string 1386 | function SetListItemValueStr(handle, index, value) end 1387 | 1388 | ---@return integer # value 1389 | ---@param handle handle # light_userdata:handle, integer:index 1390 | ---@param index integer 1391 | function GetListItemValueI64(handle, index) end 1392 | 1393 | ---@return string # name 1394 | ---@param handle handle # light_userdata:handle, integer:index 1395 | ---@param index integer 1396 | function GetListItemName(handle, index) end 1397 | 1398 | ---@return nothing 1399 | ---@param handle handle # light_userdata:handle, integer:index, string:name 1400 | ---@param index integer 1401 | ---@param name string 1402 | function SetListItemName(handle, index, name) end 1403 | 1404 | ---@return table # {left={AppearanceData}, right={AppearanceData}} 1405 | ---@param handle handle # light_userdata:handle, integer:index 1406 | ---@param index integer 1407 | function GetListItemAppearance(handle, index) end 1408 | 1409 | ---@return nothing 1410 | ---@param handle handle # light_userdata:handle, integer:index, {[left={...AppearanceData...}][right={...AppearanceData...}]} 1411 | ---@param index integer 1412 | ---@param AppearanceData table 1413 | function SetListItemAppearance(handle, index, AppearanceData) end 1414 | 1415 | ---@return handle # button or nil if not visible 1416 | ---@param handle handle # light_userdata:handle, integer:index 1417 | ---@param index integer 1418 | function GetListItemButton(handle, index) end 1419 | 1420 | ---@return integer # 1-based index 1421 | ---@param handle handle # light_userdata:handle 1422 | function GetListSelectedItemIndex(handle) end 1423 | 1424 | ---@return integer # amount of items in the list 1425 | ---@param handle handle # light_userdata:handle 1426 | function GetListItemsCount(handle) end 1427 | 1428 | ---@return integer # 1-based index 1429 | ---@param handle handle # light_userdata:handle, string:value 1430 | ---@param value string 1431 | function FindListItemByValueStr(handle, value) end 1432 | 1433 | ---@return integer # 1-based index 1434 | ---@param handle handle # light_userdata:handle, string:value 1435 | ---@param value string 1436 | function FindListItemByName(handle, value) end 1437 | 1438 | ---@return handle # to GridBase 1439 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1440 | function GridGetBase(handle_to_UIGrid) end 1441 | 1442 | ---@return handle # to GridData 1443 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1444 | function GridGetData(handle_to_UIGrid) end 1445 | 1446 | ---@return handle # to GridSelection 1447 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1448 | function GridGetSelection(handle_to_UIGrid) end 1449 | 1450 | ---@return nothing 1451 | ---@generic x 1452 | ---@generic y 1453 | ---@param x `x` 1454 | ---@param y `y` 1455 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), x, y 1456 | function GridMoveSelection(handle_to_UIGrid, x, y) end 1457 | 1458 | ---@return table # array of {r, c, r_UniqueId, r_GroupId, c_UniqueId, c_GroupId} cells in the selection 1459 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1460 | function GridGetSelectedCells(handle_to_UIGrid) end 1461 | 1462 | ---@return handle to GridSettings 1463 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1464 | function GridGetSettings(handle_to_UIGrid) end 1465 | 1466 | ---@return table # {r, c} 1467 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1468 | function GridGetDimensions(handle_to_UIGrid) end 1469 | 1470 | ---@return table # {v = {index, offset}, h={index, offset}} 1471 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1472 | function GridGetScrollOffset(handle_to_UIGrid) end 1473 | 1474 | ---@return nothing 1475 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), integer: columnId, integer:size in pixels 1476 | ---@param columnId integer 1477 | ---@param size_in_pixels integer 1478 | function GridSetColumnSize(handle_to_UIGrid, columnId, size_in_pixels) end 1479 | 1480 | ---@return table # {r, c} 1481 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1482 | function GridGetScrollCell(handle_to_UIGrid) end 1483 | 1484 | ---@return table # {text, color={text, back}} 1485 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1486 | ---@param cell table 1487 | function GridGetCellData(handle_to_UIGrid, cell) end 1488 | 1489 | ---@return boolean 1490 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1491 | ---@param cell table 1492 | function GridIsCellVisible(handle_to_UIGrid, cell) end 1493 | 1494 | ---@return boolean 1495 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1496 | ---@param cell table 1497 | function GridCellExists(handle_to_UIGrid, cell) end 1498 | 1499 | ---@return boolean 1500 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1501 | ---@param cell table 1502 | function GridIsCellReadOnly(handle_to_UIGrid, cell) end 1503 | 1504 | ---@return nothing 1505 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1506 | ---@param cell table 1507 | function GridScrollCellIntoView(handle_to_UIGrid, cell) end 1508 | 1509 | ---@return table # {x, y, w, h} 1510 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1511 | ---@param cell table 1512 | function GridGetCellDimensions(handle_to_UIGrid, cell) end 1513 | 1514 | ---@return integer|nil # parent row id (integer) or nil (if there's no parent) 1515 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), integer: rowId 1516 | ---@param rowId integer 1517 | function GridGetParentRowId(handle_to_UIGrid, rowId) end 1518 | 1519 | ---@return table # {r, c} or nil 1520 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1521 | function GridsGetExpandHeaderCell(handle_to_UIGrid) end 1522 | 1523 | ---@return boolean or nil 1524 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived) 1525 | function GridsGetExpandHeaderCellState(handle_to_UIGrid) end 1526 | 1527 | ---@return integer|nil # width in pixels or nil 1528 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1529 | ---@param cell table 1530 | function GridsGetLevelButtonWidth(handle_to_UIGrid, cell) end 1531 | 1532 | ---@return integer|nil # column index or nil (if there's no such visible column) 1533 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), integer: columnId 1534 | ---@param columnId integer 1535 | function GridsGetColumnById(handle_to_UIGrid, columnId) end 1536 | 1537 | ---@return integer|nil # row index or nil (if there's no such visible row) 1538 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), integer: rowId 1539 | ---@param rowId integer 1540 | function GridsGetRowById(handle_to_UIGrid, rowId) end 1541 | 1542 | ---@return handle # overlay_handle 1543 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1544 | function GetOverlay(handle_to_UIObject) end 1545 | 1546 | ---@return handle # display_handle 1547 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1548 | function GetDisplay(handle_to_UIObject) end 1549 | 1550 | ---@return integer # display_index 1551 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1552 | function GetDisplayIndex(handle_to_UIObject) end 1553 | 1554 | ---@return handle 1555 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1556 | function GetScreen(handle_to_UIObject) end 1557 | 1558 | ---@return integer # count 1559 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1560 | function GetUIChildrenCount(handle_to_UIObject) end 1561 | 1562 | ---@return nothing 1563 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1564 | function ClearUIChildren(handle_to_UIObject) end 1565 | 1566 | ---@return handle # to UIObject 1567 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject, integer:index(1-based) 1568 | ---@param index integer 1569 | function GetUIChild(handle_to_UIObject, index) end 1570 | 1571 | ---@return table # {light_userdata:child_handles} 1572 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1573 | function UIChildren(handle_to_UIObject) end 1574 | 1575 | ---@return boolean # true on success, nil on timeout or if object doesn't exist 1576 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject[, number:seconds to wait[, bool:force to re-init, default - false]] 1577 | ---@param seconds_to_wait? number 1578 | ---@param force_to_re_init boolean 1579 | function WaitInit(handle_to_UIObject, seconds_to_wait, force_to_re_init) end 1580 | 1581 | ---@return boolean # true on success, nil on timeout or if object doesn't exist 1582 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject, integer:expected amount of children[, number:seconds to wait] 1583 | ---@param expected_amount_of_children? integer 1584 | ---@param seconds_to_wait? number 1585 | function WaitChildren(handle_to_UIObject, expected_amount_of_children, seconds_to_wait) end 1586 | 1587 | ---@return boolean # true on success, nil on failure 1588 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject, function:callback to invoke on deletion[, any:argument to pass by] 1589 | ---@param callback_to_invoke_on_deletion? function 1590 | ---@param argument_to_pass_by? any 1591 | function HookDelete(handle_to_UIObject, callback_to_invoke_on_deletion, argument_to_pass_by) end 1592 | 1593 | ---@return boolean # is visible 1594 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1595 | function IsVisible(handle_to_UIObject) end 1596 | 1597 | ---@return boolean # is enabled 1598 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject 1599 | function IsEnabled(handle_to_UIObject) end 1600 | 1601 | ---@return nothing 1602 | ---@param handle handle # light_userdata:handle, callback:function 1603 | ---@param callback function 1604 | function ShowModal(handle, callback) end 1605 | 1606 | ---@return nothing 1607 | ---@param x integer 1608 | ---@param y integer 1609 | ---@param handle handle # light_userdata:handle, integer:x, integer:y 1610 | function SetPositionHint(handle, x, y) end 1611 | 1612 | ---@return boolean # true if scroll of the requested type is needed 1613 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum) 1614 | ---@param scroll_type integer 1615 | function ScrollIsNeeded(handle, scroll_type) end 1616 | 1617 | ---@return boolean # true scroll 1618 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum), integer:scroll entity (item or area, see 'ScrollParamEntity' enum), integer:value type (absolute or relative, see 'ScrollParamValueType' enum), number: value to scroll (items - 1-based), boolean: updateOpposite side 1619 | ---@param scroll_type integer 1620 | ---@param scroll_entity_ integer 1621 | ---@param value_type_ integer 1622 | ---@param value_to_scroll number 1623 | ---@param updateOpposite_side boolean 1624 | function ScrollDo(handle, scroll_type, scroll_entity_, value_type_, value_to_scroll, updateOpposite_side) end 1625 | 1626 | ---@return table|nil # {index(1-based), offset, visibleArea, totalArea, itemsCount, itemsOnPage} or nil 1627 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum) 1628 | ---@param scroll_type integer 1629 | function ScrollGetInfo(handle, scroll_type) end 1630 | 1631 | ---@return integer|nil # size of the item of nil 1632 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum), integer:1-based item idx 1633 | ---@param scroll_type integer 1634 | ---@param one_based_item_idx integer 1635 | function ScrollGetItemSize(handle, scroll_type, one_based_item_idx) end 1636 | 1637 | ---@return integer|nil # offset of the item or nil 1638 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum), integer:1-based item idx 1639 | ---@param scroll_type integer 1640 | ---@param one_based_item_idx integer 1641 | function ScrollGetItemOffset(handle, scroll_type, one_based_item_idx) end 1642 | 1643 | ---@return integer # 1-based item index 1644 | ---@param handle handle # light_userdata:handle, integer:scroll type (see 'ScrollType' enum), integer:offset 1645 | ---@param scroll_type integer 1646 | ---@param offset integer 1647 | function ScrollGetItemByOffset(handle, scroll_type, offset) end 1648 | 1649 | ---@return nothing 1650 | ---@param handle_to_UIObject handle # light_userdata:handle to UIObject, string:topic name 1651 | ---@param topic_name string 1652 | function SetContextSensHelpLink(handle_to_UIObject, topic_name) end 1653 | 1654 | ---@return integer # size 1655 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1656 | ---@param index integer 1657 | function UILGGetColumnWidth(handle_to_UILayoutGrid, index) end 1658 | 1659 | ---@return integer # size 1660 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1661 | ---@param index integer 1662 | function UILGGetRowHeight(handle_to_UILayoutGrid, index) end 1663 | 1664 | ---@return integer # x 1665 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1666 | ---@param index integer 1667 | function UILGGetColumnAbsXLeft(handle_to_UILayoutGrid, index) end 1668 | 1669 | ---@return integer # x 1670 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1671 | ---@param index integer 1672 | function UILGGetColumnAbsXRight(handle_to_UILayoutGrid, index) end 1673 | 1674 | ---@return integer # y 1675 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1676 | ---@param index integer 1677 | function UILGGetRowAbsYTop(handle_to_UILayoutGrid, index) end 1678 | 1679 | ---@return integer # y 1680 | ---@param handle_to_UILayoutGrid handle # light_userdata:handle to UILayoutGrid, integer:index 1681 | ---@param index integer 1682 | function UILGGetRowAbsYBottom(handle_to_UILayoutGrid, index) end 1683 | 1684 | ---@return nothing 1685 | ---@param handle_to_Overlay handle # light_userdata:handle to Overlay, callbackName:string[, ctx:anything] 1686 | ---@param callbackName? string 1687 | ---@param ctx? value 1688 | function OverlaySetCloseCallback(handle_to_Overlay, callbackName, ctx) end 1689 | 1690 | ---@return boolean 1691 | ---@param handle_to_UIGrid handle # light_userdata:handle to UIGrid (or derived), {r, c}:cell 1692 | ---@param cell table 1693 | function FSExtendedModeHasDots(handle_to_UIGrid, cell) end 1694 | 1695 | --------------------------------------------------------------------------------