@defold-typescript/types 0.51.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.
- package/api-availability.json +4 -58
- package/api-signatures.json +2804 -3172
- package/api-targets.json +15 -5
- package/examples/translations.json +19 -71
- package/generated/b2d.d.ts +39 -39
- package/generated/b2d_body.d.ts +11 -11
- package/generated/b2d_chain.d.ts +3 -3
- package/generated/b2d_fixture.d.ts +5 -5
- package/generated/b2d_joint.d.ts +29 -29
- package/generated/b2d_shape.d.ts +13 -13
- package/generated/b2d_world.d.ts +15 -15
- package/generated/buffer.d.ts +10 -11
- package/generated/bullet3d.d.ts +6 -6
- package/generated/bullet3d_collision_object.d.ts +10 -10
- package/generated/bullet3d_constraint.d.ts +173 -71
- package/generated/bullet3d_rigid_body.d.ts +3 -3
- package/generated/bullet3d_shape.d.ts +11 -11
- package/generated/bullet3d_world.d.ts +20 -20
- package/generated/camera.d.ts +4 -4
- package/generated/collectionfactory.d.ts +2 -3
- package/generated/collectionproxy.d.ts +5 -5
- package/generated/compute.d.ts +5 -5
- package/generated/crash.d.ts +7 -7
- package/generated/editor-vm/http.d.ts +13 -13
- package/generated/editor-vm/image.d.ts +4 -4
- package/generated/editor-vm/json.d.ts +1 -1
- package/generated/editor-vm/tilemap_tiles.d.ts +9 -9
- package/generated/editor-vm/zip.d.ts +4 -4
- package/generated/editor.d.ts +183 -183
- package/generated/factory.d.ts +2 -3
- package/generated/font.d.ts +4 -4
- package/generated/go.d.ts +122 -230
- package/generated/graphics.d.ts +23 -25
- package/generated/gui.d.ts +186 -423
- package/generated/http.d.ts +3 -3
- package/generated/image.d.ts +63 -11
- package/generated/json.d.ts +4 -4
- package/generated/kinds/gui-script.d.ts +2 -0
- package/generated/kinds/render-script.d.ts +14 -15
- package/generated/label.d.ts +5 -5
- package/generated/liveupdate.d.ts +7 -3
- package/generated/material.d.ts +49 -49
- package/generated/model.d.ts +46 -14
- package/generated/particlefx.d.ts +24 -5
- package/generated/physics.d.ts +64 -20
- package/generated/profiler.d.ts +3 -5
- package/generated/render-script-modules/b2d.d.ts +711 -0
- package/generated/render-script-modules/bullet3d.d.ts +73 -0
- package/generated/render-script-modules/collectionfactory.d.ts +24 -0
- package/generated/render-script-modules/collectionproxy.d.ts +39 -0
- package/generated/render-script-modules/factory.d.ts +24 -0
- package/generated/render-script-modules/go.d.ts +434 -0
- package/generated/render-script-modules/label.d.ts +105 -0
- package/generated/render-script-modules/model.d.ts +121 -0
- package/generated/render-script-modules/particlefx.d.ts +59 -0
- package/generated/render-script-modules/physics.d.ts +333 -0
- package/generated/render-script-modules/resource.d.ts +1232 -0
- package/generated/render-script-modules/sound.d.ts +227 -0
- package/generated/render-script-modules/sprite.d.ts +68 -0
- package/generated/render-script-modules/tilemap.d.ts +43 -0
- package/generated/render.d.ts +172 -47
- package/generated/resource.d.ts +81 -61
- package/generated/socket.d.ts +18 -23
- package/generated/sound.d.ts +6 -6
- package/generated/sprite.d.ts +51 -3
- package/generated/sys.d.ts +87 -24
- package/generated/tilemap.d.ts +3 -3
- package/generated/timer.d.ts +3 -3
- package/generated/versions/defold-1.12.4/b2d.d.ts +2 -2
- package/generated/versions/defold-1.12.4/b2d_body.d.ts +2 -2
- package/generated/versions/defold-1.12.4/buffer.d.ts +8 -8
- package/generated/versions/defold-1.12.4/go.d.ts +117 -345
- package/generated/versions/defold-1.12.4/graphics.d.ts +2 -1
- package/generated/versions/defold-1.12.4/gui.d.ts +169 -532
- package/generated/versions/defold-1.12.4/http.d.ts +2 -2
- package/generated/versions/defold-1.12.4/image.d.ts +82 -2
- package/generated/versions/defold-1.12.4/index.d.ts +1 -0
- package/generated/versions/defold-1.12.4/label.d.ts +1 -1
- package/generated/versions/defold-1.12.4/liveupdate.d.ts +4 -0
- package/generated/versions/defold-1.12.4/model.d.ts +42 -10
- package/generated/versions/defold-1.12.4/particlefx.d.ts +23 -2
- package/generated/versions/defold-1.12.4/physics.d.ts +46 -2
- package/generated/versions/defold-1.12.4/render.d.ts +83 -7
- package/generated/versions/defold-1.12.4/resource.d.ts +50 -17
- package/generated/versions/defold-1.12.4/socket.d.ts +12 -12
- package/generated/versions/defold-1.12.4/sound.d.ts +1 -1
- package/generated/versions/defold-1.12.4/sprite.d.ts +59 -2
- package/generated/versions/defold-1.12.4/sys.d.ts +103 -8
- package/generated/versions/defold-1.12.4/tilemap.d.ts +1 -1
- package/generated/versions/defold-1.12.4/vmath.d.ts +0 -24
- package/generated/versions/defold-1.12.4/window.d.ts +3 -4
- package/generated/versions/defold-1.13.0/b2d.d.ts +2 -2
- package/generated/versions/defold-1.13.0/b2d_body.d.ts +2 -2
- package/generated/versions/defold-1.13.0/b2d_chain.d.ts +1 -1
- package/generated/versions/defold-1.13.0/b2d_joint.d.ts +1 -1
- package/generated/versions/defold-1.13.0/b2d_shape.d.ts +1 -1
- package/generated/versions/defold-1.13.0/buffer.d.ts +8 -8
- package/generated/versions/defold-1.13.0/camera.d.ts +1 -1
- package/generated/versions/defold-1.13.0/go.d.ts +117 -372
- package/generated/versions/defold-1.13.0/graphics.d.ts +2 -1
- package/generated/versions/defold-1.13.0/gui.d.ts +169 -532
- package/generated/versions/defold-1.13.0/http.d.ts +2 -2
- package/generated/versions/defold-1.13.0/image.d.ts +82 -2
- package/generated/versions/defold-1.13.0/index.d.ts +1 -0
- package/generated/versions/defold-1.13.0/label.d.ts +1 -1
- package/generated/versions/defold-1.13.0/liveupdate.d.ts +4 -0
- package/generated/versions/defold-1.13.0/material.d.ts +3 -1
- package/generated/versions/defold-1.13.0/model.d.ts +42 -10
- package/generated/versions/defold-1.13.0/particlefx.d.ts +23 -2
- package/generated/versions/defold-1.13.0/physics.d.ts +46 -2
- package/generated/versions/defold-1.13.0/render.d.ts +147 -9
- package/generated/versions/defold-1.13.0/resource.d.ts +50 -17
- package/generated/versions/defold-1.13.0/socket.d.ts +12 -12
- package/generated/versions/defold-1.13.0/sound.d.ts +1 -1
- package/generated/versions/defold-1.13.0/sprite.d.ts +59 -2
- package/generated/versions/defold-1.13.0/sys.d.ts +103 -8
- package/generated/versions/defold-1.13.0/tilemap.d.ts +1 -1
- package/generated/versions/defold-1.13.0/vmath.d.ts +0 -24
- package/generated/versions/defold-1.13.0/window.d.ts +3 -4
- package/generated/versions/defold-1.13.1/b2d.d.ts +2 -2
- package/generated/versions/defold-1.13.1/b2d_body.d.ts +2 -2
- package/generated/versions/defold-1.13.1/b2d_chain.d.ts +1 -1
- package/generated/versions/defold-1.13.1/b2d_joint.d.ts +1 -1
- package/generated/versions/defold-1.13.1/b2d_shape.d.ts +1 -1
- package/generated/versions/defold-1.13.1/buffer.d.ts +8 -8
- package/generated/versions/defold-1.13.1/camera.d.ts +1 -1
- package/generated/versions/defold-1.13.1/go.d.ts +117 -372
- package/generated/versions/defold-1.13.1/graphics.d.ts +2 -1
- package/generated/versions/defold-1.13.1/gui.d.ts +169 -548
- package/generated/versions/defold-1.13.1/http.d.ts +2 -2
- package/generated/versions/defold-1.13.1/image.d.ts +82 -2
- package/generated/versions/defold-1.13.1/index.d.ts +2 -0
- package/generated/versions/defold-1.13.1/label.d.ts +1 -1
- package/generated/versions/defold-1.13.1/liveupdate.d.ts +4 -0
- package/generated/versions/defold-1.13.1/material.d.ts +3 -1
- package/generated/versions/defold-1.13.1/model.d.ts +42 -10
- package/generated/versions/defold-1.13.1/particlefx.d.ts +23 -2
- package/generated/versions/defold-1.13.1/physics.d.ts +46 -2
- package/generated/versions/defold-1.13.1/render.d.ts +147 -9
- package/generated/versions/defold-1.13.1/resource.d.ts +50 -17
- package/generated/versions/defold-1.13.1/socket.d.ts +12 -12
- package/generated/versions/defold-1.13.1/sound.d.ts +1 -1
- package/generated/versions/defold-1.13.1/sprite.d.ts +59 -2
- package/generated/versions/defold-1.13.1/sys.d.ts +103 -8
- package/generated/versions/defold-1.13.1/tilemap.d.ts +1 -1
- package/generated/versions/defold-1.13.1/vmath.d.ts +0 -24
- package/generated/versions/defold-1.13.1/window.d.ts +3 -4
- package/generated/versions/defold-1.13.2/b2d.d.ts +39 -39
- package/generated/versions/defold-1.13.2/b2d_body.d.ts +11 -11
- package/generated/versions/defold-1.13.2/b2d_chain.d.ts +3 -3
- package/generated/versions/defold-1.13.2/b2d_fixture.d.ts +5 -5
- package/generated/versions/defold-1.13.2/b2d_joint.d.ts +29 -29
- package/generated/versions/defold-1.13.2/b2d_shape.d.ts +13 -13
- package/generated/versions/defold-1.13.2/b2d_world.d.ts +15 -15
- package/generated/versions/defold-1.13.2/buffer.d.ts +10 -11
- package/generated/versions/defold-1.13.2/bullet3d.d.ts +6 -6
- package/generated/versions/defold-1.13.2/bullet3d_collision_object.d.ts +10 -10
- package/generated/versions/defold-1.13.2/bullet3d_constraint.d.ts +173 -71
- package/generated/versions/defold-1.13.2/bullet3d_rigid_body.d.ts +3 -3
- package/generated/versions/defold-1.13.2/bullet3d_shape.d.ts +11 -11
- package/generated/versions/defold-1.13.2/bullet3d_world.d.ts +20 -20
- package/generated/versions/defold-1.13.2/camera.d.ts +4 -4
- package/generated/versions/defold-1.13.2/collectionfactory.d.ts +2 -3
- package/generated/versions/defold-1.13.2/collectionproxy.d.ts +5 -5
- package/generated/versions/defold-1.13.2/compute.d.ts +5 -5
- package/generated/versions/defold-1.13.2/crash.d.ts +7 -7
- package/generated/versions/defold-1.13.2/editor-vm/http.d.ts +13 -13
- package/generated/versions/defold-1.13.2/editor-vm/image.d.ts +4 -4
- package/generated/versions/defold-1.13.2/editor-vm/json.d.ts +1 -1
- package/generated/versions/defold-1.13.2/editor-vm/tilemap_tiles.d.ts +9 -9
- package/generated/versions/defold-1.13.2/editor-vm/zip.d.ts +4 -4
- package/generated/versions/defold-1.13.2/editor.d.ts +183 -183
- package/generated/versions/defold-1.13.2/factory.d.ts +2 -3
- package/generated/versions/defold-1.13.2/font.d.ts +4 -4
- package/generated/versions/defold-1.13.2/go.d.ts +122 -230
- package/generated/versions/defold-1.13.2/graphics.d.ts +22 -24
- package/generated/versions/defold-1.13.2/gui.d.ts +186 -423
- package/generated/versions/defold-1.13.2/http.d.ts +3 -3
- package/generated/versions/defold-1.13.2/image.d.ts +63 -11
- package/generated/versions/defold-1.13.2/index.d.ts +2 -0
- package/generated/versions/defold-1.13.2/json.d.ts +4 -4
- package/generated/versions/defold-1.13.2/label.d.ts +5 -5
- package/generated/versions/defold-1.13.2/liveupdate.d.ts +7 -3
- package/generated/versions/defold-1.13.2/material.d.ts +49 -49
- package/generated/versions/defold-1.13.2/model.d.ts +46 -14
- package/generated/versions/defold-1.13.2/particlefx.d.ts +24 -5
- package/generated/versions/defold-1.13.2/physics.d.ts +64 -20
- package/generated/versions/defold-1.13.2/profiler.d.ts +3 -5
- package/generated/versions/defold-1.13.2/render.d.ts +161 -46
- package/generated/versions/defold-1.13.2/resource.d.ts +81 -61
- package/generated/versions/defold-1.13.2/socket.d.ts +18 -23
- package/generated/versions/defold-1.13.2/sound.d.ts +6 -6
- package/generated/versions/defold-1.13.2/sprite.d.ts +51 -3
- package/generated/versions/defold-1.13.2/sys.d.ts +87 -24
- package/generated/versions/defold-1.13.2/tilemap.d.ts +3 -3
- package/generated/versions/defold-1.13.2/timer.d.ts +3 -3
- package/generated/versions/defold-1.13.2/vmath.d.ts +0 -25
- package/generated/versions/defold-1.13.2/window.d.ts +8 -10
- package/generated/vmath.d.ts +0 -25
- package/generated/window.d.ts +8 -10
- package/identity-vocabulary.json +86 -34
- package/index.d.ts +2 -0
- package/package.json +3 -1
- package/scripts/generate-api-availability.ts +10 -24
- package/scripts/generate-api-signatures.ts +75 -14
- package/scripts/materialize-version.ts +48 -7
- package/scripts/regen.ts +214 -19
- package/scripts/shared-handle-methods.ts +3 -2
- package/scripts/signature-store-fs.ts +1 -0
- package/scripts/target-version.ts +26 -0
- package/src/api-doc.ts +34 -0
- package/src/api-identity.ts +32 -1
- package/src/component-properties.d.ts +96 -7
- package/src/core-types.ts +71 -28
- package/src/doc-corrections.ts +62 -5
- package/src/emit-dts.ts +1423 -401
- package/src/engine-globals.d.ts +5 -1
- package/src/engine-type-name.ts +33 -0
- package/src/go-overloads.d.ts +74 -19
- package/src/gui-overloads.d.ts +489 -0
- package/src/gui-texture-removal.d.ts +41 -0
- package/src/index.ts +3 -0
- package/src/lifecycle.ts +32 -23
- package/src/msg-overloads.d.ts +25 -13
- package/src/signature-store.ts +50 -0
- package/src/socket-types.d.ts +3 -3
- package/src/timers.d.ts +2 -1
- package/src/vmath-overloads.d.ts +26 -0
|
@@ -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
|
|
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
|
|
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
|
|
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.
|
|
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.
|
|
299
|
-
interface
|
|
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.
|
|
@@ -9,7 +9,7 @@ declare global {
|
|
|
9
9
|
/**
|
|
10
10
|
* Sprite flipbook playback properties
|
|
11
11
|
*/
|
|
12
|
-
interface
|
|
12
|
+
interface PlayProperties {
|
|
13
13
|
/**
|
|
14
14
|
* Normalized initial animation cursor.
|
|
15
15
|
*/
|
|
@@ -66,7 +66,55 @@ declare global {
|
|
|
66
66
|
* });
|
|
67
67
|
* ```
|
|
68
68
|
*/
|
|
69
|
-
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
|
|
69
|
+
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): void;
|
|
70
|
+
/**
|
|
71
|
+
* Play an animation on a sprite component from its tile set
|
|
72
|
+
* An optional completion callback function can be provided that will be called when
|
|
73
|
+
* the animation has completed playing. If no function is provided,
|
|
74
|
+
* a animation_done message is sent to the script that started the animation.
|
|
75
|
+
*
|
|
76
|
+
* @param url - the sprite that should play the animation
|
|
77
|
+
* @param id - hashed id of the animation to play
|
|
78
|
+
* @param complete_function - function to call when the animation has completed.
|
|
79
|
+
*
|
|
80
|
+
* `self`
|
|
81
|
+
* script_instance The current script instance.
|
|
82
|
+
* `message_id`
|
|
83
|
+
* hash The name of the completion message, `"animation_done"`.
|
|
84
|
+
* `message`
|
|
85
|
+
* message.sprite.animation_done Information about the completion.
|
|
86
|
+
* `sender`
|
|
87
|
+
* url The invoker of the callback: the sprite component.
|
|
88
|
+
* @param play_properties - optional playback properties
|
|
89
|
+
* @example
|
|
90
|
+
* The following examples assumes that the model has id "sprite".
|
|
91
|
+
* How to play the "jump" animation followed by the "run" animation:
|
|
92
|
+
* ```ts
|
|
93
|
+
* const url = msg.url("#sprite");
|
|
94
|
+
*
|
|
95
|
+
* function anim_done(self: unknown, message_id: Hash, message: { id: Hash }) {
|
|
96
|
+
* if (message_id === hash("animation_done") && message.id === hash("jump")) {
|
|
97
|
+
* // jump animation done, chain with "run"
|
|
98
|
+
* sprite.play_flipbook(url, "run");
|
|
99
|
+
* }
|
|
100
|
+
* }
|
|
101
|
+
* ```
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* export default defineScript({
|
|
105
|
+
* init() {
|
|
106
|
+
* const url = msg.url("#sprite");
|
|
107
|
+
* sprite.play_flipbook(url, "jump", (self, message_id, message) => {
|
|
108
|
+
* if (message_id === hash("animation_done") && message.id === hash("jump")) {
|
|
109
|
+
* // jump animation done, chain with "run"
|
|
110
|
+
* sprite.play_flipbook(url, "run");
|
|
111
|
+
* }
|
|
112
|
+
* });
|
|
113
|
+
* },
|
|
114
|
+
* });
|
|
115
|
+
* ```
|
|
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.PlayProperties): void;
|
|
70
118
|
/**
|
|
71
119
|
* Resets a shader constant for a sprite component.
|
|
72
120
|
* The constant must be defined in the material assigned to the sprite.
|
|
@@ -130,7 +178,7 @@ declare global {
|
|
|
130
178
|
* ```
|
|
131
179
|
*/
|
|
132
180
|
function set_vflip(url: string | Hash | Url, flip: boolean): void;
|
|
133
|
-
interface
|
|
181
|
+
interface Properties {
|
|
134
182
|
/**
|
|
135
183
|
* READ ONLY The current animation id. An animation that plays currently for the sprite. The type of the property is hash.
|
|
136
184
|
*/
|
|
@@ -10,7 +10,7 @@ declare global {
|
|
|
10
10
|
/**
|
|
11
11
|
* Application information
|
|
12
12
|
*/
|
|
13
|
-
interface
|
|
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
|
|
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
|
|
39
|
+
interface InterfaceInfo {
|
|
40
40
|
/**
|
|
41
41
|
* Interface name.
|
|
42
42
|
*/
|
|
@@ -65,20 +65,20 @@ declare global {
|
|
|
65
65
|
/**
|
|
66
66
|
* Asynchronous buffer-load result
|
|
67
67
|
*/
|
|
68
|
-
interface
|
|
68
|
+
interface LoadBufferResult {
|
|
69
69
|
/**
|
|
70
70
|
* Request status.
|
|
71
71
|
*/
|
|
72
|
-
status: sys.
|
|
72
|
+
status: sys.RequestStatus;
|
|
73
73
|
/**
|
|
74
74
|
* Loaded payload for a successful request.
|
|
75
75
|
*/
|
|
76
|
-
buffer?: Opaque<"buffer"
|
|
76
|
+
buffer?: Opaque<"buffer"> & { length: LuaLengthMethod<number> };
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
79
|
* URL opening attributes
|
|
80
80
|
*/
|
|
81
|
-
interface
|
|
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
|
|
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
|
|
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
|
|
146
|
-
type
|
|
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.
|
|
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.
|
|
@@ -317,7 +316,40 @@ declare global {
|
|
|
317
316
|
* }
|
|
318
317
|
* ```
|
|
319
318
|
*/
|
|
320
|
-
function get_config_int(key: string
|
|
319
|
+
function get_config_int(key: string): number;
|
|
320
|
+
/**
|
|
321
|
+
* Get integer config value from the game.project configuration file with optional default value
|
|
322
|
+
*
|
|
323
|
+
* @param key - key to get value for. The syntax is SECTION.KEY
|
|
324
|
+
* @param default_value - (optional) default value to return if the value does not exist
|
|
325
|
+
* @returns config value as an integer. default_value if the config key does not exist. 0 if no default value was supplied.
|
|
326
|
+
* @example
|
|
327
|
+
* Get user config value
|
|
328
|
+
* ```ts
|
|
329
|
+
* const speed = sys.get_config_int("my_game.speed", 20); // with default value
|
|
330
|
+
* ```
|
|
331
|
+
* @example
|
|
332
|
+
* ```ts
|
|
333
|
+
* const testmode = sys.get_config_int("my_game.testmode"); // without default value
|
|
334
|
+
* if (testmode !== undefined) {
|
|
335
|
+
* // do stuff
|
|
336
|
+
* }
|
|
337
|
+
* ```
|
|
338
|
+
*/
|
|
339
|
+
function get_config_int(key: string, default_value: number): number;
|
|
340
|
+
/**
|
|
341
|
+
* Get number config value from the game.project configuration file with optional default value
|
|
342
|
+
*
|
|
343
|
+
* @param key - key to get value for. The syntax is SECTION.KEY
|
|
344
|
+
* @param default_value - (optional) default value to return if the value does not exist
|
|
345
|
+
* @returns config value as an number. default_value if the config key does not exist. 0 if no default value was supplied.
|
|
346
|
+
* @example
|
|
347
|
+
* ```ts
|
|
348
|
+
* // Get user config value
|
|
349
|
+
* const speed = sys.get_config_number("my_game.speed", 20.0);
|
|
350
|
+
* ```
|
|
351
|
+
*/
|
|
352
|
+
function get_config_number(key: string): number;
|
|
321
353
|
/**
|
|
322
354
|
* Get number config value from the game.project configuration file with optional default value
|
|
323
355
|
*
|
|
@@ -330,7 +362,7 @@ declare global {
|
|
|
330
362
|
* const speed = sys.get_config_number("my_game.speed", 20.0);
|
|
331
363
|
* ```
|
|
332
364
|
*/
|
|
333
|
-
function get_config_number(key: string, default_value
|
|
365
|
+
function get_config_number(key: string, default_value: number): number;
|
|
334
366
|
/**
|
|
335
367
|
* Returns the current network connectivity status
|
|
336
368
|
* on mobile platforms.
|
|
@@ -345,7 +377,7 @@ declare global {
|
|
|
345
377
|
* }
|
|
346
378
|
* ```
|
|
347
379
|
*/
|
|
348
|
-
function get_connectivity(): sys.
|
|
380
|
+
function get_connectivity(): sys.Network;
|
|
349
381
|
/**
|
|
350
382
|
* Returns a table with engine information.
|
|
351
383
|
*
|
|
@@ -359,7 +391,7 @@ declare global {
|
|
|
359
391
|
* gui.set_text(gui.get_node("version"), version_str);
|
|
360
392
|
* ```
|
|
361
393
|
*/
|
|
362
|
-
function get_engine_info(): sys.
|
|
394
|
+
function get_engine_info(): sys.EngineInfo;
|
|
363
395
|
/**
|
|
364
396
|
* Create a path to the host device for unit testing
|
|
365
397
|
* Useful for saving logs etc during development
|
|
@@ -396,7 +428,7 @@ declare global {
|
|
|
396
428
|
* }
|
|
397
429
|
* ```
|
|
398
430
|
*/
|
|
399
|
-
function get_ifaddrs(): sys.
|
|
431
|
+
function get_ifaddrs(): sys.InterfaceInfo[];
|
|
400
432
|
/**
|
|
401
433
|
* The save-file path is operating system specific and is typically located under the user's home directory.
|
|
402
434
|
* This function will raise a Lua error if unable to get the save file path.
|
|
@@ -443,7 +475,22 @@ declare global {
|
|
|
443
475
|
* }
|
|
444
476
|
* ```
|
|
445
477
|
*/
|
|
446
|
-
function get_sys_info(
|
|
478
|
+
function get_sys_info(): sys.SysInfo;
|
|
479
|
+
/**
|
|
480
|
+
* Returns a table with system information.
|
|
481
|
+
*
|
|
482
|
+
* @param options - optional system-information options
|
|
483
|
+
* @returns system information
|
|
484
|
+
* @example
|
|
485
|
+
* ```ts
|
|
486
|
+
* // How to get system information:
|
|
487
|
+
* const info = sys.get_sys_info();
|
|
488
|
+
* if (info.system_name === "HTML5") {
|
|
489
|
+
* // We are running in a browser.
|
|
490
|
+
* }
|
|
491
|
+
* ```
|
|
492
|
+
*/
|
|
493
|
+
function get_sys_info(options: sys.SysInfoOptions): sys.SysInfo;
|
|
447
494
|
/**
|
|
448
495
|
* If the file exists, it must have been created by `sys.save` to be loaded.
|
|
449
496
|
* This function will raise a Lua error if an error occurs while loading the file.
|
|
@@ -489,7 +536,7 @@ declare global {
|
|
|
489
536
|
* const asset_2 = sys.load_buffer("/my/absolute/path");
|
|
490
537
|
* ```
|
|
491
538
|
*/
|
|
492
|
-
function load_buffer(path: string): Opaque<"buffer"
|
|
539
|
+
function load_buffer(path: string): Opaque<"buffer"> & { length: LuaLengthMethod<number> };
|
|
493
540
|
/**
|
|
494
541
|
* The sys.load_buffer function will first try to load the resource
|
|
495
542
|
* from any of the mounted resource locations and return the data if
|
|
@@ -512,7 +559,7 @@ declare global {
|
|
|
512
559
|
* Load binary data from a custom project resource and update a texture resource:
|
|
513
560
|
* ```ts
|
|
514
561
|
* // Load binary data from a custom project resource and update a texture resource:
|
|
515
|
-
* function my_callback(self: unknown, request_id: number, result: sys.
|
|
562
|
+
* function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
|
|
516
563
|
* const format = graphics.TEXTURE_FORMAT_RGBA;
|
|
517
564
|
* if (result.status === sys.REQUEST_STATUS_FINISHED && result.buffer !== undefined && format !== undefined) {
|
|
518
565
|
* resource.set_texture("/my_texture", { type: graphics.TEXTURE_TYPE_2D, width: 128, height: 128, format }, result.buffer);
|
|
@@ -525,7 +572,7 @@ declare global {
|
|
|
525
572
|
* Load binary data from non-custom resource files on disk:
|
|
526
573
|
* ```ts
|
|
527
574
|
* // Load binary data from non-custom resource files on disk:
|
|
528
|
-
* function my_callback(self: unknown, request_id: number, result: sys.
|
|
575
|
+
* function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
|
|
529
576
|
* const { first_request, second_request } = self as { first_request: number; second_request: number };
|
|
530
577
|
* if (result.status !== sys.REQUEST_STATUS_FINISHED) {
|
|
531
578
|
* // uh oh! File could not be found, do something graceful
|
|
@@ -546,7 +593,7 @@ declare global {
|
|
|
546
593
|
* });
|
|
547
594
|
* ```
|
|
548
595
|
*/
|
|
549
|
-
function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.
|
|
596
|
+
function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.LoadBufferResult) => void): number;
|
|
550
597
|
/**
|
|
551
598
|
* Loads a custom resource. Specify the full filename of the resource that you want
|
|
552
599
|
* to load. When loaded, the file data is returned as a string.
|
|
@@ -588,7 +635,23 @@ declare global {
|
|
|
588
635
|
* }
|
|
589
636
|
* ```
|
|
590
637
|
*/
|
|
591
|
-
function open_url(url: string
|
|
638
|
+
function open_url(url: string): boolean;
|
|
639
|
+
/**
|
|
640
|
+
* Open URL in default application, typically a browser
|
|
641
|
+
*
|
|
642
|
+
* @param url - url to open
|
|
643
|
+
* @param attributes - optional URL opening attributes
|
|
644
|
+
* @returns a boolean indicating if the url could be opened or not
|
|
645
|
+
* @example
|
|
646
|
+
* ```ts
|
|
647
|
+
* // Open an URL:
|
|
648
|
+
* const success = sys.open_url("http://www.defold.com", { target: "_blank" });
|
|
649
|
+
* if (!success) {
|
|
650
|
+
* // could not open the url...
|
|
651
|
+
* }
|
|
652
|
+
* ```
|
|
653
|
+
*/
|
|
654
|
+
function open_url(url: string, attributes: sys.OpenUrlAttributes): boolean;
|
|
592
655
|
/**
|
|
593
656
|
* Reboots the game engine with a specified set of arguments.
|
|
594
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
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
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.
|
|
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
|
|
@@ -69,30 +68,6 @@ declare global {
|
|
|
69
68
|
* ```
|
|
70
69
|
*/
|
|
71
70
|
function cross(v1: Vector3, v2: Vector3): Vector3;
|
|
72
|
-
/**
|
|
73
|
-
* The returned value is a scalar defined as:
|
|
74
|
-
* `P ⋅ Q = |P| |Q| cos θ`
|
|
75
|
-
* where θ is the angle between the vectors P and Q.
|
|
76
|
-
*
|
|
77
|
-
* - If the dot product is positive then the angle between the vectors is below 90 degrees.
|
|
78
|
-
* - If the dot product is zero the vectors are perpendicular (at right-angles to each other).
|
|
79
|
-
* - If the dot product is negative then the angle between the vectors is more than 90 degrees.
|
|
80
|
-
*
|
|
81
|
-
* @param v1 - first vector
|
|
82
|
-
* @param v2 - second vector
|
|
83
|
-
* @returns dot product
|
|
84
|
-
* @example
|
|
85
|
-
* ```ts
|
|
86
|
-
* const vector1 = vmath.vector3(1, 0, 0);
|
|
87
|
-
* const vector2 = vmath.vector3(0, 1, 0);
|
|
88
|
-
*
|
|
89
|
-
* if (vmath.dot(vector1, vector2) === 0) {
|
|
90
|
-
* // The two vectors are perpendicular (at right-angles to each other)
|
|
91
|
-
* // ...
|
|
92
|
-
* }
|
|
93
|
-
* ```
|
|
94
|
-
*/
|
|
95
|
-
function dot(v1: Vector3 | Vector4, v2: Vector3 | Vector4): number;
|
|
96
71
|
/**
|
|
97
72
|
* The resulting matrix is the inverse of the supplied matrix.
|
|
98
73
|
* For ortho-normal matrices, e.g. regular object transformation,
|
|
@@ -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
|
|
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
|
|
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
|
|
60
|
-
type
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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,
|
package/generated/vmath.d.ts
CHANGED
|
@@ -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
|
|
@@ -69,30 +68,6 @@ declare global {
|
|
|
69
68
|
* ```
|
|
70
69
|
*/
|
|
71
70
|
function cross(v1: Vector3, v2: Vector3): Vector3;
|
|
72
|
-
/**
|
|
73
|
-
* The returned value is a scalar defined as:
|
|
74
|
-
* `P ⋅ Q = |P| |Q| cos θ`
|
|
75
|
-
* where θ is the angle between the vectors P and Q.
|
|
76
|
-
*
|
|
77
|
-
* - If the dot product is positive then the angle between the vectors is below 90 degrees.
|
|
78
|
-
* - If the dot product is zero the vectors are perpendicular (at right-angles to each other).
|
|
79
|
-
* - If the dot product is negative then the angle between the vectors is more than 90 degrees.
|
|
80
|
-
*
|
|
81
|
-
* @param v1 - first vector
|
|
82
|
-
* @param v2 - second vector
|
|
83
|
-
* @returns dot product
|
|
84
|
-
* @example
|
|
85
|
-
* ```ts
|
|
86
|
-
* const vector1 = vmath.vector3(1, 0, 0);
|
|
87
|
-
* const vector2 = vmath.vector3(0, 1, 0);
|
|
88
|
-
*
|
|
89
|
-
* if (vmath.dot(vector1, vector2) === 0) {
|
|
90
|
-
* // The two vectors are perpendicular (at right-angles to each other)
|
|
91
|
-
* // ...
|
|
92
|
-
* }
|
|
93
|
-
* ```
|
|
94
|
-
*/
|
|
95
|
-
function dot(v1: Vector3 | Vector4, v2: Vector3 | Vector4): number;
|
|
96
71
|
/**
|
|
97
72
|
* The resulting matrix is the inverse of the supplied matrix.
|
|
98
73
|
* For ortho-normal matrices, e.g. regular object transformation,
|
package/generated/window.d.ts
CHANGED
|
@@ -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
|
|
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
|
|
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
|
|
60
|
-
type
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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,
|