@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
@@ -10,7 +10,7 @@ declare global {
10
10
  * Animation data accepted when creating or updating an atlas. Specify either
11
11
  * `frames`, or both `frame_start` and `frame_end`.
12
12
  */
13
- interface animation {
13
+ interface Animation {
14
14
  /**
15
15
  * Animation id.
16
16
  */
@@ -38,7 +38,7 @@ declare global {
38
38
  /**
39
39
  * Playback mode. The default is `go.PLAYBACK_ONCE_FORWARD`.
40
40
  */
41
- playback?: go.PLAYBACK;
41
+ playback?: go.Playback;
42
42
  /**
43
43
  * Animation frame rate. The default is 30.
44
44
  */
@@ -55,7 +55,7 @@ declare global {
55
55
  /**
56
56
  * Animation data returned by resource.get_atlas.
57
57
  */
58
- interface animation_data {
58
+ interface AnimationData {
59
59
  /**
60
60
  * Animation id.
61
61
  */
@@ -75,7 +75,7 @@ declare global {
75
75
  /**
76
76
  * Playback mode.
77
77
  */
78
- playback: go.PLAYBACK;
78
+ playback: go.Playback;
79
79
  /**
80
80
  * Animation frame rate.
81
81
  */
@@ -92,7 +92,7 @@ declare global {
92
92
  /**
93
93
  * Data accepted by resource.create_atlas and resource.set_atlas.
94
94
  */
95
- interface atlas {
95
+ interface Atlas {
96
96
  /**
97
97
  * Path to the texture resource, for example `"/main/my_texture.texturec"`.
98
98
  */
@@ -100,16 +100,16 @@ declare global {
100
100
  /**
101
101
  * Animations in the atlas.
102
102
  */
103
- animations: [Omit<resource.animation, "frame_start" | "frame_end"> & ({ frames: [number, ...number[]] } | { frame_start: number; frame_end: number }), ...(Omit<resource.animation, "frame_start" | "frame_end"> & ({ frames: [number, ...number[]] } | { frame_start: number; frame_end: number }))[]];
103
+ animations: [Omit<resource.Animation, "frame_start" | "frame_end"> & ({ frames: [number, ...number[]] } | { frame_start: number; frame_end: number }), ...(Omit<resource.Animation, "frame_start" | "frame_end"> & ({ frames: [number, ...number[]] } | { frame_start: number; frame_end: number }))[]];
104
104
  /**
105
105
  * Geometries that map to the texture data.
106
106
  */
107
- geometries: [resource.geometry, ...resource.geometry[]];
107
+ geometries: [resource.Geometry, ...resource.Geometry[]];
108
108
  }
109
109
  /**
110
110
  * Data returned by resource.get_atlas.
111
111
  */
112
- interface atlas_data {
112
+ interface AtlasData {
113
113
  /**
114
114
  * Path to the texture resource.
115
115
  */
@@ -117,16 +117,16 @@ declare global {
117
117
  /**
118
118
  * Animations in the atlas.
119
119
  */
120
- animations: resource.animation_data[];
120
+ animations: resource.AnimationData[];
121
121
  /**
122
122
  * Geometries that map to the texture data.
123
123
  */
124
- geometries: resource.geometry_data[];
124
+ geometries: resource.GeometryData[];
125
125
  }
126
126
  /**
127
127
  * Buffer-resource creation parameters
128
128
  */
129
- interface buffer_creation_params {
129
+ interface BufferCreationParams {
130
130
  /**
131
131
  * Buffer to bind to the resource.
132
132
  */
@@ -139,7 +139,7 @@ declare global {
139
139
  /**
140
140
  * Buffer-resource update options
141
141
  */
142
- interface buffer_update_options {
142
+ interface BufferUpdateOptions {
143
143
  /**
144
144
  * Whether the resource takes ownership of the buffer. The default is false.
145
145
  */
@@ -149,7 +149,7 @@ declare global {
149
149
  * Geometry data accepted when creating or updating an atlas. Vertex, UV, and
150
150
  * index values are zero-based.
151
151
  */
152
- interface geometry {
152
+ interface Geometry {
153
153
  /**
154
154
  * Geometry name, used when matching animations between atlases.
155
155
  */
@@ -190,7 +190,7 @@ declare global {
190
190
  /**
191
191
  * Geometry data returned by resource.get_atlas.
192
192
  */
193
- interface geometry_data {
193
+ interface GeometryData {
194
194
  /**
195
195
  * Width of the image represented by the geometry.
196
196
  */
@@ -227,7 +227,7 @@ declare global {
227
227
  /**
228
228
  * Render target attachment information
229
229
  */
230
- interface render_target_attachment_info {
230
+ interface RenderTargetAttachmentInfo {
231
231
  /**
232
232
  * Opaque texture handle.
233
233
  */
@@ -255,15 +255,15 @@ declare global {
255
255
  /**
256
256
  * Texture usage flags.
257
257
  */
258
- flags: graphics.TEXTURE_USAGE_FLAG | number;
258
+ flags: graphics.TextureUsageFlag | number;
259
259
  /**
260
260
  * Texture type.
261
261
  */
262
- type: graphics.TEXTURE_TYPE;
262
+ type: graphics.TextureType;
263
263
  /**
264
264
  * Render-target buffer type.
265
265
  */
266
- buffer_type: graphics.BUFFER_TYPE;
266
+ buffer_type: graphics.BufferType;
267
267
  /**
268
268
  * Backing texture resource, when present.
269
269
  */
@@ -272,7 +272,7 @@ declare global {
272
272
  /**
273
273
  * Render target information
274
274
  */
275
- interface render_target_info {
275
+ interface RenderTargetInfo {
276
276
  /**
277
277
  * Opaque render-target handle.
278
278
  */
@@ -284,13 +284,12 @@ declare global {
284
284
  /**
285
285
  * Render-target attachments.
286
286
  */
287
- attachments: resource.render_target_attachment_info[];
287
+ attachments: resource.RenderTargetAttachmentInfo[];
288
288
  }
289
- type resource_data = Hash;
290
289
  /**
291
290
  * Sound-data creation options
292
291
  */
293
- interface sound_data_options {
292
+ interface SoundDataOptions {
294
293
  /**
295
294
  * Raw sound file data, including the file header.
296
295
  */
@@ -307,7 +306,7 @@ declare global {
307
306
  /**
308
307
  * Text metrics
309
308
  */
310
- interface text_metrics {
309
+ interface TextMetrics {
311
310
  /**
312
311
  * Text width.
313
312
  */
@@ -328,7 +327,7 @@ declare global {
328
327
  /**
329
328
  * Text metric options
330
329
  */
331
- interface text_metrics_options {
330
+ interface TextMetricsOptions {
332
331
  /**
333
332
  * Text-field width; unused when `line_break` is false.
334
333
  */
@@ -349,11 +348,11 @@ declare global {
349
348
  /**
350
349
  * Texture creation parameters
351
350
  */
352
- interface texture_creation_params {
351
+ interface TextureCreationParams {
353
352
  /**
354
353
  * Texture type.
355
354
  */
356
- type: graphics.TEXTURE_TYPE;
355
+ type: graphics.TextureType;
357
356
  /**
358
357
  * Texture width in pixels; must be greater than zero.
359
358
  */
@@ -373,11 +372,11 @@ declare global {
373
372
  /**
374
373
  * Texture format. Device-specific unsupported constants evaluate to `nil`.
375
374
  */
376
- format: graphics.TEXTURE_FORMAT;
375
+ format: graphics.TextureFormat;
377
376
  /**
378
377
  * Creation-usage hints. The default is graphics.TEXTURE_USAGE_FLAG_SAMPLE.
379
378
  */
380
- flags?: graphics.TEXTURE_USAGE_FLAG | number;
379
+ flags?: graphics.TextureUsageFlag | number;
381
380
  /**
382
381
  * Maximum mipmap count. The default is zero.
383
382
  */
@@ -385,12 +384,12 @@ declare global {
385
384
  /**
386
385
  * Compression used by the supplied buffer. The default is graphics.COMPRESSION_TYPE_DEFAULT.
387
386
  */
388
- compression_type?: graphics.COMPRESSION_TYPE;
387
+ compression_type?: graphics.CompressionType;
389
388
  }
390
389
  /**
391
390
  * Asynchronous texture creation result
392
391
  */
393
- interface texture_creation_result {
392
+ interface TextureCreationResult {
394
393
  /**
395
394
  * Created texture resource path.
396
395
  */
@@ -399,7 +398,7 @@ declare global {
399
398
  /**
400
399
  * Texture information
401
400
  */
402
- interface texture_info {
401
+ interface TextureInfo {
403
402
  /**
404
403
  * Opaque texture handle.
405
404
  */
@@ -427,20 +426,20 @@ declare global {
427
426
  /**
428
427
  * Texture usage flags.
429
428
  */
430
- flags: graphics.TEXTURE_USAGE_FLAG | number;
429
+ flags: graphics.TextureUsageFlag | number;
431
430
  /**
432
431
  * Texture type.
433
432
  */
434
- type: graphics.TEXTURE_TYPE;
433
+ type: graphics.TextureType;
435
434
  }
436
435
  /**
437
436
  * Texture update parameters
438
437
  */
439
- interface texture_update_params {
438
+ interface TextureUpdateParams {
440
439
  /**
441
440
  * Texture type.
442
441
  */
443
- type: graphics.TEXTURE_TYPE;
442
+ type: graphics.TextureType;
444
443
  /**
445
444
  * Update width in pixels.
446
445
  */
@@ -456,7 +455,7 @@ declare global {
456
455
  /**
457
456
  * Texture format. Device-specific unsupported constants evaluate to `nil`.
458
457
  */
459
- format: graphics.TEXTURE_FORMAT;
458
+ format: graphics.TextureFormat;
460
459
  /**
461
460
  * X offset in pixels.
462
461
  */
@@ -480,7 +479,7 @@ declare global {
480
479
  /**
481
480
  * Compression used by the supplied buffer. The default is graphics.COMPRESSION_TYPE_DEFAULT.
482
481
  */
483
- compression_type?: graphics.COMPRESSION_TYPE;
482
+ compression_type?: graphics.CompressionType;
484
483
  }
485
484
  /**
486
485
  * Constructor-like function with two purposes:
@@ -615,7 +614,7 @@ declare global {
615
614
  * });
616
615
  * ```
617
616
  */
618
- function create_atlas(path: string, table: resource.atlas): Hash;
617
+ function create_atlas(path: string, table: resource.Atlas): Hash;
619
618
  /**
620
619
  * This function creates a new buffer resource that can be used in the same way as any buffer created during build time.
621
620
  * The function requires a valid buffer created from either buffer.create or another pre-existing buffer resource.
@@ -682,7 +681,7 @@ declare global {
682
681
  * });
683
682
  * ```
684
683
  */
685
- function create_buffer(path: string, table: resource.buffer_creation_params): Hash;
684
+ function create_buffer(path: string, table: resource.BufferCreationParams): Hash;
686
685
  /**
687
686
  * Creates a sound data resource
688
687
  * Supported formats are .oggc, .opusc and .wavc
@@ -708,7 +707,7 @@ declare global {
708
707
  * });
709
708
  * ```
710
709
  */
711
- function create_sound_data(path: string, options: resource.sound_data_options & ({ partial?: false } | ({ partial: true } & Required<Pick<resource.sound_data_options, "filesize">>))): Hash;
710
+ function create_sound_data(path: string, options: resource.SoundDataOptions & ({ partial?: false } | ({ partial: true } & Required<Pick<resource.SoundDataOptions, "filesize">>))): Hash;
712
711
  /**
713
712
  * Creates a new texture resource that can be used in the same way as any texture created during build time.
714
713
  * The path used for creating the texture must be unique, trying to create a resource at a path that is already
@@ -836,7 +835,7 @@ declare global {
836
835
  * }
837
836
  * ```
838
837
  */
839
- function create_texture(path: string, table: resource.texture_creation_params, buffer?: Opaque<"buffer"> & { length: LuaLengthMethod<number> }): Hash;
838
+ function create_texture(path: string, table: resource.TextureCreationParams, buffer?: Opaque<"buffer"> & { length: LuaLengthMethod<number> }): Hash;
840
839
  /**
841
840
  * Creates a new texture resource that can be used in the same way as any texture created during build time.
842
841
  * The path used for creating the texture must be unique, trying to create a resource at a path that is already
@@ -871,7 +870,7 @@ declare global {
871
870
  * Create a texture resource asyncronously with a buffer and a callback
872
871
  * ```ts
873
872
  * // Create a texture resource asyncronously with a buffer and a callback
874
- * function callback(self: unknown, request_id: number, result: resource.texture_creation_result) {
873
+ * function callback(self: unknown, request_id: number, result: resource.TextureCreationResult) {
875
874
  * // The resource has been updated with a new texture,
876
875
  * // so we can update other systems with the new handle,
877
876
  * // or update components to use the resource if we want
@@ -955,7 +954,7 @@ declare global {
955
954
  * });
956
955
  * ```
957
956
  */
958
- function create_texture_async(path: string, table: resource.texture_creation_params, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> } | undefined, callback: (self: unknown, request_id: number, result: resource.texture_creation_result) => void): LuaMultiReturn<[Hash, number]>;
957
+ function create_texture_async(path: string, table: resource.TextureCreationParams, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> } | undefined, callback: (self: unknown, request_id: number, result: resource.TextureCreationResult) => void): LuaMultiReturn<[Hash, number]>;
959
958
  /**
960
959
  * Constructor-like function with two purposes:
961
960
  *
@@ -1002,7 +1001,7 @@ declare global {
1002
1001
  * @param path - The path to the atlas resource
1003
1002
  * @returns atlas data. **⚠️ `frames` is 1-based; passed to Defold unchanged.** **0️⃣ `indices` is 0-based; passed to Defold unchanged.**
1004
1003
  */
1005
- function get_atlas(path: Hash | string): resource.atlas_data;
1004
+ function get_atlas(path: Hash | string): resource.AtlasData;
1006
1005
  /**
1007
1006
  * gets the buffer from a resource
1008
1007
  *
@@ -1013,7 +1012,7 @@ declare global {
1013
1012
  * // How to get the data from a buffer
1014
1013
  * export default defineScript({
1015
1014
  * init() {
1016
- * const res_path = go.get<mesh.properties>()("#mesh", "vertices");
1015
+ * const res_path = go.get<mesh.Properties>()("#mesh", "vertices");
1017
1016
  * const buf = resource.get_buffer(res_path);
1018
1017
  * const stream_positions = buffer.get_stream(buf, "position");
1019
1018
  *
@@ -1059,7 +1058,7 @@ declare global {
1059
1058
  * });
1060
1059
  * ```
1061
1060
  */
1062
- function get_render_target_info(path: Hash | string | Opaque<"render_target"> | number): resource.render_target_info;
1061
+ function get_render_target_info(path: Hash | string | Opaque<"render_target"> | number): resource.RenderTargetInfo;
1063
1062
  /**
1064
1063
  * Gets the text metrics from a font. Rich text markup is measured using its
1065
1064
  * visible text and font sizes. If markup cannot be parsed, the text is measured literally.
@@ -1073,14 +1072,14 @@ declare global {
1073
1072
  * ```ts
1074
1073
  * export default defineScript({
1075
1074
  * init() {
1076
- * const font = go.get<label.properties>()("#label", "font");
1075
+ * const font = go.get<label.Properties>()("#label", "font");
1077
1076
  * const metrics = resource.get_text_metrics(font, "The quick brown fox\n jumps over the lazy dog");
1078
1077
  * pprint(metrics);
1079
1078
  * },
1080
1079
  * });
1081
1080
  * ```
1082
1081
  */
1083
- function get_text_metrics(url: Hash | string, text: string): resource.text_metrics;
1082
+ function get_text_metrics(url: Hash | string, text: string): resource.TextMetrics;
1084
1083
  /**
1085
1084
  * Gets the text metrics from a font. Rich text markup is measured using its
1086
1085
  * visible text and font sizes. If markup cannot be parsed, the text is measured literally.
@@ -1094,14 +1093,14 @@ declare global {
1094
1093
  * ```ts
1095
1094
  * export default defineScript({
1096
1095
  * init() {
1097
- * const font = go.get<label.properties>()("#label", "font");
1096
+ * const font = go.get<label.Properties>()("#label", "font");
1098
1097
  * const metrics = resource.get_text_metrics(font, "The quick brown fox\n jumps over the lazy dog");
1099
1098
  * pprint(metrics);
1100
1099
  * },
1101
1100
  * });
1102
1101
  * ```
1103
1102
  */
1104
- function get_text_metrics(url: Hash | string, text: string, options: resource.text_metrics_options): resource.text_metrics;
1103
+ function get_text_metrics(url: Hash | string, text: string, options: resource.TextMetricsOptions): resource.TextMetrics;
1105
1104
  /**
1106
1105
  * Gets texture info from a texture resource path or a texture handle
1107
1106
  *
@@ -1155,7 +1154,7 @@ declare global {
1155
1154
  * });
1156
1155
  * ```
1157
1156
  */
1158
- function get_texture_info(path: Hash | string | Opaque<"texture"> | number): resource.texture_info;
1157
+ function get_texture_info(path: Hash | string | Opaque<"texture"> | number): resource.TextureInfo;
1159
1158
  /**
1160
1159
  * Loads the resource data for a specific resource.
1161
1160
  *
@@ -1260,7 +1259,7 @@ declare global {
1260
1259
  * // Assuming the folder "/res" is added to the project custom resources:
1261
1260
  * // load a texture resource and set it on a sprite
1262
1261
  * const buffer = resource.load("/res/new.texturec");
1263
- * resource.set(go.get<sprite.properties>()("#sprite", "texture0"), buffer);
1262
+ * resource.set(go.get<sprite.Properties>()("#sprite", "texture0"), buffer);
1264
1263
  * ```
1265
1264
  */
1266
1265
  function set(path: string | Hash, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }): void;
@@ -1345,7 +1344,7 @@ declare global {
1345
1344
  * });
1346
1345
  * ```
1347
1346
  */
1348
- function set_atlas(path: Hash | string, table: resource.atlas): void;
1347
+ function set_atlas(path: Hash | string, table: resource.Atlas): void;
1349
1348
  /**
1350
1349
  * Sets the buffer of a resource. By default, setting the resource buffer will either copy the data from the incoming buffer object
1351
1350
  * to the buffer stored in the destination resource, or make a new buffer object if the sizes between the source buffer and the destination buffer
@@ -1369,7 +1368,7 @@ declare global {
1369
1368
  *
1370
1369
  * export default defineScript({
1371
1370
  * init() {
1372
- * const res_path = go.get<mesh.properties>()("#mesh", "vertices");
1371
+ * const res_path = go.get<mesh.Properties>()("#mesh", "vertices");
1373
1372
  *
1374
1373
  * const positions = [
1375
1374
  * 1, -1, 0,
@@ -1392,7 +1391,7 @@ declare global {
1392
1391
  * });
1393
1392
  * ```
1394
1393
  */
1395
- function set_buffer(path: Hash | string, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, table?: resource.buffer_update_options): void;
1394
+ function set_buffer(path: Hash | string, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, table?: resource.BufferUpdateOptions): void;
1396
1395
  /**
1397
1396
  * Update internal sound resource (wavc/oggc/opusc) with new data
1398
1397
  *
@@ -1445,7 +1444,7 @@ declare global {
1445
1444
  * // the engine registers a texture format only when the driver supports it
1446
1445
  * const format = graphics.TEXTURE_FORMAT_RGB;
1447
1446
  * if (format !== undefined) {
1448
- * const resource_path = go.get<model.properties>()("#model", "texture0");
1447
+ * const resource_path = go.get<model.Properties>()("#model", "texture0");
1449
1448
  * const args = { width, height, type: graphics.TEXTURE_TYPE_2D, format, num_mip_maps: 1 };
1450
1449
  * resource.set_texture(resource_path, args, buf);
1451
1450
  * }
@@ -1478,7 +1477,7 @@ declare global {
1478
1477
  * // the engine registers a texture format only when the driver supports it
1479
1478
  * const format = graphics.TEXTURE_FORMAT_RGB;
1480
1479
  * if (format !== undefined) {
1481
- * const resource_path = go.get<model.properties>()("#model", "texture0");
1480
+ * const resource_path = go.get<model.Properties>()("#model", "texture0");
1482
1481
  * const args = { width, height, x, y, type: graphics.TEXTURE_TYPE_2D, format, num_mip_maps: 1 };
1483
1482
  * resource.set_texture(resource_path, args, buf);
1484
1483
  * }
@@ -1499,7 +1498,7 @@ declare global {
1499
1498
  * // the engine registers a texture format only when the driver supports it
1500
1499
  * const format = graphics.TEXTURE_FORMAT_RGB;
1501
1500
  * if (format === undefined) return;
1502
- * const resource_path = go.get<model.properties>()("#model", "texture0");
1501
+ * const resource_path = go.get<model.Properties>()("#model", "texture0");
1503
1502
  * // the "my_buffer" resource is expected to hold 128 * 128 * 3 bytes!
1504
1503
  * const args = {
1505
1504
  * width: 128,
@@ -1592,7 +1591,7 @@ declare global {
1592
1591
  * }
1593
1592
  * ```
1594
1593
  */
1595
- function set_texture(path: Hash | string, table: resource.texture_update_params, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }): void;
1594
+ function set_texture(path: Hash | string, table: resource.TextureUpdateParams, buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }): void;
1596
1595
  /**
1597
1596
  * Constructor-like function with two purposes:
1598
1597
  *
@@ -21,13 +21,8 @@ declare global {
21
21
  * LuaSocket is free software, released under the MIT license (same license as the Lua core).
22
22
  */
23
23
  namespace socket {
24
- type socket_client = client;
25
- type socket_connected = connected;
26
- type socket_master = master;
27
- type socket_selectable = master | client | server | connected | unconnected | { getfd: (self: unknown) => number; dirty: (self: unknown) => boolean };
28
- type socket_server = server;
29
- type socket_unconnected = unconnected;
30
- interface client {
24
+ type SocketSelectable = SocketMaster | SocketClient | SocketServer | SocketConnected | SocketUnconnected | { getfd: (self: unknown) => number; dirty: (self: unknown) => boolean };
25
+ interface SocketClient {
31
26
  /**
32
27
  * Closes the TCP object. The internal socket used by the object is closed and the local address to which the object was bound is made available to other applications. No further operations (except for further calls to the close method) are allowed on a closed socket.
33
28
  * It is important to close all used sockets once they are not needed, since, in many systems, each socket uses a file descriptor, which are limited system resources. Garbage-collected objects are automatically closed before destruction, though.
@@ -170,7 +165,7 @@ declare global {
170
165
  */
171
166
  shutdown(mode: string): number;
172
167
  }
173
- interface connected {
168
+ interface SocketConnected {
174
169
  /**
175
170
  * Closes a UDP object. The internal socket used by the object is closed and the local address to which the object was bound is made available to other applications. No further operations (except for further calls to the close method) are allowed on a closed socket.
176
171
  * It is important to close all used sockets once they are not needed, since, in many systems, each socket uses a file descriptor, which are limited system resources. Garbage-collected objects are automatically closed before destruction, though.
@@ -270,7 +265,7 @@ declare global {
270
265
  */
271
266
  settimeout(value?: number): number;
272
267
  }
273
- interface master {
268
+ interface SocketMaster {
274
269
  /**
275
270
  * Binds a master object to address and port on the local host.
276
271
  *
@@ -352,12 +347,12 @@ declare global {
352
347
  */
353
348
  settimeout(value?: number, mode?: string): number;
354
349
  }
355
- interface server {
350
+ interface SocketServer {
356
351
  /**
357
352
  * Waits for a remote connection on the server object and returns a client object representing that connection.
358
353
  * Calling `socket.select` with a server object in the `recvt` parameter before a call to accept does not guarantee accept will return immediately. Use the `settimeout` method or accept might block until another client shows up.
359
354
  */
360
- accept(): LuaMultiReturn<[client | undefined, string | undefined]>;
355
+ accept(): LuaMultiReturn<[SocketClient | undefined, string | undefined]>;
361
356
  /**
362
357
  * Closes the TCP object. The internal socket used by the object is closed and the local address to which the object was bound is made available to other applications. No further operations (except for further calls to the close method) are allowed on a closed socket.
363
358
  * It is important to close all used sockets once they are not needed, since, in many systems, each socket uses a file descriptor, which are limited system resources. Garbage-collected objects are automatically closed before destruction, though.
@@ -453,7 +448,7 @@ declare global {
453
448
  */
454
449
  settimeout(value?: number, mode?: string): number;
455
450
  }
456
- interface unconnected {
451
+ interface SocketUnconnected {
457
452
  /**
458
453
  * Closes a UDP object. The internal socket used by the object is closed and the local address to which the object was bound is made available to other applications. No further operations (except for further calls to the close method) are allowed on a closed socket.
459
454
  * It is important to close all used sockets once they are not needed, since, in many systems, each socket uses a file descriptor, which are limited system resources. Garbage-collected objects are automatically closed before destruction, though.
@@ -586,7 +581,7 @@ declare global {
586
581
  * @param locport - optional local port to bind to.
587
582
  * @param family - optional socket family to use, `"inet"` or `"inet6"`.
588
583
  */
589
- function connect(address: string, port: number, locaddr?: string, locport?: number, family?: string): LuaMultiReturn<[client | undefined, string | undefined]>;
584
+ function connect(address: string, port: number, locaddr?: string, locport?: number, family?: string): LuaMultiReturn<[SocketClient | undefined, string | undefined]>;
590
585
  /**
591
586
  * Returns the time in seconds, relative to the system epoch (Unix epoch time since January 1, 1970 (UTC) or Windows file time since January 1, 1601 (UTC)).
592
587
  * You should use the values returned by this function for relative measurements only.
@@ -665,7 +660,7 @@ declare global {
665
660
  * @param sendt - array with sockets or compatible objects that are watched to see if it is OK to immediately write on them.
666
661
  * @param timeout - the maximum amount of time (in seconds) to wait for a change in status. Nil, negative or omitted timeout value allows the function to block indefinitely.
667
662
  */
668
- function select(recvt: socket.socket_selectable[], sendt: socket.socket_selectable[], timeout?: number): LuaMultiReturn<[(client | master | unconnected)[], (client | master | unconnected)[], string | undefined]>;
663
+ function select(recvt: socket.SocketSelectable[], sendt: socket.SocketSelectable[], timeout?: number): LuaMultiReturn<[(SocketClient | SocketMaster | SocketUnconnected)[], (SocketClient | SocketMaster | SocketUnconnected)[], string | undefined]>;
669
664
  /**
670
665
  * This function drops a number of arguments and returns the remaining.
671
666
  * It is useful to avoid creation of dummy variables:
@@ -700,26 +695,26 @@ declare global {
700
695
  /**
701
696
  * Creates and returns an IPv4 TCP master object. A master object can be transformed into a server object with the method `listen` (after a call to `bind`) or into a client object with the method `connect`. The only other method supported by a master object is the `close` method.
702
697
  */
703
- function tcp(): LuaMultiReturn<[master | undefined, string | undefined]>;
698
+ function tcp(): LuaMultiReturn<[SocketMaster | undefined, string | undefined]>;
704
699
  /**
705
700
  * Creates and returns an IPv6 TCP master object. A master object can be transformed into a server object with the method `listen` (after a call to `bind`) or into a client object with the method connect. The only other method supported by a master object is the close method.
706
701
  * Note: The TCP object returned will have the option "ipv6-v6only" set to true.
707
702
  */
708
- function tcp6(): LuaMultiReturn<[master | undefined, string | undefined]>;
703
+ function tcp6(): LuaMultiReturn<[SocketMaster | undefined, string | undefined]>;
709
704
  /**
710
705
  * Creates and returns an unconnected IPv4 UDP object. Unconnected objects support the `sendto`, `receive`, `receivefrom`, `getoption`, `getsockname`, `setoption`, `settimeout`, `setpeername`, `setsockname`, and `close` methods. The `setpeername` method is used to connect the object.
711
706
  */
712
- function udp(): LuaMultiReturn<[unconnected | undefined, string | undefined]>;
707
+ function udp(): LuaMultiReturn<[SocketUnconnected | undefined, string | undefined]>;
713
708
  /**
714
709
  * Creates and returns an unconnected IPv6 UDP object. Unconnected objects support the `sendto`, `receive`, `receivefrom`, `getoption`, `getsockname`, `setoption`, `settimeout`, `setpeername`, `setsockname`, and `close` methods. The `setpeername` method is used to connect the object.
715
710
  * Note: The UDP object returned will have the option "ipv6-v6only" set to true.
716
711
  */
717
- function udp6(): LuaMultiReturn<[unconnected | undefined, string | undefined]>;
712
+ function udp6(): LuaMultiReturn<[SocketUnconnected | undefined, string | undefined]>;
718
713
  namespace dns {
719
714
  /**
720
715
  * DNS address information
721
716
  */
722
- interface address_info {
717
+ interface AddressInfo {
723
718
  /**
724
719
  * `"inet"` for IPv4 or `"inet6"` for IPv6
725
720
  */
@@ -732,7 +727,7 @@ declare global {
732
727
  /**
733
728
  * DNS host information
734
729
  */
735
- interface host_info {
730
+ interface HostInfo {
736
731
  /**
737
732
  * canonical host name
738
733
  */
@@ -753,7 +748,7 @@ declare global {
753
748
  *
754
749
  * @param address - a hostname or an IPv4 or IPv6 address.
755
750
  */
756
- function getaddrinfo(address: string): LuaMultiReturn<[socket.dns.address_info[] | undefined, string | undefined]>;
751
+ function getaddrinfo(address: string): LuaMultiReturn<[socket.dns.AddressInfo[] | undefined, string | undefined]>;
757
752
  /**
758
753
  * Returns the standard host name for the machine as a string.
759
754
  *
@@ -782,14 +777,14 @@ declare global {
782
777
  *
783
778
  * @param address - an IPv4 address or host name.
784
779
  */
785
- function tohostname(address: string): LuaMultiReturn<[string | undefined, socket.dns.host_info | string]>;
780
+ function tohostname(address: string): LuaMultiReturn<[string | undefined, socket.dns.HostInfo | string]>;
786
781
  /**
787
782
  * This function converts a host name to IPv4 address.
788
783
  * The address can be an IP address or a host name.
789
784
  *
790
785
  * @param address - a hostname or an IP address.
791
786
  */
792
- function toip(address: string): LuaMultiReturn<[string | undefined, socket.dns.host_info | string]>;
787
+ function toip(address: string): LuaMultiReturn<[string | undefined, socket.dns.HostInfo | string]>;
793
788
  }
794
789
  }
795
790
  }
@@ -11,7 +11,7 @@ declare global {
11
11
  * Data passed to the completion callback of sound.play. The callback's
12
12
  * `message_id` indicates whether playback finished or was stopped manually.
13
13
  */
14
- interface play_completion {
14
+ interface PlayCompletion {
15
15
  /**
16
16
  * The sequential play identifier for the playback.
17
17
  */
@@ -20,7 +20,7 @@ declare global {
20
20
  /**
21
21
  * Sound playback properties
22
22
  */
23
- interface play_properties {
23
+ interface PlayProperties {
24
24
  /**
25
25
  * Delay in seconds before playback starts. The default is 0.
26
26
  */
@@ -49,7 +49,7 @@ declare global {
49
49
  /**
50
50
  * Sound stop properties
51
51
  */
52
- interface stop_properties {
52
+ interface StopProperties {
53
53
  /**
54
54
  * Sequential playback identifier returned by sound.play.
55
55
  */
@@ -241,7 +241,7 @@ declare global {
241
241
  * });
242
242
  * ```
243
243
  */
244
- function play(url: string | Hash | Url, play_properties?: sound.play_properties, complete_function?: (self: unknown, message_id: Hash, message: sound.play_completion, sender: Url) => void): number;
244
+ function play(url: string | Hash | Url, play_properties?: sound.PlayProperties, complete_function?: (self: unknown, message_id: Hash, message: sound.PlayCompletion, sender: Url) => void): number;
245
245
  /**
246
246
  * Set gain on all active playing voices of a sound.
247
247
  *
@@ -295,8 +295,8 @@ declare global {
295
295
  * sound.stop("#sound", { play_id: id });
296
296
  * ```
297
297
  */
298
- function stop(url: string | Hash | Url, stop_properties?: sound.stop_properties): void;
299
- interface properties {
298
+ function stop(url: string | Hash | Url, stop_properties?: sound.StopProperties): void;
299
+ interface Properties {
300
300
  /**
301
301
  * The gain on the sound-component. Note that gain is in linear scale,
302
302
  * between 0 and 1.