@defold-typescript/types 0.53.0 → 0.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli-runtime.js +8966 -0
- package/dist/identity-vocabulary.json +660 -0
- package/dist/src/index.d.ts +18 -0
- package/fixtures/defold-1.12.4/b2d_body_doc.json +1327 -0
- package/fixtures/defold-1.12.4/b2d_doc.json +107 -0
- package/fixtures/defold-1.12.4/base_doc.json +758 -0
- package/fixtures/defold-1.12.4/bit_doc.json +404 -0
- package/fixtures/defold-1.12.4/buffer_doc.json +422 -0
- package/fixtures/defold-1.12.4/camera_doc.json +664 -0
- package/fixtures/defold-1.12.4/collectionfactory_doc.json +219 -0
- package/fixtures/defold-1.12.4/collectionproxy_doc.json +289 -0
- package/fixtures/defold-1.12.4/coroutine_doc.json +151 -0
- package/fixtures/defold-1.12.4/crash_doc.json +497 -0
- package/fixtures/defold-1.12.4/debug_doc.json +410 -0
- package/fixtures/defold-1.12.4/factory_doc.json +219 -0
- package/fixtures/defold-1.12.4/font_doc.json +141 -0
- package/fixtures/defold-1.12.4/globals_doc.json +42 -0
- package/fixtures/defold-1.12.4/go-instance-functions.json +111 -0
- package/fixtures/defold-1.12.4/go_doc.json +1901 -0
- package/fixtures/defold-1.12.4/graphics_doc.json +1634 -0
- package/fixtures/defold-1.12.4/gui_doc.json +5249 -0
- package/fixtures/defold-1.12.4/html5_doc.json +64 -0
- package/fixtures/defold-1.12.4/http_doc.json +66 -0
- package/fixtures/defold-1.12.4/image_doc.json +170 -0
- package/fixtures/defold-1.12.4/io_doc.json +399 -0
- package/fixtures/defold-1.12.4/json_doc.json +97 -0
- package/fixtures/defold-1.12.4/label_doc.json +220 -0
- package/fixtures/defold-1.12.4/liveupdate_doc.json +308 -0
- package/fixtures/defold-1.12.4/math_doc.json +702 -0
- package/fixtures/defold-1.12.4/messages_doc.json +579 -0
- package/fixtures/defold-1.12.4/model_doc.json +315 -0
- package/fixtures/defold-1.12.4/msg_doc.json +137 -0
- package/fixtures/defold-1.12.4/os_doc.json +266 -0
- package/fixtures/defold-1.12.4/package_doc.json +139 -0
- package/fixtures/defold-1.12.4/particlefx_doc.json +249 -0
- package/fixtures/defold-1.12.4/physics_doc.json +1120 -0
- package/fixtures/defold-1.12.4/profiler_doc.json +375 -0
- package/fixtures/defold-1.12.4/render_doc.json +1167 -0
- package/fixtures/defold-1.12.4/resource_doc.json +762 -0
- package/fixtures/defold-1.12.4/socket_doc.json +2194 -0
- package/fixtures/defold-1.12.4/sound_doc.json +582 -0
- package/fixtures/defold-1.12.4/sprite_doc.json +245 -0
- package/fixtures/defold-1.12.4/string_doc.json +412 -0
- package/fixtures/defold-1.12.4/sys_doc.json +853 -0
- package/fixtures/defold-1.12.4/table_doc.json +166 -0
- package/fixtures/defold-1.12.4/tilemap_doc.json +374 -0
- package/fixtures/defold-1.12.4/timer_doc.json +153 -0
- package/fixtures/defold-1.12.4/types_doc.json +212 -0
- package/fixtures/defold-1.12.4/vmath_doc.json +1814 -0
- package/fixtures/defold-1.12.4/window_doc.json +388 -0
- package/fixtures/defold-1.12.4/zlib_doc.json +70 -0
- package/fixtures/defold-1.13.0/b2d_body_doc.json +2428 -0
- package/fixtures/defold-1.13.0/b2d_chain_doc.json +394 -0
- package/fixtures/defold-1.13.0/b2d_doc.json +128 -0
- package/fixtures/defold-1.13.0/b2d_fixture_doc.json +594 -0
- package/fixtures/defold-1.13.0/b2d_joint_doc.json +3315 -0
- package/fixtures/defold-1.13.0/b2d_shape_doc.json +802 -0
- package/fixtures/defold-1.13.0/b2d_world_doc.json +1314 -0
- package/fixtures/defold-1.13.0/base_doc.json +758 -0
- package/fixtures/defold-1.13.0/bit_doc.json +404 -0
- package/fixtures/defold-1.13.0/buffer_doc.json +422 -0
- package/fixtures/defold-1.13.0/camera_doc.json +900 -0
- package/fixtures/defold-1.13.0/collectionfactory_doc.json +219 -0
- package/fixtures/defold-1.13.0/collectionproxy_doc.json +289 -0
- package/fixtures/defold-1.13.0/compute_doc.json +182 -0
- package/fixtures/defold-1.13.0/coroutine_doc.json +151 -0
- package/fixtures/defold-1.13.0/crash_doc.json +497 -0
- package/fixtures/defold-1.13.0/debug_doc.json +410 -0
- package/fixtures/defold-1.13.0/editor_doc.json +3665 -0
- package/fixtures/defold-1.13.0/editor_http_doc.json +273 -0
- package/fixtures/defold-1.13.0/editor_json_doc.json +59 -0
- package/fixtures/defold-1.13.0/editor_localization_doc.json +138 -0
- package/fixtures/defold-1.13.0/editor_pprint_doc.json +36 -0
- package/fixtures/defold-1.13.0/editor_tilemap_tiles_doc.json +235 -0
- package/fixtures/defold-1.13.0/editor_zip_doc.json +163 -0
- package/fixtures/defold-1.13.0/editor_zlib_doc.json +48 -0
- package/fixtures/defold-1.13.0/factory_doc.json +219 -0
- package/fixtures/defold-1.13.0/font_doc.json +141 -0
- package/fixtures/defold-1.13.0/globals_doc.json +42 -0
- package/fixtures/defold-1.13.0/go-instance-functions.json +101 -0
- package/fixtures/defold-1.13.0/go_doc.json +1989 -0
- package/fixtures/defold-1.13.0/graphics_doc.json +1886 -0
- package/fixtures/defold-1.13.0/gui_doc.json +5277 -0
- package/fixtures/defold-1.13.0/html5_doc.json +64 -0
- package/fixtures/defold-1.13.0/http_doc.json +66 -0
- package/fixtures/defold-1.13.0/image_doc.json +170 -0
- package/fixtures/defold-1.13.0/import-manifest.json +10558 -0
- package/fixtures/defold-1.13.0/io_doc.json +399 -0
- package/fixtures/defold-1.13.0/json_doc.json +97 -0
- package/fixtures/defold-1.13.0/label_doc.json +220 -0
- package/fixtures/defold-1.13.0/liveupdate_doc.json +330 -0
- package/fixtures/defold-1.13.0/material_doc.json +238 -0
- package/fixtures/defold-1.13.0/math_doc.json +702 -0
- package/fixtures/defold-1.13.0/model_doc.json +412 -0
- package/fixtures/defold-1.13.0/msg_doc.json +137 -0
- package/fixtures/defold-1.13.0/os_doc.json +266 -0
- package/fixtures/defold-1.13.0/package_doc.json +139 -0
- package/fixtures/defold-1.13.0/particlefx_doc.json +249 -0
- package/fixtures/defold-1.13.0/physics_doc.json +1492 -0
- package/fixtures/defold-1.13.0/profiler_doc.json +375 -0
- package/fixtures/defold-1.13.0/render_doc.json +1381 -0
- package/fixtures/defold-1.13.0/resource_doc.json +762 -0
- package/fixtures/defold-1.13.0/socket_doc.json +2194 -0
- package/fixtures/defold-1.13.0/sound_doc.json +582 -0
- package/fixtures/defold-1.13.0/sprite_doc.json +335 -0
- package/fixtures/defold-1.13.0/string_doc.json +412 -0
- package/fixtures/defold-1.13.0/sys_doc.json +1142 -0
- package/fixtures/defold-1.13.0/table_doc.json +166 -0
- package/fixtures/defold-1.13.0/tilemap_doc.json +402 -0
- package/fixtures/defold-1.13.0/timer_doc.json +153 -0
- package/fixtures/defold-1.13.0/types_doc.json +212 -0
- package/fixtures/defold-1.13.0/vmath_doc.json +1814 -0
- package/fixtures/defold-1.13.0/window_doc.json +388 -0
- package/fixtures/defold-1.13.0/zlib_doc.json +70 -0
- package/fixtures/defold-1.13.1/b2d_body_doc.json +2428 -0
- package/fixtures/defold-1.13.1/b2d_chain_doc.json +394 -0
- package/fixtures/defold-1.13.1/b2d_doc.json +128 -0
- package/fixtures/defold-1.13.1/b2d_fixture_doc.json +594 -0
- package/fixtures/defold-1.13.1/b2d_joint_doc.json +3315 -0
- package/fixtures/defold-1.13.1/b2d_shape_doc.json +802 -0
- package/fixtures/defold-1.13.1/b2d_world_doc.json +1314 -0
- package/fixtures/defold-1.13.1/base_doc.json +758 -0
- package/fixtures/defold-1.13.1/bit_doc.json +404 -0
- package/fixtures/defold-1.13.1/buffer_doc.json +422 -0
- package/fixtures/defold-1.13.1/camera_doc.json +900 -0
- package/fixtures/defold-1.13.1/collectionfactory_doc.json +219 -0
- package/fixtures/defold-1.13.1/collectionproxy_doc.json +323 -0
- package/fixtures/defold-1.13.1/compute_doc.json +182 -0
- package/fixtures/defold-1.13.1/coroutine_doc.json +151 -0
- package/fixtures/defold-1.13.1/crash_doc.json +497 -0
- package/fixtures/defold-1.13.1/debug_doc.json +410 -0
- package/fixtures/defold-1.13.1/editor_doc.json +3880 -0
- package/fixtures/defold-1.13.1/editor_http_doc.json +273 -0
- package/fixtures/defold-1.13.1/editor_image_doc.json +128 -0
- package/fixtures/defold-1.13.1/editor_json_doc.json +59 -0
- package/fixtures/defold-1.13.1/editor_localization_doc.json +138 -0
- package/fixtures/defold-1.13.1/editor_pprint_doc.json +36 -0
- package/fixtures/defold-1.13.1/editor_tilemap_tiles_doc.json +235 -0
- package/fixtures/defold-1.13.1/editor_zip_doc.json +163 -0
- package/fixtures/defold-1.13.1/editor_zlib_doc.json +48 -0
- package/fixtures/defold-1.13.1/factory_doc.json +219 -0
- package/fixtures/defold-1.13.1/font_doc.json +141 -0
- package/fixtures/defold-1.13.1/globals_doc.json +42 -0
- package/fixtures/defold-1.13.1/go-instance-functions.json +102 -0
- package/fixtures/defold-1.13.1/go_doc.json +1989 -0
- package/fixtures/defold-1.13.1/graphics_doc.json +1886 -0
- package/fixtures/defold-1.13.1/gui_doc.json +5277 -0
- package/fixtures/defold-1.13.1/html5_doc.json +64 -0
- package/fixtures/defold-1.13.1/http_doc.json +66 -0
- package/fixtures/defold-1.13.1/image_doc.json +170 -0
- package/fixtures/defold-1.13.1/import-manifest.json +10091 -0
- package/fixtures/defold-1.13.1/io_doc.json +399 -0
- package/fixtures/defold-1.13.1/json_doc.json +97 -0
- package/fixtures/defold-1.13.1/label_doc.json +220 -0
- package/fixtures/defold-1.13.1/liveupdate_doc.json +330 -0
- package/fixtures/defold-1.13.1/material_doc.json +238 -0
- package/fixtures/defold-1.13.1/math_doc.json +702 -0
- package/fixtures/defold-1.13.1/model_doc.json +412 -0
- package/fixtures/defold-1.13.1/msg_doc.json +137 -0
- package/fixtures/defold-1.13.1/os_doc.json +266 -0
- package/fixtures/defold-1.13.1/package_doc.json +139 -0
- package/fixtures/defold-1.13.1/particlefx_doc.json +249 -0
- package/fixtures/defold-1.13.1/physics_doc.json +1492 -0
- package/fixtures/defold-1.13.1/profiler_doc.json +375 -0
- package/fixtures/defold-1.13.1/render_doc.json +1381 -0
- package/fixtures/defold-1.13.1/resource_doc.json +762 -0
- package/fixtures/defold-1.13.1/socket_doc.json +2194 -0
- package/fixtures/defold-1.13.1/sound_doc.json +582 -0
- package/fixtures/defold-1.13.1/sprite_doc.json +335 -0
- package/fixtures/defold-1.13.1/string_doc.json +412 -0
- package/fixtures/defold-1.13.1/sys_doc.json +1142 -0
- package/fixtures/defold-1.13.1/table_doc.json +166 -0
- package/fixtures/defold-1.13.1/tilemap_doc.json +402 -0
- package/fixtures/defold-1.13.1/timer_doc.json +153 -0
- package/fixtures/defold-1.13.1/types_doc.json +212 -0
- package/fixtures/defold-1.13.1/vmath_doc.json +1814 -0
- package/fixtures/defold-1.13.1/window_doc.json +388 -0
- package/fixtures/defold-1.13.1/zlib_doc.json +70 -0
- package/fixtures/defold-1.13.2/b2d_body_doc.json +2359 -0
- package/fixtures/defold-1.13.2/b2d_chain_doc.json +395 -0
- package/fixtures/defold-1.13.2/b2d_doc.json +1945 -0
- package/fixtures/defold-1.13.2/b2d_fixture_doc.json +595 -0
- package/fixtures/defold-1.13.2/b2d_joint_doc.json +3178 -0
- package/fixtures/defold-1.13.2/b2d_shape_doc.json +767 -0
- package/fixtures/defold-1.13.2/b2d_world_doc.json +1315 -0
- package/fixtures/defold-1.13.2/base_doc.json +759 -0
- package/fixtures/defold-1.13.2/bit_doc.json +405 -0
- package/fixtures/defold-1.13.2/buffer_doc.json +393 -0
- package/fixtures/defold-1.13.2/bullet3d_collision_object_doc.json +1206 -0
- package/fixtures/defold-1.13.2/bullet3d_constraint_doc.json +2455 -0
- package/fixtures/defold-1.13.2/bullet3d_doc.json +215 -0
- package/fixtures/defold-1.13.2/bullet3d_rigid_body_doc.json +1376 -0
- package/fixtures/defold-1.13.2/bullet3d_shape_doc.json +430 -0
- package/fixtures/defold-1.13.2/bullet3d_world_doc.json +855 -0
- package/fixtures/defold-1.13.2/camera_doc.json +887 -0
- package/fixtures/defold-1.13.2/collectionfactory_doc.json +206 -0
- package/fixtures/defold-1.13.2/collectionproxy_doc.json +397 -0
- package/fixtures/defold-1.13.2/compute_doc.json +183 -0
- package/fixtures/defold-1.13.2/coroutine_doc.json +152 -0
- package/fixtures/defold-1.13.2/crash_doc.json +483 -0
- package/fixtures/defold-1.13.2/debug_doc.json +411 -0
- package/fixtures/defold-1.13.2/editor_doc.json +6320 -0
- package/fixtures/defold-1.13.2/editor_http_doc.json +476 -0
- package/fixtures/defold-1.13.2/editor_image_doc.json +129 -0
- package/fixtures/defold-1.13.2/editor_json_doc.json +81 -0
- package/fixtures/defold-1.13.2/editor_localization_doc.json +139 -0
- package/fixtures/defold-1.13.2/editor_pprint_doc.json +37 -0
- package/fixtures/defold-1.13.2/editor_tilemap_tiles_doc.json +292 -0
- package/fixtures/defold-1.13.2/editor_zip_doc.json +237 -0
- package/fixtures/defold-1.13.2/editor_zlib_doc.json +49 -0
- package/fixtures/defold-1.13.2/factory_doc.json +206 -0
- package/fixtures/defold-1.13.2/font_doc.json +230 -0
- package/fixtures/defold-1.13.2/globals_doc.json +64 -0
- package/fixtures/defold-1.13.2/go-instance-functions.json +106 -0
- package/fixtures/defold-1.13.2/go_doc.json +1789 -0
- package/fixtures/defold-1.13.2/graphics_doc.json +1211 -0
- package/fixtures/defold-1.13.2/gui_doc.json +4735 -0
- package/fixtures/defold-1.13.2/html5_doc.json +65 -0
- package/fixtures/defold-1.13.2/http_doc.json +174 -0
- package/fixtures/defold-1.13.2/image_doc.json +298 -0
- package/fixtures/defold-1.13.2/import-manifest.json +10902 -0
- package/fixtures/defold-1.13.2/io_doc.json +400 -0
- package/fixtures/defold-1.13.2/json_doc.json +140 -0
- package/fixtures/defold-1.13.2/label_doc.json +427 -0
- package/fixtures/defold-1.13.2/liveupdate_doc.json +221 -0
- package/fixtures/defold-1.13.2/material_doc.json +773 -0
- package/fixtures/defold-1.13.2/math_doc.json +703 -0
- package/fixtures/defold-1.13.2/model_doc.json +472 -0
- package/fixtures/defold-1.13.2/msg_doc.json +169 -0
- package/fixtures/defold-1.13.2/os_doc.json +269 -0
- package/fixtures/defold-1.13.2/package_doc.json +140 -0
- package/fixtures/defold-1.13.2/particlefx_doc.json +249 -0
- package/fixtures/defold-1.13.2/physics_doc.json +1624 -0
- package/fixtures/defold-1.13.2/profiler_doc.json +348 -0
- package/fixtures/defold-1.13.2/render_doc.json +1623 -0
- package/fixtures/defold-1.13.2/resource_doc.json +1539 -0
- package/fixtures/defold-1.13.2/socket_doc.json +2335 -0
- package/fixtures/defold-1.13.2/sound_doc.json +673 -0
- package/fixtures/defold-1.13.2/sprite_doc.json +364 -0
- package/fixtures/defold-1.13.2/string_doc.json +413 -0
- package/fixtures/defold-1.13.2/sys_doc.json +1347 -0
- package/fixtures/defold-1.13.2/table_doc.json +167 -0
- package/fixtures/defold-1.13.2/tilemap_doc.json +369 -0
- package/fixtures/defold-1.13.2/timer_doc.json +214 -0
- package/fixtures/defold-1.13.2/types_doc.json +213 -0
- package/fixtures/defold-1.13.2/vmath_doc.json +2056 -0
- package/fixtures/defold-1.13.2/window_doc.json +426 -0
- package/fixtures/defold-1.13.2/zlib_doc.json +71 -0
- package/fixtures/defold-1.14.0/b2d_body_doc.json +2359 -0
- package/fixtures/defold-1.14.0/b2d_chain_doc.json +395 -0
- package/fixtures/defold-1.14.0/b2d_doc.json +1973 -0
- package/fixtures/defold-1.14.0/b2d_fixture_doc.json +595 -0
- package/fixtures/defold-1.14.0/b2d_joint_doc.json +3178 -0
- package/fixtures/defold-1.14.0/b2d_shape_doc.json +767 -0
- package/fixtures/defold-1.14.0/b2d_world_doc.json +1315 -0
- package/fixtures/defold-1.14.0/base_doc.json +759 -0
- package/fixtures/defold-1.14.0/bit_doc.json +405 -0
- package/fixtures/defold-1.14.0/buffer_doc.json +393 -0
- package/fixtures/defold-1.14.0/bullet3d_collision_object_doc.json +1206 -0
- package/fixtures/defold-1.14.0/bullet3d_constraint_doc.json +2455 -0
- package/fixtures/defold-1.14.0/bullet3d_doc.json +243 -0
- package/fixtures/defold-1.14.0/bullet3d_rigid_body_doc.json +1376 -0
- package/fixtures/defold-1.14.0/bullet3d_shape_doc.json +430 -0
- package/fixtures/defold-1.14.0/bullet3d_world_doc.json +855 -0
- package/fixtures/defold-1.14.0/camera_doc.json +887 -0
- package/fixtures/defold-1.14.0/collectionfactory_doc.json +206 -0
- package/fixtures/defold-1.14.0/collectionproxy_doc.json +397 -0
- package/fixtures/defold-1.14.0/compute_doc.json +183 -0
- package/fixtures/defold-1.14.0/coroutine_doc.json +152 -0
- package/fixtures/defold-1.14.0/crash_doc.json +483 -0
- package/fixtures/defold-1.14.0/debug_doc.json +411 -0
- package/fixtures/defold-1.14.0/editor_doc.json +6320 -0
- package/fixtures/defold-1.14.0/editor_http_doc.json +476 -0
- package/fixtures/defold-1.14.0/editor_image_doc.json +129 -0
- package/fixtures/defold-1.14.0/editor_json_doc.json +81 -0
- package/fixtures/defold-1.14.0/editor_localization_doc.json +139 -0
- package/fixtures/defold-1.14.0/editor_pprint_doc.json +37 -0
- package/fixtures/defold-1.14.0/editor_tilemap_tiles_doc.json +292 -0
- package/fixtures/defold-1.14.0/editor_zip_doc.json +237 -0
- package/fixtures/defold-1.14.0/editor_zlib_doc.json +49 -0
- package/fixtures/defold-1.14.0/factory_doc.json +206 -0
- package/fixtures/defold-1.14.0/font_doc.json +230 -0
- package/fixtures/defold-1.14.0/globals_doc.json +64 -0
- package/fixtures/defold-1.14.0/go-instance-functions.json +106 -0
- package/fixtures/defold-1.14.0/go_doc.json +1789 -0
- package/fixtures/defold-1.14.0/graphics_doc.json +1257 -0
- package/fixtures/defold-1.14.0/gui_doc.json +4735 -0
- package/fixtures/defold-1.14.0/html5_doc.json +65 -0
- package/fixtures/defold-1.14.0/http_doc.json +174 -0
- package/fixtures/defold-1.14.0/image_doc.json +298 -0
- package/fixtures/defold-1.14.0/import-manifest.json +10260 -0
- package/fixtures/defold-1.14.0/io_doc.json +400 -0
- package/fixtures/defold-1.14.0/json_doc.json +140 -0
- package/fixtures/defold-1.14.0/label_doc.json +427 -0
- package/fixtures/defold-1.14.0/liveupdate_doc.json +221 -0
- package/fixtures/defold-1.14.0/material_doc.json +773 -0
- package/fixtures/defold-1.14.0/math_doc.json +703 -0
- package/fixtures/defold-1.14.0/model_doc.json +472 -0
- package/fixtures/defold-1.14.0/msg_doc.json +169 -0
- package/fixtures/defold-1.14.0/os_doc.json +269 -0
- package/fixtures/defold-1.14.0/package_doc.json +140 -0
- package/fixtures/defold-1.14.0/particlefx_doc.json +249 -0
- package/fixtures/defold-1.14.0/physics_doc.json +1624 -0
- package/fixtures/defold-1.14.0/profiler_doc.json +348 -0
- package/fixtures/defold-1.14.0/render_doc.json +1628 -0
- package/fixtures/defold-1.14.0/resource_doc.json +1539 -0
- package/fixtures/defold-1.14.0/socket_doc.json +2335 -0
- package/fixtures/defold-1.14.0/sound_doc.json +673 -0
- package/fixtures/defold-1.14.0/sprite_doc.json +364 -0
- package/fixtures/defold-1.14.0/string_doc.json +413 -0
- package/fixtures/defold-1.14.0/sys_doc.json +1347 -0
- package/fixtures/defold-1.14.0/table_doc.json +167 -0
- package/fixtures/defold-1.14.0/tilemap_doc.json +369 -0
- package/fixtures/defold-1.14.0/timer_doc.json +214 -0
- package/fixtures/defold-1.14.0/types_doc.json +213 -0
- package/fixtures/defold-1.14.0/vmath_doc.json +2056 -0
- package/fixtures/defold-1.14.0/window_doc.json +426 -0
- package/fixtures/defold-1.14.0/zlib_doc.json +71 -0
- package/package.json +13 -6
- package/scripts/cli-runtime.ts +18 -0
- package/scripts/example-store-io.ts +2 -2
- package/scripts/extension-goldens.ts +9 -5
- package/scripts/generate-api-availability.ts +1 -1
- package/scripts/generate-api-signatures.ts +1 -1
- package/scripts/import-defold-release.ts +1 -1
- package/scripts/regen.ts +35 -9
- package/scripts/signature-store-fs.ts +37 -17
- package/scripts/sync-api-docs.ts +127 -20
- package/src/api-doc.ts +11 -4
- package/src/emit-dts.ts +115 -21
- package/src/index-slot-classifications.ts +75 -9
- package/src/index.ts +3 -1
- package/src/publish-dts.ts +16 -0
- package/src/script-api.ts +36 -38
- package/src/library-index-slot-classifications.ts +0 -332
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
{
|
|
2
|
+
"elements": [
|
|
3
|
+
{
|
|
4
|
+
"type": "FUNCTION",
|
|
5
|
+
"name": "string.byte",
|
|
6
|
+
"brief": "converts a character into its ASCII (decimal) equivalent",
|
|
7
|
+
"description": "Returns the internal numerical codes of the characters <code>s[i]</code>,\n<code>s[i+1]</code>, ..., <code>s[j]</code>.\nThe default value for i is 1;\nthe default value for j is i.\nNote that numerical codes are not necessarily portable across platforms.",
|
|
8
|
+
"returnvalues": [],
|
|
9
|
+
"parameters": [
|
|
10
|
+
{
|
|
11
|
+
"name": "s",
|
|
12
|
+
"doc": "",
|
|
13
|
+
"types": ["string"],
|
|
14
|
+
"is_optional": "False"
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"name": "i",
|
|
18
|
+
"doc": "",
|
|
19
|
+
"types": ["number"],
|
|
20
|
+
"is_optional": "True"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"name": "j",
|
|
24
|
+
"doc": "",
|
|
25
|
+
"types": ["number"],
|
|
26
|
+
"is_optional": "True"
|
|
27
|
+
}
|
|
28
|
+
],
|
|
29
|
+
"examples": "",
|
|
30
|
+
"replaces": "",
|
|
31
|
+
"error": "",
|
|
32
|
+
"tparams": [],
|
|
33
|
+
"members": [],
|
|
34
|
+
"notes": [],
|
|
35
|
+
"language": ""
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"type": "FUNCTION",
|
|
39
|
+
"name": "string.char",
|
|
40
|
+
"brief": "converts ASCII codes into their equivalent characters",
|
|
41
|
+
"description": "Receives zero or more integers.\nReturns a string with length equal to the number of arguments,\nin which each character has the internal numerical code equal\nto its corresponding argument.\nNote that numerical codes are not necessarily portable across platforms.",
|
|
42
|
+
"returnvalues": [],
|
|
43
|
+
"parameters": [
|
|
44
|
+
{
|
|
45
|
+
"name": "...",
|
|
46
|
+
"doc": "",
|
|
47
|
+
"types": ["any"],
|
|
48
|
+
"is_optional": "False"
|
|
49
|
+
}
|
|
50
|
+
],
|
|
51
|
+
"examples": "",
|
|
52
|
+
"replaces": "",
|
|
53
|
+
"error": "",
|
|
54
|
+
"tparams": [],
|
|
55
|
+
"members": [],
|
|
56
|
+
"notes": [],
|
|
57
|
+
"language": ""
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"type": "FUNCTION",
|
|
61
|
+
"name": "string.dump",
|
|
62
|
+
"brief": "converts a function into binary",
|
|
63
|
+
"description": "Returns a string containing a binary representation of the given function,\nso that a later loadstring on this string returns\na copy of the function.\nfunction must be a Lua function without upvalues.",
|
|
64
|
+
"returnvalues": [],
|
|
65
|
+
"parameters": [
|
|
66
|
+
{
|
|
67
|
+
"name": "function",
|
|
68
|
+
"doc": "",
|
|
69
|
+
"types": ["function"],
|
|
70
|
+
"is_optional": "False"
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"examples": "",
|
|
74
|
+
"replaces": "",
|
|
75
|
+
"error": "",
|
|
76
|
+
"tparams": [],
|
|
77
|
+
"members": [],
|
|
78
|
+
"notes": [],
|
|
79
|
+
"language": ""
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"type": "FUNCTION",
|
|
83
|
+
"name": "string.find",
|
|
84
|
+
"brief": "searches a string for a pattern",
|
|
85
|
+
"description": "Looks for the first match of\npattern in the string s.\nIf it finds a match, then find returns the indices of <code>s</code>\nwhere this occurrence starts and ends;\notherwise, it returns <span class=\"type\"> nil</span>.\nA third, optional numerical argument init specifies\nwhere to start the search;\nits default value is 1 and can be negative.\nA value of <span class=\"type\"> true</span> as a fourth, optional argument plain\nturns off the pattern matching facilities,\nso the function does a plain \"find substring\" operation,\nwith no characters in pattern being considered \"magic\".\nNote that if plain is given, then init must be given as well.\nIf the pattern has captures,\nthen in a successful match\nthe captured values are also returned,\nafter the two indices.",
|
|
86
|
+
"returnvalues": [],
|
|
87
|
+
"parameters": [
|
|
88
|
+
{
|
|
89
|
+
"name": "s",
|
|
90
|
+
"doc": "",
|
|
91
|
+
"types": ["string"],
|
|
92
|
+
"is_optional": "False"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "pattern",
|
|
96
|
+
"doc": "",
|
|
97
|
+
"types": ["string"],
|
|
98
|
+
"is_optional": "False"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "init",
|
|
102
|
+
"doc": "",
|
|
103
|
+
"types": ["number"],
|
|
104
|
+
"is_optional": "True"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "plain",
|
|
108
|
+
"doc": "",
|
|
109
|
+
"types": ["boolean"],
|
|
110
|
+
"is_optional": "True"
|
|
111
|
+
}
|
|
112
|
+
],
|
|
113
|
+
"examples": "",
|
|
114
|
+
"replaces": "",
|
|
115
|
+
"error": "",
|
|
116
|
+
"tparams": [],
|
|
117
|
+
"members": [],
|
|
118
|
+
"notes": [],
|
|
119
|
+
"language": ""
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"type": "FUNCTION",
|
|
123
|
+
"name": "string.format",
|
|
124
|
+
"brief": "formats a string",
|
|
125
|
+
"description": "Returns a formatted version of its variable number of arguments\nfollowing the description given in its first argument (which must be a string).\nThe format string follows the same rules as the printf family of\nstandard C functions.\nThe only differences are that the options/modifiers\n<code>*</code>, l, L, n, p,\nand h are not supported\nand that there is an extra option, q.\nThe q option formats a string in a form suitable to be safely read\nback by the Lua interpreter:\nthe string is written between double quotes,\nand all double quotes, newlines, embedded zeros,\nand backslashes in the string\nare correctly escaped when written.\nFor instance, the call\n<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">string.format</span><span class=\"p\">(</span><span class=\"s1\">'%q'</span><span class=\"p\">,</span> <span class=\"s1\">'a string with "quotes" and </span><span class=\"se\">\\n</span><span class=\"s1\"> new line'</span><span class=\"p\">)</span>\n</code></pre></div>\n\nwill produce the string:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"s2\">"a string with </span><span class=\"se\">\\"</span><span class=\"s2\">quotes</span><span class=\"se\">\\"</span><span class=\"s2\"> and </span><span class=\"se\">\\</span>\n<span class=\"s2\"> new line"</span>\n</code></pre></div>\n\nThe options c, d, E, e, f,\ng, G, i, o, u, X, and x all\nexpect a number as argument,\nwhereas q and s expect a string.\nThis function does not accept string values\ncontaining embedded zeros,\nexcept as arguments to the q option.",
|
|
126
|
+
"returnvalues": [],
|
|
127
|
+
"parameters": [
|
|
128
|
+
{
|
|
129
|
+
"name": "formatstring",
|
|
130
|
+
"doc": "",
|
|
131
|
+
"types": ["string"],
|
|
132
|
+
"is_optional": "False"
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "...",
|
|
136
|
+
"doc": "",
|
|
137
|
+
"types": ["any"],
|
|
138
|
+
"is_optional": "False"
|
|
139
|
+
}
|
|
140
|
+
],
|
|
141
|
+
"examples": "",
|
|
142
|
+
"replaces": "",
|
|
143
|
+
"error": "",
|
|
144
|
+
"tparams": [],
|
|
145
|
+
"members": [],
|
|
146
|
+
"notes": [],
|
|
147
|
+
"language": ""
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"type": "FUNCTION",
|
|
151
|
+
"name": "string.gmatch",
|
|
152
|
+
"brief": "iterate over a string",
|
|
153
|
+
"description": "Returns an iterator function that,\neach time it is called,\nreturns the next captures from pattern over string s.\nIf pattern specifies no captures,\nthen the whole match is produced in each call.\nAs an example, the following loop\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">s</span> <span class=\"o\">=</span> <span class=\"s2\">"hello world from Lua"</span>\n<span class=\"kr\">for</span> <span class=\"n\">w</span> <span class=\"kr\">in</span> <span class=\"nb\">string.gmatch</span><span class=\"p\">(</span><span class=\"n\">s</span><span class=\"p\">,</span> <span class=\"s2\">"%a+"</span><span class=\"p\">)</span> <span class=\"kr\">do</span>\n <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">w</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nwill iterate over all the words from string s,\nprinting one per line.\nThe next example collects all pairs <code>key=value</code> from the\ngiven string into a table:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">t</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n<span class=\"n\">s</span> <span class=\"o\">=</span> <span class=\"s2\">"from=world, to=Lua"</span>\n<span class=\"kr\">for</span> <span class=\"n\">k</span><span class=\"p\">,</span> <span class=\"n\">v</span> <span class=\"kr\">in</span> <span class=\"nb\">string.gmatch</span><span class=\"p\">(</span><span class=\"n\">s</span><span class=\"p\">,</span> <span class=\"s2\">"(%w+)=(%w+)"</span><span class=\"p\">)</span> <span class=\"kr\">do</span>\n <span class=\"n\">t</span><span class=\"p\">[</span><span class=\"n\">k</span><span class=\"p\">]</span> <span class=\"o\">=</span> <span class=\"n\">v</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nFor this function, a '^' at the start of a pattern does not\nwork as an anchor, as this would prevent the iteration.",
|
|
154
|
+
"returnvalues": [],
|
|
155
|
+
"parameters": [
|
|
156
|
+
{
|
|
157
|
+
"name": "s",
|
|
158
|
+
"doc": "",
|
|
159
|
+
"types": ["string"],
|
|
160
|
+
"is_optional": "False"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "pattern",
|
|
164
|
+
"doc": "",
|
|
165
|
+
"types": ["string"],
|
|
166
|
+
"is_optional": "False"
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"examples": "",
|
|
170
|
+
"replaces": "",
|
|
171
|
+
"error": "",
|
|
172
|
+
"tparams": [],
|
|
173
|
+
"members": [],
|
|
174
|
+
"notes": [],
|
|
175
|
+
"language": ""
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"type": "FUNCTION",
|
|
179
|
+
"name": "string.gsub",
|
|
180
|
+
"brief": "substitute strings inside another string",
|
|
181
|
+
"description": "Returns a copy of s\nin which all (or the first n, if given)\noccurrences of the pattern have been\nreplaced by a replacement string specified by repl,\nwhich can be a string, a table, or a function.\ngsub also returns, as its second value,\nthe total number of matches that occurred.\nIf repl is a string, then its value is used for replacement.\nThe character <code>%</code> works as an escape character:\nany sequence in repl of the form <code>%n</code>,\nwith n between 1 and 9,\nstands for the value of the n-th captured substring (see below).\nThe sequence <code>%0</code> stands for the whole match.\nThe sequence <code>%%</code> stands for a single <code>%</code>.\nIf repl is a table, then the table is queried for every match,\nusing the first capture as the key;\nif the pattern specifies no captures,\nthen the whole match is used as the key.\nIf repl is a function, then this function is called every time a\nmatch occurs, with all captured substrings passed as arguments,\nin order;\nif the pattern specifies no captures,\nthen the whole match is passed as a sole argument.\nIf the value returned by the table query or by the function call\nis a string or a number,\nthen it is used as the replacement string;\notherwise, if it is false or <span class=\"type\"> nil</span>,\nthen there is no replacement\n(that is, the original match is kept in the string).\nHere are some examples:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"hello world"</span><span class=\"p\">,</span> <span class=\"s2\">"(%w+)"</span><span class=\"p\">,</span> <span class=\"s2\">"%1 %1"</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="hello hello world world"</span>\n\n<span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"hello world"</span><span class=\"p\">,</span> <span class=\"s2\">"%w+"</span><span class=\"p\">,</span> <span class=\"s2\">"%0 %0"</span><span class=\"p\">,</span> <span class=\"mi\">1</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="hello hello world"</span>\n\n<span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"hello world from Lua"</span><span class=\"p\">,</span> <span class=\"s2\">"(%w+)%s*(%w+)"</span><span class=\"p\">,</span> <span class=\"s2\">"%2 %1"</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="world hello Lua from"</span>\n\n<span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"home = $HOME, user = $USER"</span><span class=\"p\">,</span> <span class=\"s2\">"%$(%w+)"</span><span class=\"p\">,</span> <span class=\"nb\">os.getenv</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="home = /home/roberto, user = roberto"</span>\n\n<span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"4+5 = $return 4+5$"</span><span class=\"p\">,</span> <span class=\"s2\">"%$(.-)%$"</span><span class=\"p\">,</span> <span class=\"kr\">function</span> <span class=\"p\">(</span><span class=\"n\">s</span><span class=\"p\">)</span>\n <span class=\"kr\">return</span> <span class=\"n\">loadstring</span><span class=\"p\">(</span><span class=\"n\">s</span><span class=\"p\">)()</span>\n <span class=\"kr\">end</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="4+5 = 9"</span>\n\n<span class=\"kd\">local</span> <span class=\"n\">t</span> <span class=\"o\">=</span> <span class=\"p\">{</span><span class=\"n\">name</span><span class=\"o\">=</span><span class=\"s2\">"lua"</span><span class=\"p\">,</span> <span class=\"n\">version</span><span class=\"o\">=</span><span class=\"s2\">"5.1"</span><span class=\"p\">}</span>\n<span class=\"n\">x</span> <span class=\"o\">=</span> <span class=\"nb\">string.gsub</span><span class=\"p\">(</span><span class=\"s2\">"$name-$version.tar.gz"</span><span class=\"p\">,</span> <span class=\"s2\">"%$(%w+)"</span><span class=\"p\">,</span> <span class=\"n\">t</span><span class=\"p\">)</span>\n<span class=\"c1\">--> x="lua-5.1.tar.gz"</span>\n</code></pre></div>",
|
|
182
|
+
"returnvalues": [],
|
|
183
|
+
"parameters": [
|
|
184
|
+
{
|
|
185
|
+
"name": "s",
|
|
186
|
+
"doc": "",
|
|
187
|
+
"types": ["string"],
|
|
188
|
+
"is_optional": "False"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "pattern",
|
|
192
|
+
"doc": "",
|
|
193
|
+
"types": ["string"],
|
|
194
|
+
"is_optional": "False"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"name": "repl",
|
|
198
|
+
"doc": "",
|
|
199
|
+
"types": ["string"],
|
|
200
|
+
"is_optional": "False"
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
"name": "n",
|
|
204
|
+
"doc": "",
|
|
205
|
+
"types": ["number"],
|
|
206
|
+
"is_optional": "True"
|
|
207
|
+
}
|
|
208
|
+
],
|
|
209
|
+
"examples": "",
|
|
210
|
+
"replaces": "",
|
|
211
|
+
"error": "",
|
|
212
|
+
"tparams": [],
|
|
213
|
+
"members": [],
|
|
214
|
+
"notes": [],
|
|
215
|
+
"language": ""
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"type": "FUNCTION",
|
|
219
|
+
"name": "string.len",
|
|
220
|
+
"brief": "return the length of a string",
|
|
221
|
+
"description": "Receives a string and returns its length.\nThe empty string <code>\"\"</code> has length 0.\nEmbedded zeros are counted,\nso <code>\"a\\000bc\\000\"</code> has length 5.",
|
|
222
|
+
"returnvalues": [],
|
|
223
|
+
"parameters": [
|
|
224
|
+
{
|
|
225
|
+
"name": "s",
|
|
226
|
+
"doc": "",
|
|
227
|
+
"types": ["string"],
|
|
228
|
+
"is_optional": "False"
|
|
229
|
+
}
|
|
230
|
+
],
|
|
231
|
+
"examples": "",
|
|
232
|
+
"replaces": "",
|
|
233
|
+
"error": "",
|
|
234
|
+
"tparams": [],
|
|
235
|
+
"members": [],
|
|
236
|
+
"notes": [],
|
|
237
|
+
"language": ""
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"type": "FUNCTION",
|
|
241
|
+
"name": "string.lower",
|
|
242
|
+
"brief": "converts a string to lower-case",
|
|
243
|
+
"description": "Receives a string and returns a copy of this string with all\nuppercase letters changed to lowercase.\nAll other characters are left unchanged.\nThe definition of what an uppercase letter is depends on the current locale.",
|
|
244
|
+
"returnvalues": [],
|
|
245
|
+
"parameters": [
|
|
246
|
+
{
|
|
247
|
+
"name": "s",
|
|
248
|
+
"doc": "",
|
|
249
|
+
"types": ["string"],
|
|
250
|
+
"is_optional": "False"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"examples": "",
|
|
254
|
+
"replaces": "",
|
|
255
|
+
"error": "",
|
|
256
|
+
"tparams": [],
|
|
257
|
+
"members": [],
|
|
258
|
+
"notes": [],
|
|
259
|
+
"language": ""
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"type": "FUNCTION",
|
|
263
|
+
"name": "string.match",
|
|
264
|
+
"brief": "searches a string for a pattern",
|
|
265
|
+
"description": "Looks for the first <em>match</em> of\npattern in the string s.\nIf it finds one, then match returns\nthe captures from the pattern;\notherwise it returns <span class=\"type\"> nil</span>.\nIf pattern specifies no captures,\nthen the whole match is returned.\nA third, optional numerical argument init specifies\nwhere to start the search;\nits default value is 1 and can be negative.",
|
|
266
|
+
"returnvalues": [],
|
|
267
|
+
"parameters": [
|
|
268
|
+
{
|
|
269
|
+
"name": "s",
|
|
270
|
+
"doc": "",
|
|
271
|
+
"types": ["string"],
|
|
272
|
+
"is_optional": "False"
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"name": "pattern",
|
|
276
|
+
"doc": "",
|
|
277
|
+
"types": ["string"],
|
|
278
|
+
"is_optional": "False"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"name": "init",
|
|
282
|
+
"doc": "",
|
|
283
|
+
"types": ["number"],
|
|
284
|
+
"is_optional": "True"
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"examples": "",
|
|
288
|
+
"replaces": "",
|
|
289
|
+
"error": "",
|
|
290
|
+
"tparams": [],
|
|
291
|
+
"members": [],
|
|
292
|
+
"notes": [],
|
|
293
|
+
"language": ""
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"type": "FUNCTION",
|
|
297
|
+
"name": "string.rep",
|
|
298
|
+
"brief": "returns repeated copies of a string",
|
|
299
|
+
"description": "Returns a string that is the concatenation of n copies of\nthe string s.",
|
|
300
|
+
"returnvalues": [],
|
|
301
|
+
"parameters": [
|
|
302
|
+
{
|
|
303
|
+
"name": "s",
|
|
304
|
+
"doc": "",
|
|
305
|
+
"types": ["string"],
|
|
306
|
+
"is_optional": "False"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "n",
|
|
310
|
+
"doc": "",
|
|
311
|
+
"types": ["number"],
|
|
312
|
+
"is_optional": "False"
|
|
313
|
+
}
|
|
314
|
+
],
|
|
315
|
+
"examples": "",
|
|
316
|
+
"replaces": "",
|
|
317
|
+
"error": "",
|
|
318
|
+
"tparams": [],
|
|
319
|
+
"members": [],
|
|
320
|
+
"notes": [],
|
|
321
|
+
"language": ""
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"type": "FUNCTION",
|
|
325
|
+
"name": "string.reverse",
|
|
326
|
+
"brief": "reverses the order of characters in a string",
|
|
327
|
+
"description": "Returns a string that is the string s reversed.",
|
|
328
|
+
"returnvalues": [],
|
|
329
|
+
"parameters": [
|
|
330
|
+
{
|
|
331
|
+
"name": "s",
|
|
332
|
+
"doc": "",
|
|
333
|
+
"types": ["string"],
|
|
334
|
+
"is_optional": "False"
|
|
335
|
+
}
|
|
336
|
+
],
|
|
337
|
+
"examples": "",
|
|
338
|
+
"replaces": "",
|
|
339
|
+
"error": "",
|
|
340
|
+
"tparams": [],
|
|
341
|
+
"members": [],
|
|
342
|
+
"notes": [],
|
|
343
|
+
"language": ""
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"type": "FUNCTION",
|
|
347
|
+
"name": "string.sub",
|
|
348
|
+
"brief": "returns a substring of a string",
|
|
349
|
+
"description": "Returns the substring of s that\nstarts at i and continues until j;\ni and j can be negative.\nIf j is absent, then it is assumed to be equal to -1\n(which is the same as the string length).\nIn particular,\nthe call <code>string.sub(s,1,j)</code> returns a prefix of s\nwith length j,\nand <code>string.sub(s, -i)</code> returns a suffix of s\nwith length i.",
|
|
350
|
+
"returnvalues": [],
|
|
351
|
+
"parameters": [
|
|
352
|
+
{
|
|
353
|
+
"name": "s",
|
|
354
|
+
"doc": "",
|
|
355
|
+
"types": ["string"],
|
|
356
|
+
"is_optional": "False"
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "i",
|
|
360
|
+
"doc": "",
|
|
361
|
+
"types": ["number"],
|
|
362
|
+
"is_optional": "False"
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"name": "j",
|
|
366
|
+
"doc": "",
|
|
367
|
+
"types": ["number"],
|
|
368
|
+
"is_optional": "True"
|
|
369
|
+
}
|
|
370
|
+
],
|
|
371
|
+
"examples": "",
|
|
372
|
+
"replaces": "",
|
|
373
|
+
"error": "",
|
|
374
|
+
"tparams": [],
|
|
375
|
+
"members": [],
|
|
376
|
+
"notes": [],
|
|
377
|
+
"language": ""
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"type": "FUNCTION",
|
|
381
|
+
"name": "string.upper",
|
|
382
|
+
"brief": "converts a string to upper-case",
|
|
383
|
+
"description": "Receives a string and returns a copy of this string with all\nlowercase letters changed to uppercase.\nAll other characters are left unchanged.\nThe definition of what a lowercase letter is depends on the current locale.",
|
|
384
|
+
"returnvalues": [],
|
|
385
|
+
"parameters": [
|
|
386
|
+
{
|
|
387
|
+
"name": "s",
|
|
388
|
+
"doc": "",
|
|
389
|
+
"types": ["string"],
|
|
390
|
+
"is_optional": "False"
|
|
391
|
+
}
|
|
392
|
+
],
|
|
393
|
+
"examples": "",
|
|
394
|
+
"replaces": "",
|
|
395
|
+
"error": "",
|
|
396
|
+
"tparams": [],
|
|
397
|
+
"members": [],
|
|
398
|
+
"notes": [],
|
|
399
|
+
"language": ""
|
|
400
|
+
}
|
|
401
|
+
],
|
|
402
|
+
"info": {
|
|
403
|
+
"namespace": "string",
|
|
404
|
+
"name": "String",
|
|
405
|
+
"brief": "Lua string standard library",
|
|
406
|
+
"description": "Documentation for the Lua string standard library.\n\nFrom [Lua 5.1 Reference Manual](https://www.lua.org/manual/5.1/)\nby Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.\n\nCopyright © 2006-2012 Lua.org, PUC-Rio.\n\nFreely available under the terms of the [Lua license](https://www.lua.org/license.html).\n\n\n### Patterns\n\n_Character Class:_\n\nA character class is used to represent a set of characters.\nThe following combinations are allowed in describing a character class:\n\nx\n: (where x is not one of the <em>magic characters</em> `^$()%.[]*+-?`)\n represents the character <em>x</em> itself.\n\n`.`\n: (a dot) represents all characters.\n\n`%a`\n: represents all letters.\n\n`%c`\n: represents all control characters.\n\n`%d`\n: represents all digits.\n\n`%l`\n: represents all lowercase letters.\n\n`%p`\n: represents all punctuation characters.\n\n`%s`\n: represents all space characters.\n\n`%u`\n: represents all uppercase letters.\n\n`%w`\n: represents all alphanumeric characters.\n\n`%x`\n: represents all hexadecimal digits.\n\n`%z`\n: represents the character with representation 0.\n\n`%x`\n: (where x is any non-alphanumeric character) represents the character x.\n This is the standard way to escape the magic characters.\n Any punctuation character (even the non magic) can be preceded by a '%'\n when used to represent itself in a pattern.\n\n`[set]`\n: represents the class which is the union of all characters in set.\n A range of characters can be specified by separating the end characters\n of the range with a '-'.\n All classes `%`<em>x</em> described above can also be used as components in set.\n All other characters in set represent themselves.\n For example, `[%w_]` (or `[_%w]`) represents all alphanumeric characters\n plus the underscore, `[0-7]` represents the octal digits,\n and `[0-7%l%-]` represents the octal digits plus the lowercase letters\n plus the '-' character.\n\n The interaction between ranges and classes is not defined.\n Therefore, patterns like `[%a-z]` or `[a-%%]` have no meaning.\n\n`[^set]`\n: represents the complement of set,\n where set is interpreted as above.\n\nFor all classes represented by single letters (`%a`, `%c`, etc.),\nthe corresponding uppercase letter represents the complement of the class.\nFor instance, `%S` represents all non-space characters.\n\nThe definitions of letter, space, and other character groups\ndepend on the current locale. In particular, the class `[a-z]` may not be\nequivalent to `%l`.\n\n_Pattern Item:_\n\nA pattern item can be\n\n- a single character class, which matches any single character in the class;\n\n- a single character class followed by '*',\n which matches 0 or more repetitions of characters in the class.\n These repetition items will always match the longest possible sequence;\n\n- a single character class followed by '+',\n which matches 1 or more repetitions of characters in the class.\n These repetition items will always match the longest possible sequence;\n\n- a single character class followed by '-',\n which also matches 0 or more repetitions of characters in the class.\n Unlike '*', these repetition items will always match the <em>shortest</em>\n possible sequence;\n\n- a single character class followed by '?',\n which matches 0 or 1 occurrence of a character in the class;\n\n- `%n`, for n between 1 and 9; such item matches a substring equal to the\n n-th captured string (see below);\n\n- `%bxy`, where x and y are two distinct characters;\n such item matches strings that start with x, end with y,\n and where the x and y are <em>balanced</em>.\n This means that, if one reads the string from left to right,\n counting +1 for an x and -1 for a y,\n the ending y is the first y where the count reaches 0.\n For instance, the item `%b()` matches expressions with balanced parentheses.\n\n_Pattern:_\n\nA pattern is a sequence of pattern items.\nA '^' at the beginning of a pattern anchors the match at the\nbeginning of the subject string.\nA '$' at the end of a pattern anchors the match at the\nend of the subject string.\nAt other positions, '^' and '$' have no special meaning and represent themselves.\n\n_Captures:_\n\nA pattern can contain sub-patterns enclosed in parentheses;\nthey describe captures.\nWhen a match succeeds, the substrings of the subject string\nthat match captures are stored (<em>captured</em>) for future use.\nCaptures are numbered according to their left parentheses.\nFor instance, in the pattern `\"(a*(.)%w(%s*))\"`,\nthe part of the string matching `\"a*(.)%w(%s*)\"` is\nstored as the first capture (and therefore has number 1);\nthe character matching \".\" is captured with number 2,\nand the part matching \"%s*\" has number 3.\n\nAs a special case, the empty capture `()` captures\nthe current string position (a number).\nFor instance, if we apply the pattern `\"()aa()\"` on the\nstring `\"flaaap\"`, there will be two captures: 3 and 5.\n\nA pattern cannot contain embedded zeros. Use `%z` instead.",
|
|
407
|
+
"path": "engine/lua/src/lua_string.doc_h",
|
|
408
|
+
"file": "",
|
|
409
|
+
"notes": [],
|
|
410
|
+
"language": "Lua"
|
|
411
|
+
},
|
|
412
|
+
"format_version": 2
|
|
413
|
+
}
|