@defold-typescript/types 0.52.0 → 0.53.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.
Files changed (191) hide show
  1. package/api-signatures.json +2074 -1964
  2. package/examples/translations.json +15 -15
  3. package/generated/b2d.d.ts +39 -39
  4. package/generated/b2d_body.d.ts +11 -11
  5. package/generated/b2d_chain.d.ts +3 -3
  6. package/generated/b2d_fixture.d.ts +5 -5
  7. package/generated/b2d_joint.d.ts +29 -29
  8. package/generated/b2d_shape.d.ts +13 -13
  9. package/generated/b2d_world.d.ts +15 -15
  10. package/generated/buffer.d.ts +5 -6
  11. package/generated/bullet3d.d.ts +6 -6
  12. package/generated/bullet3d_collision_object.d.ts +9 -9
  13. package/generated/bullet3d_constraint.d.ts +78 -78
  14. package/generated/bullet3d_rigid_body.d.ts +3 -3
  15. package/generated/bullet3d_shape.d.ts +11 -11
  16. package/generated/bullet3d_world.d.ts +20 -20
  17. package/generated/camera.d.ts +4 -4
  18. package/generated/collectionfactory.d.ts +2 -3
  19. package/generated/collectionproxy.d.ts +5 -5
  20. package/generated/compute.d.ts +5 -5
  21. package/generated/crash.d.ts +7 -7
  22. package/generated/editor-vm/http.d.ts +13 -13
  23. package/generated/editor-vm/image.d.ts +4 -4
  24. package/generated/editor-vm/json.d.ts +1 -1
  25. package/generated/editor-vm/tilemap_tiles.d.ts +9 -9
  26. package/generated/editor-vm/zip.d.ts +4 -4
  27. package/generated/editor.d.ts +183 -183
  28. package/generated/factory.d.ts +2 -3
  29. package/generated/font.d.ts +4 -4
  30. package/generated/go.d.ts +10 -12
  31. package/generated/graphics.d.ts +23 -26
  32. package/generated/gui.d.ts +44 -58
  33. package/generated/http.d.ts +2 -2
  34. package/generated/image.d.ts +12 -12
  35. package/generated/json.d.ts +4 -4
  36. package/generated/label.d.ts +5 -5
  37. package/generated/liveupdate.d.ts +3 -3
  38. package/generated/material.d.ts +48 -48
  39. package/generated/model.d.ts +46 -14
  40. package/generated/particlefx.d.ts +5 -5
  41. package/generated/physics.d.ts +19 -19
  42. package/generated/profiler.d.ts +3 -5
  43. package/generated/render-script-modules/b2d.d.ts +39 -39
  44. package/generated/render-script-modules/bullet3d.d.ts +5 -5
  45. package/generated/render-script-modules/collectionfactory.d.ts +1 -2
  46. package/generated/render-script-modules/collectionproxy.d.ts +3 -3
  47. package/generated/render-script-modules/factory.d.ts +1 -2
  48. package/generated/render-script-modules/go.d.ts +8 -10
  49. package/generated/render-script-modules/label.d.ts +2 -2
  50. package/generated/render-script-modules/model.d.ts +43 -11
  51. package/generated/render-script-modules/particlefx.d.ts +3 -3
  52. package/generated/render-script-modules/physics.d.ts +12 -12
  53. package/generated/render-script-modules/resource.d.ts +52 -53
  54. package/generated/render-script-modules/sound.d.ts +4 -4
  55. package/generated/render-script-modules/sprite.d.ts +2 -2
  56. package/generated/render-script-modules/tilemap.d.ts +2 -2
  57. package/generated/render.d.ts +44 -45
  58. package/generated/resource.d.ts +58 -59
  59. package/generated/socket.d.ts +18 -23
  60. package/generated/sound.d.ts +6 -6
  61. package/generated/sprite.d.ts +3 -3
  62. package/generated/sys.d.ts +20 -21
  63. package/generated/tilemap.d.ts +3 -3
  64. package/generated/timer.d.ts +3 -3
  65. package/generated/versions/defold-1.12.4/b2d.d.ts +2 -2
  66. package/generated/versions/defold-1.12.4/b2d_body.d.ts +2 -2
  67. package/generated/versions/defold-1.12.4/go.d.ts +2 -2
  68. package/generated/versions/defold-1.12.4/graphics.d.ts +1 -1
  69. package/generated/versions/defold-1.12.4/gui.d.ts +18 -19
  70. package/generated/versions/defold-1.12.4/label.d.ts +1 -1
  71. package/generated/versions/defold-1.12.4/model.d.ts +42 -10
  72. package/generated/versions/defold-1.12.4/particlefx.d.ts +1 -1
  73. package/generated/versions/defold-1.12.4/physics.d.ts +1 -1
  74. package/generated/versions/defold-1.12.4/render.d.ts +5 -5
  75. package/generated/versions/defold-1.12.4/resource.d.ts +8 -8
  76. package/generated/versions/defold-1.12.4/socket.d.ts +12 -12
  77. package/generated/versions/defold-1.12.4/sound.d.ts +1 -1
  78. package/generated/versions/defold-1.12.4/sprite.d.ts +1 -1
  79. package/generated/versions/defold-1.12.4/sys.d.ts +2 -2
  80. package/generated/versions/defold-1.12.4/tilemap.d.ts +1 -1
  81. package/generated/versions/defold-1.12.4/window.d.ts +3 -4
  82. package/generated/versions/defold-1.13.0/b2d.d.ts +2 -2
  83. package/generated/versions/defold-1.13.0/b2d_body.d.ts +2 -2
  84. package/generated/versions/defold-1.13.0/b2d_chain.d.ts +1 -1
  85. package/generated/versions/defold-1.13.0/b2d_joint.d.ts +1 -1
  86. package/generated/versions/defold-1.13.0/b2d_shape.d.ts +1 -1
  87. package/generated/versions/defold-1.13.0/camera.d.ts +1 -1
  88. package/generated/versions/defold-1.13.0/go.d.ts +2 -2
  89. package/generated/versions/defold-1.13.0/graphics.d.ts +1 -1
  90. package/generated/versions/defold-1.13.0/gui.d.ts +18 -19
  91. package/generated/versions/defold-1.13.0/label.d.ts +1 -1
  92. package/generated/versions/defold-1.13.0/model.d.ts +42 -10
  93. package/generated/versions/defold-1.13.0/particlefx.d.ts +1 -1
  94. package/generated/versions/defold-1.13.0/physics.d.ts +1 -1
  95. package/generated/versions/defold-1.13.0/render.d.ts +5 -5
  96. package/generated/versions/defold-1.13.0/resource.d.ts +8 -8
  97. package/generated/versions/defold-1.13.0/socket.d.ts +12 -12
  98. package/generated/versions/defold-1.13.0/sound.d.ts +1 -1
  99. package/generated/versions/defold-1.13.0/sprite.d.ts +1 -1
  100. package/generated/versions/defold-1.13.0/sys.d.ts +2 -2
  101. package/generated/versions/defold-1.13.0/tilemap.d.ts +1 -1
  102. package/generated/versions/defold-1.13.0/window.d.ts +3 -4
  103. package/generated/versions/defold-1.13.1/b2d.d.ts +2 -2
  104. package/generated/versions/defold-1.13.1/b2d_body.d.ts +2 -2
  105. package/generated/versions/defold-1.13.1/b2d_chain.d.ts +1 -1
  106. package/generated/versions/defold-1.13.1/b2d_joint.d.ts +1 -1
  107. package/generated/versions/defold-1.13.1/b2d_shape.d.ts +1 -1
  108. package/generated/versions/defold-1.13.1/camera.d.ts +1 -1
  109. package/generated/versions/defold-1.13.1/go.d.ts +2 -2
  110. package/generated/versions/defold-1.13.1/graphics.d.ts +1 -1
  111. package/generated/versions/defold-1.13.1/gui.d.ts +18 -19
  112. package/generated/versions/defold-1.13.1/label.d.ts +1 -1
  113. package/generated/versions/defold-1.13.1/model.d.ts +42 -10
  114. package/generated/versions/defold-1.13.1/particlefx.d.ts +1 -1
  115. package/generated/versions/defold-1.13.1/physics.d.ts +1 -1
  116. package/generated/versions/defold-1.13.1/render.d.ts +5 -5
  117. package/generated/versions/defold-1.13.1/resource.d.ts +8 -8
  118. package/generated/versions/defold-1.13.1/socket.d.ts +12 -12
  119. package/generated/versions/defold-1.13.1/sound.d.ts +1 -1
  120. package/generated/versions/defold-1.13.1/sprite.d.ts +1 -1
  121. package/generated/versions/defold-1.13.1/sys.d.ts +2 -2
  122. package/generated/versions/defold-1.13.1/tilemap.d.ts +1 -1
  123. package/generated/versions/defold-1.13.1/window.d.ts +3 -4
  124. package/generated/versions/defold-1.13.2/b2d.d.ts +39 -39
  125. package/generated/versions/defold-1.13.2/b2d_body.d.ts +11 -11
  126. package/generated/versions/defold-1.13.2/b2d_chain.d.ts +3 -3
  127. package/generated/versions/defold-1.13.2/b2d_fixture.d.ts +5 -5
  128. package/generated/versions/defold-1.13.2/b2d_joint.d.ts +29 -29
  129. package/generated/versions/defold-1.13.2/b2d_shape.d.ts +13 -13
  130. package/generated/versions/defold-1.13.2/b2d_world.d.ts +15 -15
  131. package/generated/versions/defold-1.13.2/buffer.d.ts +5 -6
  132. package/generated/versions/defold-1.13.2/bullet3d.d.ts +6 -6
  133. package/generated/versions/defold-1.13.2/bullet3d_collision_object.d.ts +9 -9
  134. package/generated/versions/defold-1.13.2/bullet3d_constraint.d.ts +78 -78
  135. package/generated/versions/defold-1.13.2/bullet3d_rigid_body.d.ts +3 -3
  136. package/generated/versions/defold-1.13.2/bullet3d_shape.d.ts +11 -11
  137. package/generated/versions/defold-1.13.2/bullet3d_world.d.ts +20 -20
  138. package/generated/versions/defold-1.13.2/camera.d.ts +4 -4
  139. package/generated/versions/defold-1.13.2/collectionfactory.d.ts +2 -3
  140. package/generated/versions/defold-1.13.2/collectionproxy.d.ts +5 -5
  141. package/generated/versions/defold-1.13.2/compute.d.ts +5 -5
  142. package/generated/versions/defold-1.13.2/crash.d.ts +7 -7
  143. package/generated/versions/defold-1.13.2/editor-vm/http.d.ts +13 -13
  144. package/generated/versions/defold-1.13.2/editor-vm/image.d.ts +4 -4
  145. package/generated/versions/defold-1.13.2/editor-vm/json.d.ts +1 -1
  146. package/generated/versions/defold-1.13.2/editor-vm/tilemap_tiles.d.ts +9 -9
  147. package/generated/versions/defold-1.13.2/editor-vm/zip.d.ts +4 -4
  148. package/generated/versions/defold-1.13.2/editor.d.ts +183 -183
  149. package/generated/versions/defold-1.13.2/factory.d.ts +2 -3
  150. package/generated/versions/defold-1.13.2/font.d.ts +4 -4
  151. package/generated/versions/defold-1.13.2/go.d.ts +10 -12
  152. package/generated/versions/defold-1.13.2/graphics.d.ts +22 -25
  153. package/generated/versions/defold-1.13.2/gui.d.ts +44 -58
  154. package/generated/versions/defold-1.13.2/http.d.ts +2 -2
  155. package/generated/versions/defold-1.13.2/image.d.ts +12 -12
  156. package/generated/versions/defold-1.13.2/json.d.ts +4 -4
  157. package/generated/versions/defold-1.13.2/label.d.ts +5 -5
  158. package/generated/versions/defold-1.13.2/liveupdate.d.ts +3 -3
  159. package/generated/versions/defold-1.13.2/material.d.ts +48 -48
  160. package/generated/versions/defold-1.13.2/model.d.ts +46 -14
  161. package/generated/versions/defold-1.13.2/particlefx.d.ts +5 -5
  162. package/generated/versions/defold-1.13.2/physics.d.ts +19 -19
  163. package/generated/versions/defold-1.13.2/profiler.d.ts +3 -5
  164. package/generated/versions/defold-1.13.2/render.d.ts +43 -44
  165. package/generated/versions/defold-1.13.2/resource.d.ts +58 -59
  166. package/generated/versions/defold-1.13.2/socket.d.ts +18 -23
  167. package/generated/versions/defold-1.13.2/sound.d.ts +6 -6
  168. package/generated/versions/defold-1.13.2/sprite.d.ts +3 -3
  169. package/generated/versions/defold-1.13.2/sys.d.ts +20 -21
  170. package/generated/versions/defold-1.13.2/tilemap.d.ts +3 -3
  171. package/generated/versions/defold-1.13.2/timer.d.ts +3 -3
  172. package/generated/versions/defold-1.13.2/vmath.d.ts +0 -1
  173. package/generated/versions/defold-1.13.2/window.d.ts +8 -10
  174. package/generated/vmath.d.ts +0 -1
  175. package/generated/window.d.ts +8 -10
  176. package/identity-vocabulary.json +41 -34
  177. package/package.json +2 -1
  178. package/scripts/generate-api-availability.ts +9 -3
  179. package/scripts/shared-handle-methods.ts +3 -2
  180. package/src/api-doc.ts +8 -0
  181. package/src/api-identity.ts +32 -1
  182. package/src/component-properties.d.ts +8 -8
  183. package/src/core-types.ts +29 -13
  184. package/src/doc-corrections.ts +9 -0
  185. package/src/emit-dts.ts +664 -202
  186. package/src/engine-type-name.ts +33 -0
  187. package/src/go-overloads.d.ts +10 -10
  188. package/src/gui-overloads.d.ts +11 -11
  189. package/src/index.ts +1 -0
  190. package/src/lifecycle.ts +2 -2
  191. package/src/socket-types.d.ts +3 -3
@@ -9,7 +9,7 @@ declare global {
9
9
  /**
10
10
  * Sprite flipbook playback properties
11
11
  */
12
- interface play_properties {
12
+ interface PlayProperties {
13
13
  /**
14
14
  * Normalized initial animation cursor.
15
15
  */
@@ -114,7 +114,7 @@ declare global {
114
114
  * });
115
115
  * ```
116
116
  */
117
- function play_flipbook(url: string | Hash | Url, id: string | Hash, complete_function: ((self: unknown, message_id: Hash, message: { current_tile: number; id: Hash }, sender: Url) => void) | undefined, play_properties: sprite.play_properties): void;
117
+ function play_flipbook(url: string | Hash | Url, id: string | Hash, complete_function: ((self: unknown, message_id: Hash, message: { current_tile: number; id: Hash }, sender: Url) => void) | undefined, play_properties: sprite.PlayProperties): void;
118
118
  /**
119
119
  * Resets a shader constant for a sprite component.
120
120
  * The constant must be defined in the material assigned to the sprite.
@@ -178,7 +178,7 @@ declare global {
178
178
  * ```
179
179
  */
180
180
  function set_vflip(url: string | Hash | Url, flip: boolean): void;
181
- interface properties {
181
+ interface Properties {
182
182
  /**
183
183
  * READ ONLY The current animation id. An animation that plays currently for the sprite. The type of the property is hash.
184
184
  */
@@ -10,7 +10,7 @@ declare global {
10
10
  /**
11
11
  * Application information
12
12
  */
13
- interface application_info {
13
+ interface ApplicationInfo {
14
14
  /**
15
15
  * Whether the queried application is installed.
16
16
  */
@@ -19,7 +19,7 @@ declare global {
19
19
  /**
20
20
  * Engine information
21
21
  */
22
- interface engine_info {
22
+ interface EngineInfo {
23
23
  /**
24
24
  * Defold engine version.
25
25
  */
@@ -36,7 +36,7 @@ declare global {
36
36
  /**
37
37
  * Network-interface information
38
38
  */
39
- interface interface_info {
39
+ interface InterfaceInfo {
40
40
  /**
41
41
  * Interface name.
42
42
  */
@@ -65,11 +65,11 @@ declare global {
65
65
  /**
66
66
  * Asynchronous buffer-load result
67
67
  */
68
- interface load_buffer_result {
68
+ interface LoadBufferResult {
69
69
  /**
70
70
  * Request status.
71
71
  */
72
- status: sys.REQUEST_STATUS;
72
+ status: sys.RequestStatus;
73
73
  /**
74
74
  * Loaded payload for a successful request.
75
75
  */
@@ -78,7 +78,7 @@ declare global {
78
78
  /**
79
79
  * URL opening attributes
80
80
  */
81
- interface open_url_attributes {
81
+ interface OpenUrlAttributes {
82
82
  /**
83
83
  * HTML5 browsing context: `_self`, `_blank`, `_parent`, `_top`, or a named window.
84
84
  */
@@ -87,7 +87,7 @@ declare global {
87
87
  /**
88
88
  * System information
89
89
  */
90
- interface sys_info {
90
+ interface SysInfo {
91
91
  /**
92
92
  * Device model on iOS and Android.
93
93
  */
@@ -136,15 +136,14 @@ declare global {
136
136
  /**
137
137
  * System-information options
138
138
  */
139
- interface sys_info_options {
139
+ interface SysInfoOptions {
140
140
  /**
141
141
  * Omit operating-system-protected values such as `device_ident`.
142
142
  */
143
143
  ignore_secure?: boolean;
144
144
  }
145
- type NetworkConnectivity = typeof sys.NETWORK_DISCONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_CONNECTED;
146
- type NETWORK = typeof sys.NETWORK_CONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_DISCONNECTED;
147
- type REQUEST_STATUS = typeof sys.REQUEST_STATUS_ERROR_IO_ERROR | typeof sys.REQUEST_STATUS_ERROR_NOT_FOUND | typeof sys.REQUEST_STATUS_FINISHED;
145
+ type Network = typeof sys.NETWORK_CONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_DISCONNECTED;
146
+ type RequestStatus = typeof sys.REQUEST_STATUS_ERROR_IO_ERROR | typeof sys.REQUEST_STATUS_ERROR_NOT_FOUND | typeof sys.REQUEST_STATUS_FINISHED;
148
147
  /**
149
148
  * Connected through Wi-Fi or another non-cellular network.
150
149
  */
@@ -255,7 +254,7 @@ declare global {
255
254
  * // ...
256
255
  * ```
257
256
  */
258
- function get_application_info(app_string: string): sys.application_info;
257
+ function get_application_info(app_string: string): sys.ApplicationInfo;
259
258
  /**
260
259
  * The path from which the application is run.
261
260
  * This function will raise a Lua error if unable to get the application support path.
@@ -378,7 +377,7 @@ declare global {
378
377
  * }
379
378
  * ```
380
379
  */
381
- function get_connectivity(): sys.NETWORK;
380
+ function get_connectivity(): sys.Network;
382
381
  /**
383
382
  * Returns a table with engine information.
384
383
  *
@@ -392,7 +391,7 @@ declare global {
392
391
  * gui.set_text(gui.get_node("version"), version_str);
393
392
  * ```
394
393
  */
395
- function get_engine_info(): sys.engine_info;
394
+ function get_engine_info(): sys.EngineInfo;
396
395
  /**
397
396
  * Create a path to the host device for unit testing
398
397
  * Useful for saving logs etc during development
@@ -429,7 +428,7 @@ declare global {
429
428
  * }
430
429
  * ```
431
430
  */
432
- function get_ifaddrs(): sys.interface_info[];
431
+ function get_ifaddrs(): sys.InterfaceInfo[];
433
432
  /**
434
433
  * The save-file path is operating system specific and is typically located under the user's home directory.
435
434
  * This function will raise a Lua error if unable to get the save file path.
@@ -476,7 +475,7 @@ declare global {
476
475
  * }
477
476
  * ```
478
477
  */
479
- function get_sys_info(): sys.sys_info;
478
+ function get_sys_info(): sys.SysInfo;
480
479
  /**
481
480
  * Returns a table with system information.
482
481
  *
@@ -491,7 +490,7 @@ declare global {
491
490
  * }
492
491
  * ```
493
492
  */
494
- function get_sys_info(options: sys.sys_info_options): sys.sys_info;
493
+ function get_sys_info(options: sys.SysInfoOptions): sys.SysInfo;
495
494
  /**
496
495
  * If the file exists, it must have been created by `sys.save` to be loaded.
497
496
  * This function will raise a Lua error if an error occurs while loading the file.
@@ -560,7 +559,7 @@ declare global {
560
559
  * Load binary data from a custom project resource and update a texture resource:
561
560
  * ```ts
562
561
  * // Load binary data from a custom project resource and update a texture resource:
563
- * function my_callback(self: unknown, request_id: number, result: sys.load_buffer_result) {
562
+ * function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
564
563
  * const format = graphics.TEXTURE_FORMAT_RGBA;
565
564
  * if (result.status === sys.REQUEST_STATUS_FINISHED && result.buffer !== undefined && format !== undefined) {
566
565
  * resource.set_texture("/my_texture", { type: graphics.TEXTURE_TYPE_2D, width: 128, height: 128, format }, result.buffer);
@@ -573,7 +572,7 @@ declare global {
573
572
  * Load binary data from non-custom resource files on disk:
574
573
  * ```ts
575
574
  * // Load binary data from non-custom resource files on disk:
576
- * function my_callback(self: unknown, request_id: number, result: sys.load_buffer_result) {
575
+ * function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
577
576
  * const { first_request, second_request } = self as { first_request: number; second_request: number };
578
577
  * if (result.status !== sys.REQUEST_STATUS_FINISHED) {
579
578
  * // uh oh! File could not be found, do something graceful
@@ -594,7 +593,7 @@ declare global {
594
593
  * });
595
594
  * ```
596
595
  */
597
- function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.load_buffer_result) => void): number;
596
+ function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.LoadBufferResult) => void): number;
598
597
  /**
599
598
  * Loads a custom resource. Specify the full filename of the resource that you want
600
599
  * to load. When loaded, the file data is returned as a string.
@@ -652,7 +651,7 @@ declare global {
652
651
  * }
653
652
  * ```
654
653
  */
655
- function open_url(url: string, attributes: sys.open_url_attributes): boolean;
654
+ function open_url(url: string, attributes: sys.OpenUrlAttributes): boolean;
656
655
  /**
657
656
  * Reboots the game engine with a specified set of arguments.
658
657
  * Arguments will be translated into command line arguments. Calling reboot
@@ -6,7 +6,7 @@ declare global {
6
6
  * Functions and messages used to manipulate tile map components.
7
7
  */
8
8
  namespace tilemap {
9
- type TRANSFORM = typeof tilemap.H_FLIP | typeof tilemap.ROTATE_180 | typeof tilemap.ROTATE_270 | typeof tilemap.ROTATE_90 | typeof tilemap.V_FLIP;
9
+ type Transform = typeof tilemap.H_FLIP | typeof tilemap.ROTATE_180 | typeof tilemap.ROTATE_270 | typeof tilemap.ROTATE_90 | typeof tilemap.V_FLIP;
10
10
  /**
11
11
  * flip tile horizontally
12
12
  */
@@ -176,7 +176,7 @@ declare global {
176
176
  * }
177
177
  * ```
178
178
  */
179
- function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: tilemap.TRANSFORM | number): boolean;
179
+ function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: tilemap.Transform | number): boolean;
180
180
  /**
181
181
  * Sets the visibility of the tilemap layer
182
182
  *
@@ -190,7 +190,7 @@ declare global {
190
190
  * ```
191
191
  */
192
192
  function set_visible(url: string | Hash | Url, layer: string | Hash, visible: boolean): void;
193
- interface properties {
193
+ interface Properties {
194
194
  /**
195
195
  * The material used when rendering the tile map. The type of the property is hash.
196
196
  */
@@ -11,7 +11,7 @@ declare global {
11
11
  /**
12
12
  * Timer information
13
13
  */
14
- interface info {
14
+ interface Info {
15
15
  /**
16
16
  * Time remaining until the next callback.
17
17
  */
@@ -25,7 +25,7 @@ declare global {
25
25
  */
26
26
  repeating: boolean;
27
27
  }
28
- type timer_handle = number;
28
+ type TimerHandle = number;
29
29
  /**
30
30
  * Indicates an invalid timer handle
31
31
  */
@@ -111,7 +111,7 @@ declare global {
111
111
  * }
112
112
  * ```
113
113
  */
114
- function get_info(handle: number): timer.info | undefined;
114
+ function get_info(handle: number): timer.Info | undefined;
115
115
  /**
116
116
  * Manual triggering a callback for a timer.
117
117
  *
@@ -32,7 +32,6 @@ declare global {
32
32
  * : indexed by number 1 to the vector length. Example: `v[3]`
33
33
  */
34
34
  namespace vmath {
35
- type vector = Vector;
36
35
  /**
37
36
  * Calculates the conjugate of a quaternion. The result is a
38
37
  * quaternion with the same magnitudes but with the sign of
@@ -9,7 +9,7 @@ declare global {
9
9
  * Width and height are present for window.WINDOW_EVENT_RESIZED and
10
10
  * absent for other window events.
11
11
  */
12
- interface event_data {
12
+ interface EventData {
13
13
  /**
14
14
  * Window width after a resize.
15
15
  */
@@ -22,7 +22,7 @@ declare global {
22
22
  /**
23
23
  * Window safe-area data
24
24
  */
25
- interface safe_area {
25
+ interface SafeArea {
26
26
  /**
27
27
  * Safe-area x-coordinate.
28
28
  */
@@ -56,10 +56,8 @@ declare global {
56
56
  */
57
57
  inset_bottom: number;
58
58
  }
59
- type DimModeState = typeof window.DIMMING_UNKNOWN | typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
60
- type DimModeStateSettable = typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
61
- type DIMMING = typeof window.DIMMING_OFF | typeof window.DIMMING_ON | typeof window.DIMMING_UNKNOWN;
62
- type WINDOW_EVENT = typeof window.WINDOW_EVENT_DEICONIFIED | typeof window.WINDOW_EVENT_FOCUS_GAINED | typeof window.WINDOW_EVENT_FOCUS_LOST | typeof window.WINDOW_EVENT_ICONIFIED | typeof window.WINDOW_EVENT_RESIZED;
59
+ type Dimming = typeof window.DIMMING_OFF | typeof window.DIMMING_ON | typeof window.DIMMING_UNKNOWN;
60
+ type WindowEvent = typeof window.WINDOW_EVENT_DEICONIFIED | typeof window.WINDOW_EVENT_FOCUS_GAINED | typeof window.WINDOW_EVENT_FOCUS_LOST | typeof window.WINDOW_EVENT_ICONIFIED | typeof window.WINDOW_EVENT_RESIZED;
63
61
  /**
64
62
  * dimming mode off Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
65
63
  */
@@ -103,7 +101,7 @@ declare global {
103
101
  *
104
102
  * @returns The mode for screen dimming
105
103
  */
106
- function get_dim_mode(): window.DIMMING;
104
+ function get_dim_mode(): window.Dimming;
107
105
  /**
108
106
  * This returns the content scale of the current display.
109
107
  *
@@ -123,7 +121,7 @@ declare global {
123
121
  *
124
122
  * @returns safe area data
125
123
  */
126
- function get_safe_area(): window.safe_area;
124
+ function get_safe_area(): window.SafeArea;
127
125
  /**
128
126
  * This returns the current window size (width and height).
129
127
  */
@@ -135,7 +133,7 @@ declare global {
135
133
  *
136
134
  * @param mode - The mode for screen dimming
137
135
  */
138
- function set_dim_mode(mode: window.DimModeStateSettable): void;
136
+ function set_dim_mode(mode: Exclude<window.Dimming, typeof window.DIMMING_UNKNOWN>): void;
139
137
  /**
140
138
  * Sets a window event listener. Only one window event listener can be set at a time.
141
139
  *
@@ -161,7 +159,7 @@ declare global {
161
159
  * });
162
160
  * ```
163
161
  */
164
- function set_listener(callback: ((self: unknown, event: (typeof window)[Extract<keyof typeof window, `WINDOW_EVENT_${string}`>], data: window.event_data) => void) | undefined): void;
162
+ function set_listener(callback: ((self: unknown, event: (typeof window)[Extract<keyof typeof window, `WINDOW_EVENT_${string}`>], data: window.EventData) => void) | undefined): void;
165
163
  /**
166
164
  * Set the locking state for current mouse cursor on a PC platform.
167
165
  * This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked,
@@ -32,7 +32,6 @@ declare global {
32
32
  * : indexed by number 1 to the vector length. Example: `v[3]`
33
33
  */
34
34
  namespace vmath {
35
- type vector = Vector;
36
35
  /**
37
36
  * Calculates the conjugate of a quaternion. The result is a
38
37
  * quaternion with the same magnitudes but with the sign of
@@ -9,7 +9,7 @@ declare global {
9
9
  * Width and height are present for window.WINDOW_EVENT_RESIZED and
10
10
  * absent for other window events.
11
11
  */
12
- interface event_data {
12
+ interface EventData {
13
13
  /**
14
14
  * Window width after a resize.
15
15
  */
@@ -22,7 +22,7 @@ declare global {
22
22
  /**
23
23
  * Window safe-area data
24
24
  */
25
- interface safe_area {
25
+ interface SafeArea {
26
26
  /**
27
27
  * Safe-area x-coordinate.
28
28
  */
@@ -56,10 +56,8 @@ declare global {
56
56
  */
57
57
  inset_bottom: number;
58
58
  }
59
- type DimModeState = typeof window.DIMMING_UNKNOWN | typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
60
- type DimModeStateSettable = typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
61
- type DIMMING = typeof window.DIMMING_OFF | typeof window.DIMMING_ON | typeof window.DIMMING_UNKNOWN;
62
- type WINDOW_EVENT = typeof window.WINDOW_EVENT_DEICONIFIED | typeof window.WINDOW_EVENT_FOCUS_GAINED | typeof window.WINDOW_EVENT_FOCUS_LOST | typeof window.WINDOW_EVENT_ICONIFIED | typeof window.WINDOW_EVENT_RESIZED;
59
+ type Dimming = typeof window.DIMMING_OFF | typeof window.DIMMING_ON | typeof window.DIMMING_UNKNOWN;
60
+ type WindowEvent = typeof window.WINDOW_EVENT_DEICONIFIED | typeof window.WINDOW_EVENT_FOCUS_GAINED | typeof window.WINDOW_EVENT_FOCUS_LOST | typeof window.WINDOW_EVENT_ICONIFIED | typeof window.WINDOW_EVENT_RESIZED;
63
61
  /**
64
62
  * dimming mode off Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
65
63
  */
@@ -103,7 +101,7 @@ declare global {
103
101
  *
104
102
  * @returns The mode for screen dimming
105
103
  */
106
- function get_dim_mode(): window.DIMMING;
104
+ function get_dim_mode(): window.Dimming;
107
105
  /**
108
106
  * This returns the content scale of the current display.
109
107
  *
@@ -123,7 +121,7 @@ declare global {
123
121
  *
124
122
  * @returns safe area data
125
123
  */
126
- function get_safe_area(): window.safe_area;
124
+ function get_safe_area(): window.SafeArea;
127
125
  /**
128
126
  * This returns the current window size (width and height).
129
127
  */
@@ -135,7 +133,7 @@ declare global {
135
133
  *
136
134
  * @param mode - The mode for screen dimming
137
135
  */
138
- function set_dim_mode(mode: window.DimModeStateSettable): void;
136
+ function set_dim_mode(mode: Exclude<window.Dimming, typeof window.DIMMING_UNKNOWN>): void;
139
137
  /**
140
138
  * Sets a window event listener. Only one window event listener can be set at a time.
141
139
  *
@@ -161,7 +159,7 @@ declare global {
161
159
  * });
162
160
  * ```
163
161
  */
164
- function set_listener(callback: ((self: unknown, event: (typeof window)[Extract<keyof typeof window, `WINDOW_EVENT_${string}`>], data: window.event_data) => void) | undefined): void;
162
+ function set_listener(callback: ((self: unknown, event: (typeof window)[Extract<keyof typeof window, `WINDOW_EVENT_${string}`>], data: window.EventData) => void) | undefined): void;
165
163
  /**
166
164
  * Set the locking state for current mouse cursor on a PC platform.
167
165
  * This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked,
@@ -132,7 +132,6 @@
132
132
  "b2d.joint.LIMIT_STATE": "number",
133
133
  "b2d.shape.SHAPE_TYPE": "number",
134
134
  "buffer.VALUE_TYPE": "number",
135
- "buffer.ValueType": "number",
136
135
  "bullet3d.collision_object.ACTIVATION_STATE": "number",
137
136
  "bullet3d.collision_object.COLLISION_FLAG": "number",
138
137
  "bullet3d.collision_object.INTERNAL_TYPE": "number",
@@ -140,21 +139,15 @@
140
139
  "bullet3d.rigid_body.FLAG": "number",
141
140
  "bullet3d.shape.SHAPE_TYPE": "number",
142
141
  "camera.ORTHO_MODE": "number",
143
- "collectionfactory.Status": "number",
144
142
  "collectionfactory.STATUS": "number",
145
143
  "collectionproxy.RESULT": "number",
146
144
  "crash.SYSFIELD": "number",
147
- "factory.Status": "number",
148
145
  "factory.STATUS": "number",
149
- "go.Easing": "number",
150
146
  "go.EASING": "number",
151
- "go.Playback": "number",
152
147
  "go.PLAYBACK": "number",
153
148
  "graphics.BLEND_EQUATION": "number",
154
149
  "graphics.BLEND_FACTOR": "number",
155
- "graphics.BlendFactor": "number",
156
150
  "graphics.BUFFER_TYPE": "number",
157
- "graphics.BufferType": "number",
158
151
  "graphics.COMPARE_FUNC": "number",
159
152
  "graphics.COMPRESSION_TYPE": "number",
160
153
  "graphics.CONTEXT_FEATURE": "number",
@@ -163,7 +156,6 @@
163
156
  "graphics.DATA_TYPE": "number",
164
157
  "graphics.FACE_TYPE": "number",
165
158
  "graphics.SEMANTIC_TYPE": "number",
166
- "graphics.State": "number",
167
159
  "graphics.STATE": "number",
168
160
  "graphics.STENCIL_OP": "number",
169
161
  "graphics.TEXTURE_FILTER": "number",
@@ -172,43 +164,27 @@
172
164
  "graphics.TEXTURE_USAGE_FLAG": "number",
173
165
  "graphics.TEXTURE_WRAP": "number",
174
166
  "gui.ADJUST": "number",
175
- "gui.AdjustMode": "number",
176
167
  "gui.ANCHOR": "number",
177
168
  "gui.BLEND": "number",
178
- "gui.BlendMode": "number",
179
169
  "gui.CLIPPING_MODE": "number",
180
- "gui.ClippingMode": "number",
181
- "gui.Easing": "number",
182
170
  "gui.EASING": "number",
183
171
  "gui.KEYBOARD_TYPE": "number",
184
- "gui.KeyboardType": "number",
185
- "gui.NodeType": "number",
186
- "gui.PieBounds": "number",
187
172
  "gui.PIEBOUNDS": "number",
188
- "gui.Pivot": "number",
189
173
  "gui.PIVOT": "number",
190
- "gui.Playback": "number",
191
174
  "gui.PLAYBACK": "number",
192
175
  "gui.PROP": "number",
193
- "gui.Property": "number",
194
176
  "gui.RESULT": "number",
195
177
  "gui.SAFE_AREA": "number",
196
- "gui.SafeAreaMode": "number",
197
178
  "gui.SIZE_MODE": "number",
198
- "gui.SizeMode": "number",
199
179
  "gui.TYPE": "number",
200
- "gui.XAnchor": "number",
201
- "gui.YAnchor": "number",
202
180
  "image.TYPE": "string",
203
181
  "liveupdate.LIVEUPDATE": "number",
204
182
  "material.CONSTANT_TYPE": "number",
205
183
  "particlefx.EMITTER_STATE": "number",
206
184
  "physics.JOINT_TYPE": "number",
207
185
  "physics.SHAPE_TYPE": "number",
208
- "profiler.Mode": "number",
209
186
  "profiler.MODE": "number",
210
187
  "profiler.VIEW_MODE": "number",
211
- "profiler.ViewMode": "number",
212
188
  "render.ClearBufferKey": "number",
213
189
  "render.CONTEXT_EVENT": "number",
214
190
  "render.FRUSTUM_PLANES": "number",
@@ -216,12 +192,9 @@
216
192
  "render.RenderTargetTextureType": "number",
217
193
  "render.SORT": "number",
218
194
  "sys.NETWORK": "number",
219
- "sys.NetworkConnectivity": "number",
220
195
  "sys.REQUEST_STATUS": "number",
221
196
  "tilemap.TRANSFORM": "number",
222
197
  "window.DIMMING": "number",
223
- "window.DimModeState": "number",
224
- "window.DimModeStateSettable": "number",
225
198
  "window.WINDOW_EVENT": "number"
226
199
  },
227
200
  "stringConstants": [
@@ -439,6 +412,20 @@
439
412
  "pins": [["url"]],
440
413
  "adds": ["string", "Hash"]
441
414
  },
415
+ "go.animate:param:playback": {
416
+ "pins": [
417
+ [
418
+ "go.PLAYBACK_ONCE_FORWARD",
419
+ "go.PLAYBACK_ONCE_BACKWARD",
420
+ "go.PLAYBACK_ONCE_PINGPONG",
421
+ "go.PLAYBACK_LOOP_FORWARD",
422
+ "go.PLAYBACK_LOOP_BACKWARD",
423
+ "go.PLAYBACK_LOOP_PINGPONG"
424
+ ],
425
+ ["go.PLAYBACK"]
426
+ ],
427
+ "replaces": ["go.Playback"]
428
+ },
442
429
  "go.delete:param:id": {
443
430
  "pins": [
444
431
  ["string", "hash", "url", "table"],
@@ -456,6 +443,14 @@
456
443
  "gui.screen_to_local:param:screen_position": { "pins": [["vector3"]], "adds": ["Vector4"] },
457
444
  "gui.set_rotation:param:rotation": { "pins": [["quaternion", "vector4"]], "adds": ["Vector3"] },
458
445
  "gui.set_screen_position:param:screen_position": { "pins": [["vector3"]], "adds": ["Vector4"] },
446
+ "gui.set_xanchor:param:anchor": {
447
+ "pins": [["constant"], ["gui.ANCHOR"]],
448
+ "replaces": ["Exclude<gui.Anchor, typeof gui.ANCHOR_BOTTOM | typeof gui.ANCHOR_TOP>"]
449
+ },
450
+ "gui.set_yanchor:param:anchor": {
451
+ "pins": [["constant"], ["gui.ANCHOR"]],
452
+ "replaces": ["Exclude<gui.Anchor, typeof gui.ANCHOR_LEFT | typeof gui.ANCHOR_RIGHT>"]
453
+ },
459
454
  "model.get_mesh_enabled:param:mesh_id": {
460
455
  "pins": [["string", "hash", "url"]],
461
456
  "removes": ["Url"]
@@ -470,8 +465,10 @@
470
465
  "physics.set_maskbit:param:group": { "pins": [["string"]], "adds": ["Hash"] },
471
466
  "render.disable_state:param:state": {
472
467
  "pins": [["graphics.STATE"]],
473
- "adds": ["graphics.State"],
474
- "removes": ["graphics.STATE"]
468
+ "adds": [
469
+ "Exclude<graphics.State, typeof graphics.STATE_ALPHA_TEST_SUPPORTED | typeof graphics.STATE_SCISSOR_TEST>"
470
+ ],
471
+ "removes": ["graphics.State"]
475
472
  },
476
473
  "render.disable_texture:param:binding": {
477
474
  "pins": [["texture", "string", "hash"]],
@@ -485,8 +482,10 @@
485
482
  },
486
483
  "render.enable_state:param:state": {
487
484
  "pins": [["graphics.STATE"]],
488
- "adds": ["graphics.State"],
489
- "removes": ["graphics.STATE"]
485
+ "adds": [
486
+ "Exclude<graphics.State, typeof graphics.STATE_ALPHA_TEST_SUPPORTED | typeof graphics.STATE_SCISSOR_TEST>"
487
+ ],
488
+ "removes": ["graphics.State"]
490
489
  },
491
490
  "render.enable_texture:param:handle_or_name": {
492
491
  "pins": [["texture", "string", "hash"]],
@@ -560,8 +559,8 @@
560
559
  },
561
560
  "window.set_dim_mode:param:mode": {
562
561
  "pins": [["window.DIMMING"]],
563
- "adds": ["window.DimModeStateSettable"],
564
- "removes": ["window.DIMMING"]
562
+ "adds": ["Exclude<window.Dimming, typeof window.DIMMING_UNKNOWN>"],
563
+ "removes": ["window.Dimming"]
565
564
  }
566
565
  },
567
566
  "returnCorrections": {
@@ -582,7 +581,7 @@
582
581
  },
583
582
  "bullet3d.shape.get_shape": {
584
583
  "pins": [["bullet3d.shape.definition"]],
585
- "replaces": ["bullet3d.shape.definition", "{ type: typeof bullet3d.shape.SHAPE_TYPE_MESH }"]
584
+ "replaces": ["bullet3d.shape.Definition", "{ type: typeof bullet3d.shape.SHAPE_TYPE_MESH }"]
586
585
  },
587
586
  "collectionfactory.create": {
588
587
  "pins": [["table"], ["table<hash, hash>"]],
@@ -606,6 +605,14 @@
606
605
  "LuaTable<Hash, Opaque<\"node\">> & { get: LuaTableGetMethod<string, Opaque<\"node\">> }"
607
606
  ]
608
607
  },
608
+ "gui.get_xanchor": {
609
+ "pins": [["constant"], ["gui.ANCHOR"]],
610
+ "replaces": ["Exclude<gui.Anchor, typeof gui.ANCHOR_BOTTOM | typeof gui.ANCHOR_TOP>"]
611
+ },
612
+ "gui.get_yanchor": {
613
+ "pins": [["constant"], ["gui.ANCHOR"]],
614
+ "replaces": ["Exclude<gui.Anchor, typeof gui.ANCHOR_LEFT | typeof gui.ANCHOR_RIGHT>"]
615
+ },
609
616
  "gui.new_texture": {
610
617
  "pins": [["number"]],
611
618
  "replaces": ["number", "undefined"],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@defold-typescript/types",
3
- "version": "0.52.0",
3
+ "version": "0.53.0",
4
4
  "description": "TypeScript types for the Defold engine's Lua APIs.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -77,6 +77,7 @@
77
77
  "fixtures/messages_doc.json",
78
78
  "fixtures/defold-*",
79
79
  "!fixtures/defold-*/engine-bindings",
80
+ "!fixtures/defold-*/engine-evidence",
80
81
  "!fixtures/defold-*/annotations",
81
82
  "examples/translations.json",
82
83
  "!src/**/*.test.ts",
@@ -78,8 +78,12 @@ export function identityCorrections(): IdentityCorrections {
78
78
  key,
79
79
  {
80
80
  pins: correctionPins(correction),
81
- ...(correction.adds === undefined ? {} : { adds: union(correction.adds) }),
82
- ...(correction.removes === undefined ? {} : { removes: [...correction.removes] }),
81
+ ...(correction.ts !== undefined
82
+ ? { replaces: union(correction.ts) }
83
+ : {
84
+ ...(correction.adds === undefined ? {} : { adds: union(correction.adds) }),
85
+ ...(correction.removes === undefined ? {} : { removes: [...correction.removes] }),
86
+ }),
83
87
  },
84
88
  ]),
85
89
  ),
@@ -98,7 +102,9 @@ export function identityCorrections(): IdentityCorrections {
98
102
  ]),
99
103
  ),
100
104
  constantFamilies: Object.fromEntries(
101
- CONSTANT_UNION_ALIASES.map((alias) => [`${alias.home}.${alias.name}`, alias.members]),
105
+ CONSTANT_UNION_ALIASES.flatMap((alias) =>
106
+ "name" in alias ? [[`${alias.home}.${alias.name}`, alias.members] as const] : [],
107
+ ),
102
108
  ),
103
109
  };
104
110
  }
@@ -1,3 +1,4 @@
1
+ import type { SocketHandleReceiver } from "../src/core-types";
1
2
  import type { ModuleManifestEntry } from "./regen";
2
3
 
3
4
  // A method the engine shares across several handle classes where a release's
@@ -20,8 +21,8 @@ export const SHARED_HANDLE_METHODS: readonly SharedHandleMethod[] = (
20
21
  ).map((method) => ({
21
22
  namespace: "socket",
22
23
  method,
23
- source: "client",
24
- handles: ["master", "server"],
24
+ source: "client" satisfies SocketHandleReceiver,
25
+ handles: ["master", "server"] satisfies SocketHandleReceiver[],
25
26
  evidence: TCP_ANY,
26
27
  }));
27
28
 
package/src/api-doc.ts CHANGED
@@ -31,6 +31,8 @@ export interface ApiStruct {
31
31
  brief: string;
32
32
  description: string;
33
33
  members: ApiStructMember[];
34
+ /** See {@link ApiTypedef.declaredIn}. */
35
+ declaredIn?: string;
34
36
  }
35
37
 
36
38
  /** One `STRUCT` member; upstream marks an optional one with a `name?` suffix. */
@@ -73,6 +75,12 @@ export interface ApiTypedef {
73
75
  aliasOf?: string[];
74
76
  /** See {@link ApiFunction.global}. */
75
77
  global?: true;
78
+ /**
79
+ * The namespace of the ref-doc module that declared this type, set when
80
+ * `routeTypeDeclarations` moves it to another module; the reference lists it
81
+ * on the declaring module's page. Absent on a type its own module declares.
82
+ */
83
+ declaredIn?: string;
76
84
  }
77
85
 
78
86
  export interface ApiConstant {