typescript-to-gdscript 0.1.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/LICENSE +21 -0
- package/README.md +324 -0
- package/dist/cache/index.d.ts +203 -0
- package/dist/cache/index.d.ts.map +1 -0
- package/dist/cache/index.js +609 -0
- package/dist/cache/index.js.map +1 -0
- package/dist/checker/godot-project.d.ts +15 -0
- package/dist/checker/godot-project.d.ts.map +1 -0
- package/dist/checker/godot-project.js +14 -0
- package/dist/checker/godot-project.js.map +1 -0
- package/dist/checker/index.d.ts +61 -0
- package/dist/checker/index.d.ts.map +1 -0
- package/dist/checker/index.js +229 -0
- package/dist/checker/index.js.map +1 -0
- package/dist/checker/ts-diagnostics.d.ts +11 -0
- package/dist/checker/ts-diagnostics.d.ts.map +1 -0
- package/dist/checker/ts-diagnostics.js +67 -0
- package/dist/checker/ts-diagnostics.js.map +1 -0
- package/dist/cli/clear-cache.d.ts +3 -0
- package/dist/cli/clear-cache.d.ts.map +1 -0
- package/dist/cli/clear-cache.js +42 -0
- package/dist/cli/clear-cache.js.map +1 -0
- package/dist/cli/convert-gd.d.ts +3 -0
- package/dist/cli/convert-gd.d.ts.map +1 -0
- package/dist/cli/convert-gd.js +148 -0
- package/dist/cli/convert-gd.js.map +1 -0
- package/dist/cli/convert.d.ts +3 -0
- package/dist/cli/convert.d.ts.map +1 -0
- package/dist/cli/convert.js +165 -0
- package/dist/cli/convert.js.map +1 -0
- package/dist/cli/generate-addon-typings.d.ts +3 -0
- package/dist/cli/generate-addon-typings.d.ts.map +1 -0
- package/dist/cli/generate-addon-typings.js +31 -0
- package/dist/cli/generate-addon-typings.js.map +1 -0
- package/dist/cli/generate-gdscript-global-typings.d.ts +3 -0
- package/dist/cli/generate-gdscript-global-typings.d.ts.map +1 -0
- package/dist/cli/generate-gdscript-global-typings.js +172 -0
- package/dist/cli/generate-gdscript-global-typings.js.map +1 -0
- package/dist/cli/generate-typings.d.ts +3 -0
- package/dist/cli/generate-typings.d.ts.map +1 -0
- package/dist/cli/generate-typings.js +48 -0
- package/dist/cli/generate-typings.js.map +1 -0
- package/dist/cli/helpers.d.ts +47 -0
- package/dist/cli/helpers.d.ts.map +1 -0
- package/dist/cli/helpers.js +180 -0
- package/dist/cli/helpers.js.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +35 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/init.d.ts +8 -0
- package/dist/cli/init.d.ts.map +1 -0
- package/dist/cli/init.js +222 -0
- package/dist/cli/init.js.map +1 -0
- package/dist/cli/initial-convert-gd-to-ts.d.ts +3 -0
- package/dist/cli/initial-convert-gd-to-ts.d.ts.map +1 -0
- package/dist/cli/initial-convert-gd-to-ts.js +149 -0
- package/dist/cli/initial-convert-gd-to-ts.js.map +1 -0
- package/dist/cli/lint.d.ts +3 -0
- package/dist/cli/lint.d.ts.map +1 -0
- package/dist/cli/lint.js +191 -0
- package/dist/cli/lint.js.map +1 -0
- package/dist/cli/open-editor.d.ts +21 -0
- package/dist/cli/open-editor.d.ts.map +1 -0
- package/dist/cli/open-editor.js +148 -0
- package/dist/cli/open-editor.js.map +1 -0
- package/dist/cli/set-latest.d.ts +3 -0
- package/dist/cli/set-latest.d.ts.map +1 -0
- package/dist/cli/set-latest.js +23 -0
- package/dist/cli/set-latest.js.map +1 -0
- package/dist/cli/validate-gd.d.ts +3 -0
- package/dist/cli/validate-gd.d.ts.map +1 -0
- package/dist/cli/validate-gd.js +37 -0
- package/dist/cli/validate-gd.js.map +1 -0
- package/dist/cli/watch.d.ts +3 -0
- package/dist/cli/watch.d.ts.map +1 -0
- package/dist/cli/watch.js +58 -0
- package/dist/cli/watch.js.map +1 -0
- package/dist/config/index.d.ts +142 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +161 -0
- package/dist/config/index.js.map +1 -0
- package/dist/converter/common/index.d.ts +169 -0
- package/dist/converter/common/index.d.ts.map +1 -0
- package/dist/converter/common/index.js +298 -0
- package/dist/converter/common/index.js.map +1 -0
- package/dist/converter/gd-to-ts/class-scope.d.ts +80 -0
- package/dist/converter/gd-to-ts/class-scope.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/class-scope.js +208 -0
- package/dist/converter/gd-to-ts/class-scope.js.map +1 -0
- package/dist/converter/gd-to-ts/context.d.ts +94 -0
- package/dist/converter/gd-to-ts/context.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/context.js +71 -0
- package/dist/converter/gd-to-ts/context.js.map +1 -0
- package/dist/converter/gd-to-ts/expressions.d.ts +18 -0
- package/dist/converter/gd-to-ts/expressions.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/expressions.js +535 -0
- package/dist/converter/gd-to-ts/expressions.js.map +1 -0
- package/dist/converter/gd-to-ts/file-scope-emitter.d.ts +34 -0
- package/dist/converter/gd-to-ts/file-scope-emitter.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/file-scope-emitter.js +191 -0
- package/dist/converter/gd-to-ts/file-scope-emitter.js.map +1 -0
- package/dist/converter/gd-to-ts/functions.d.ts +20 -0
- package/dist/converter/gd-to-ts/functions.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/functions.js +313 -0
- package/dist/converter/gd-to-ts/functions.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/explicit-convert.d.ts +42 -0
- package/dist/converter/gd-to-ts/helpers/explicit-convert.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/explicit-convert.js +173 -0
- package/dist/converter/gd-to-ts/helpers/explicit-convert.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/nullable-return.d.ts +19 -0
- package/dist/converter/gd-to-ts/helpers/nullable-return.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/nullable-return.js +116 -0
- package/dist/converter/gd-to-ts/helpers/nullable-return.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/nullable.d.ts +41 -0
- package/dist/converter/gd-to-ts/helpers/nullable.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/nullable.js +526 -0
- package/dist/converter/gd-to-ts/helpers/nullable.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/operator-fix.d.ts +20 -0
- package/dist/converter/gd-to-ts/helpers/operator-fix.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/operator-fix.js +114 -0
- package/dist/converter/gd-to-ts/helpers/operator-fix.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/ready-field-types.d.ts +48 -0
- package/dist/converter/gd-to-ts/helpers/ready-field-types.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/ready-field-types.js +217 -0
- package/dist/converter/gd-to-ts/helpers/ready-field-types.js.map +1 -0
- package/dist/converter/gd-to-ts/helpers/unsafe-helpers.d.ts +64 -0
- package/dist/converter/gd-to-ts/helpers/unsafe-helpers.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/helpers/unsafe-helpers.js +336 -0
- package/dist/converter/gd-to-ts/helpers/unsafe-helpers.js.map +1 -0
- package/dist/converter/gd-to-ts/imports.d.ts +47 -0
- package/dist/converter/gd-to-ts/imports.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/imports.js +98 -0
- package/dist/converter/gd-to-ts/imports.js.map +1 -0
- package/dist/converter/gd-to-ts/index.d.ts +59 -0
- package/dist/converter/gd-to-ts/index.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/index.js +189 -0
- package/dist/converter/gd-to-ts/index.js.map +1 -0
- package/dist/converter/gd-to-ts/inject-imports.d.ts +55 -0
- package/dist/converter/gd-to-ts/inject-imports.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/inject-imports.js +161 -0
- package/dist/converter/gd-to-ts/inject-imports.js.map +1 -0
- package/dist/converter/gd-to-ts/members.d.ts +15 -0
- package/dist/converter/gd-to-ts/members.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/members.js +397 -0
- package/dist/converter/gd-to-ts/members.js.map +1 -0
- package/dist/converter/gd-to-ts/source-emitter.d.ts +27 -0
- package/dist/converter/gd-to-ts/source-emitter.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/source-emitter.js +420 -0
- package/dist/converter/gd-to-ts/source-emitter.js.map +1 -0
- package/dist/converter/gd-to-ts/statements.d.ts +6 -0
- package/dist/converter/gd-to-ts/statements.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/statements.js +385 -0
- package/dist/converter/gd-to-ts/statements.js.map +1 -0
- package/dist/converter/gd-to-ts/ts-helpers.d.ts +49 -0
- package/dist/converter/gd-to-ts/ts-helpers.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/ts-helpers.js +161 -0
- package/dist/converter/gd-to-ts/ts-helpers.js.map +1 -0
- package/dist/converter/gd-to-ts/type-inference.d.ts +41 -0
- package/dist/converter/gd-to-ts/type-inference.d.ts.map +1 -0
- package/dist/converter/gd-to-ts/type-inference.js +168 -0
- package/dist/converter/gd-to-ts/type-inference.js.map +1 -0
- package/dist/converter/ts-to-gd/class-body.d.ts +62 -0
- package/dist/converter/ts-to-gd/class-body.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/class-body.js +290 -0
- package/dist/converter/ts-to-gd/class-body.js.map +1 -0
- package/dist/converter/ts-to-gd/class-members.d.ts +18 -0
- package/dist/converter/ts-to-gd/class-members.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/class-members.js +246 -0
- package/dist/converter/ts-to-gd/class-members.js.map +1 -0
- package/dist/converter/ts-to-gd/diagnostics.d.ts +27 -0
- package/dist/converter/ts-to-gd/diagnostics.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/diagnostics.js +95 -0
- package/dist/converter/ts-to-gd/diagnostics.js.map +1 -0
- package/dist/converter/ts-to-gd/emitter.d.ts +40 -0
- package/dist/converter/ts-to-gd/emitter.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/emitter.js +88 -0
- package/dist/converter/ts-to-gd/emitter.js.map +1 -0
- package/dist/converter/ts-to-gd/expressions.d.ts +46 -0
- package/dist/converter/ts-to-gd/expressions.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/expressions.js +793 -0
- package/dist/converter/ts-to-gd/expressions.js.map +1 -0
- package/dist/converter/ts-to-gd/file-scope.d.ts +42 -0
- package/dist/converter/ts-to-gd/file-scope.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/file-scope.js +463 -0
- package/dist/converter/ts-to-gd/file-scope.js.map +1 -0
- package/dist/converter/ts-to-gd/gd-getset.d.ts +31 -0
- package/dist/converter/ts-to-gd/gd-getset.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/gd-getset.js +219 -0
- package/dist/converter/ts-to-gd/gd-getset.js.map +1 -0
- package/dist/converter/ts-to-gd/gd-helpers.d.ts +44 -0
- package/dist/converter/ts-to-gd/gd-helpers.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/gd-helpers.js +458 -0
- package/dist/converter/ts-to-gd/gd-helpers.js.map +1 -0
- package/dist/converter/ts-to-gd/imports.d.ts +67 -0
- package/dist/converter/ts-to-gd/imports.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/imports.js +150 -0
- package/dist/converter/ts-to-gd/imports.js.map +1 -0
- package/dist/converter/ts-to-gd/index.d.ts +34 -0
- package/dist/converter/ts-to-gd/index.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/index.js +52 -0
- package/dist/converter/ts-to-gd/index.js.map +1 -0
- package/dist/converter/ts-to-gd/parameters.d.ts +12 -0
- package/dist/converter/ts-to-gd/parameters.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/parameters.js +100 -0
- package/dist/converter/ts-to-gd/parameters.js.map +1 -0
- package/dist/converter/ts-to-gd/statements.d.ts +12 -0
- package/dist/converter/ts-to-gd/statements.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/statements.js +262 -0
- package/dist/converter/ts-to-gd/statements.js.map +1 -0
- package/dist/converter/ts-to-gd/transformer-types.d.ts +33 -0
- package/dist/converter/ts-to-gd/transformer-types.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/transformer-types.js +2 -0
- package/dist/converter/ts-to-gd/transformer-types.js.map +1 -0
- package/dist/converter/ts-to-gd/transformer.d.ts +83 -0
- package/dist/converter/ts-to-gd/transformer.d.ts.map +1 -0
- package/dist/converter/ts-to-gd/transformer.js +344 -0
- package/dist/converter/ts-to-gd/transformer.js.map +1 -0
- package/dist/eslint/plugin.d.ts +11 -0
- package/dist/eslint/plugin.d.ts.map +1 -0
- package/dist/eslint/plugin.js +12 -0
- package/dist/eslint/plugin.js.map +1 -0
- package/dist/eslint/rules/convert.d.ts +4 -0
- package/dist/eslint/rules/convert.d.ts.map +1 -0
- package/dist/eslint/rules/convert.js +286 -0
- package/dist/eslint/rules/convert.js.map +1 -0
- package/dist/eslint/rules/no-in-variant.d.ts +10 -0
- package/dist/eslint/rules/no-in-variant.d.ts.map +1 -0
- package/dist/eslint/rules/no-in-variant.js +126 -0
- package/dist/eslint/rules/no-in-variant.js.map +1 -0
- package/dist/godot-validate/error-parser.d.ts +64 -0
- package/dist/godot-validate/error-parser.d.ts.map +1 -0
- package/dist/godot-validate/error-parser.js +170 -0
- package/dist/godot-validate/error-parser.js.map +1 -0
- package/dist/godot-validate/index.d.ts +76 -0
- package/dist/godot-validate/index.d.ts.map +1 -0
- package/dist/godot-validate/index.js +267 -0
- package/dist/godot-validate/index.js.map +1 -0
- package/dist/godot-validate/source-map-remap.d.ts +48 -0
- package/dist/godot-validate/source-map-remap.d.ts.map +1 -0
- package/dist/godot-validate/source-map-remap.js +195 -0
- package/dist/godot-validate/source-map-remap.js.map +1 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -0
- package/dist/parser/gdscript/generate-types.d.ts +7 -0
- package/dist/parser/gdscript/generate-types.d.ts.map +1 -0
- package/dist/parser/gdscript/generate-types.js +134 -0
- package/dist/parser/gdscript/generate-types.js.map +1 -0
- package/dist/parser/gdscript/index.d.ts +9 -0
- package/dist/parser/gdscript/index.d.ts.map +1 -0
- package/dist/parser/gdscript/index.js +17 -0
- package/dist/parser/gdscript/index.js.map +1 -0
- package/dist/parser/gdscript/types.d.ts +689 -0
- package/dist/parser/gdscript/types.d.ts.map +1 -0
- package/dist/parser/gdscript/types.js +89 -0
- package/dist/parser/gdscript/types.js.map +1 -0
- package/dist/parser/godot-resource/index.d.ts +7 -0
- package/dist/parser/godot-resource/index.d.ts.map +1 -0
- package/dist/parser/godot-resource/index.js +14 -0
- package/dist/parser/godot-resource/index.js.map +1 -0
- package/dist/parser/godot-resource/types.d.ts +330 -0
- package/dist/parser/godot-resource/types.d.ts.map +1 -0
- package/dist/parser/godot-resource/types.js +22 -0
- package/dist/parser/godot-resource/types.js.map +1 -0
- package/dist/parser/typescript/index.d.ts +12 -0
- package/dist/parser/typescript/index.d.ts.map +1 -0
- package/dist/parser/typescript/index.js +30 -0
- package/dist/parser/typescript/index.js.map +1 -0
- package/dist/sourcemap/index.d.ts +59 -0
- package/dist/sourcemap/index.d.ts.map +1 -0
- package/dist/sourcemap/index.js +85 -0
- package/dist/sourcemap/index.js.map +1 -0
- package/dist/ts-plugin/index.d.ts +47 -0
- package/dist/ts-plugin/index.d.ts.map +1 -0
- package/dist/ts-plugin/index.js +227 -0
- package/dist/ts-plugin/index.js.map +1 -0
- package/dist/ts-plugin/lint.d.ts +48 -0
- package/dist/ts-plugin/lint.d.ts.map +1 -0
- package/dist/ts-plugin/lint.js +424 -0
- package/dist/ts-plugin/lint.js.map +1 -0
- package/dist/ts-plugin/lru.d.ts +40 -0
- package/dist/ts-plugin/lru.d.ts.map +1 -0
- package/dist/ts-plugin/lru.js +82 -0
- package/dist/ts-plugin/lru.js.map +1 -0
- package/dist/ts-plugin/navigation.d.ts +58 -0
- package/dist/ts-plugin/navigation.d.ts.map +1 -0
- package/dist/ts-plugin/navigation.js +427 -0
- package/dist/ts-plugin/navigation.js.map +1 -0
- package/dist/ts-plugin/shadow-refs.d.ts +31 -0
- package/dist/ts-plugin/shadow-refs.d.ts.map +1 -0
- package/dist/ts-plugin/shadow-refs.js +76 -0
- package/dist/ts-plugin/shadow-refs.js.map +1 -0
- package/dist/ts-plugin/snapshot-transform.d.ts +61 -0
- package/dist/ts-plugin/snapshot-transform.d.ts.map +1 -0
- package/dist/ts-plugin/snapshot-transform.js +55 -0
- package/dist/ts-plugin/snapshot-transform.js.map +1 -0
- package/dist/typings/class-generator.d.ts +54 -0
- package/dist/typings/class-generator.d.ts.map +1 -0
- package/dist/typings/class-generator.js +524 -0
- package/dist/typings/class-generator.js.map +1 -0
- package/dist/typings/classes.d.ts +24 -0
- package/dist/typings/classes.d.ts.map +1 -0
- package/dist/typings/classes.js +139 -0
- package/dist/typings/classes.js.map +1 -0
- package/dist/typings/content-generators.d.ts +62 -0
- package/dist/typings/content-generators.d.ts.map +1 -0
- package/dist/typings/content-generators.js +536 -0
- package/dist/typings/content-generators.js.map +1 -0
- package/dist/typings/global-generator.d.ts +32 -0
- package/dist/typings/global-generator.d.ts.map +1 -0
- package/dist/typings/global-generator.js +242 -0
- package/dist/typings/global-generator.js.map +1 -0
- package/dist/typings/godot-docs.d.ts +27 -0
- package/dist/typings/godot-docs.d.ts.map +1 -0
- package/dist/typings/godot-docs.js +310 -0
- package/dist/typings/godot-docs.js.map +1 -0
- package/dist/typings/godot-registry.d.ts +123 -0
- package/dist/typings/godot-registry.d.ts.map +1 -0
- package/dist/typings/godot-registry.js +157 -0
- package/dist/typings/godot-registry.js.map +1 -0
- package/dist/typings/index.d.ts +4 -0
- package/dist/typings/index.d.ts.map +1 -0
- package/dist/typings/index.js +4 -0
- package/dist/typings/index.js.map +1 -0
- package/dist/typings/override-system.d.ts +36 -0
- package/dist/typings/override-system.d.ts.map +1 -0
- package/dist/typings/override-system.js +341 -0
- package/dist/typings/override-system.js.map +1 -0
- package/dist/typings/registry-generator.d.ts +44 -0
- package/dist/typings/registry-generator.d.ts.map +1 -0
- package/dist/typings/registry-generator.js +170 -0
- package/dist/typings/registry-generator.js.map +1 -0
- package/dist/typings/scene-parser.d.ts +113 -0
- package/dist/typings/scene-parser.d.ts.map +1 -0
- package/dist/typings/scene-parser.js +436 -0
- package/dist/typings/scene-parser.js.map +1 -0
- package/dist/typings/scene-tree.d.ts +33 -0
- package/dist/typings/scene-tree.d.ts.map +1 -0
- package/dist/typings/scene-tree.js +118 -0
- package/dist/typings/scene-tree.js.map +1 -0
- package/dist/typings/scene-utils.d.ts +131 -0
- package/dist/typings/scene-utils.d.ts.map +1 -0
- package/dist/typings/scene-utils.js +604 -0
- package/dist/typings/scene-utils.js.map +1 -0
- package/dist/typings/scenes.d.ts +96 -0
- package/dist/typings/scenes.d.ts.map +1 -0
- package/dist/typings/scenes.js +368 -0
- package/dist/typings/scenes.js.map +1 -0
- package/dist/typings/type-mapping.d.ts +76 -0
- package/dist/typings/type-mapping.d.ts.map +1 -0
- package/dist/typings/type-mapping.js +239 -0
- package/dist/typings/type-mapping.js.map +1 -0
- package/dist/typings/xml-parser.d.ts +91 -0
- package/dist/typings/xml-parser.d.ts.map +1 -0
- package/dist/typings/xml-parser.js +275 -0
- package/dist/typings/xml-parser.js.map +1 -0
- package/dist/watcher/index.d.ts +74 -0
- package/dist/watcher/index.d.ts.map +1 -0
- package/dist/watcher/index.js +410 -0
- package/dist/watcher/index.js.map +1 -0
- package/package.json +115 -0
- package/ts-plugin/index.js +9 -0
- package/ts-plugin/package.json +7 -0
- package/typings/classes/AABB.d.ts +177 -0
- package/typings/classes/AESContext.d.ts +34 -0
- package/typings/classes/AStar2D.d.ts +108 -0
- package/typings/classes/AStar3D.d.ts +108 -0
- package/typings/classes/AStarGrid2D.d.ts +184 -0
- package/typings/classes/AcceptDialog.d.ts +77 -0
- package/typings/classes/AccessibilityServer.d.ts +405 -0
- package/typings/classes/AimModifier3D.d.ts +40 -0
- package/typings/classes/AnimatableBody2D.d.ts +14 -0
- package/typings/classes/AnimatableBody3D.d.ts +14 -0
- package/typings/classes/AnimatedSprite2D.d.ts +108 -0
- package/typings/classes/AnimatedSprite3D.d.ts +89 -0
- package/typings/classes/AnimatedTexture.d.ts +54 -0
- package/typings/classes/Animation.d.ts +340 -0
- package/typings/classes/AnimationLibrary.d.ts +34 -0
- package/typings/classes/AnimationMixer.d.ts +226 -0
- package/typings/classes/AnimationNode.d.ts +116 -0
- package/typings/classes/AnimationNodeAdd2.d.ts +6 -0
- package/typings/classes/AnimationNodeAdd3.d.ts +6 -0
- package/typings/classes/AnimationNodeAnimation.d.ts +64 -0
- package/typings/classes/AnimationNodeBlend2.d.ts +6 -0
- package/typings/classes/AnimationNodeBlend3.d.ts +6 -0
- package/typings/classes/AnimationNodeBlendSpace1D.d.ts +79 -0
- package/typings/classes/AnimationNodeBlendSpace2D.d.ts +104 -0
- package/typings/classes/AnimationNodeBlendTree.d.ts +53 -0
- package/typings/classes/AnimationNodeExtension.d.ts +18 -0
- package/typings/classes/AnimationNodeOneShot.d.ts +78 -0
- package/typings/classes/AnimationNodeOutput.d.ts +6 -0
- package/typings/classes/AnimationNodeStateMachine.d.ts +80 -0
- package/typings/classes/AnimationNodeStateMachinePlayback.d.ts +67 -0
- package/typings/classes/AnimationNodeStateMachineTransition.d.ts +83 -0
- package/typings/classes/AnimationNodeSub2.d.ts +6 -0
- package/typings/classes/AnimationNodeSync.d.ts +13 -0
- package/typings/classes/AnimationNodeTimeScale.d.ts +6 -0
- package/typings/classes/AnimationNodeTimeSeek.d.ts +12 -0
- package/typings/classes/AnimationNodeTransition.d.ts +45 -0
- package/typings/classes/AnimationPlayer.d.ts +203 -0
- package/typings/classes/AnimationRootNode.d.ts +8 -0
- package/typings/classes/AnimationTree.d.ts +35 -0
- package/typings/classes/Area2D.d.ts +166 -0
- package/typings/classes/Area3D.d.ts +214 -0
- package/typings/classes/Array.d.ts +301 -0
- package/typings/classes/ArrayMesh.d.ts +94 -0
- package/typings/classes/ArrayOccluder3D.d.ts +23 -0
- package/typings/classes/AspectRatioContainer.d.ts +46 -0
- package/typings/classes/AtlasTexture.d.ts +32 -0
- package/typings/classes/AudioBusLayout.d.ts +6 -0
- package/typings/classes/AudioEffect.d.ts +11 -0
- package/typings/classes/AudioEffectAmplify.d.ts +19 -0
- package/typings/classes/AudioEffectBandLimitFilter.d.ts +6 -0
- package/typings/classes/AudioEffectBandPassFilter.d.ts +6 -0
- package/typings/classes/AudioEffectCapture.d.ts +35 -0
- package/typings/classes/AudioEffectChorus.d.ts +108 -0
- package/typings/classes/AudioEffectCompressor.d.ts +47 -0
- package/typings/classes/AudioEffectDelay.d.ts +71 -0
- package/typings/classes/AudioEffectDistortion.d.ts +55 -0
- package/typings/classes/AudioEffectEQ.d.ts +15 -0
- package/typings/classes/AudioEffectEQ10.d.ts +9 -0
- package/typings/classes/AudioEffectEQ21.d.ts +9 -0
- package/typings/classes/AudioEffectEQ6.d.ts +9 -0
- package/typings/classes/AudioEffectFilter.d.ts +50 -0
- package/typings/classes/AudioEffectHardLimiter.d.ts +24 -0
- package/typings/classes/AudioEffectHighPassFilter.d.ts +6 -0
- package/typings/classes/AudioEffectHighShelfFilter.d.ts +6 -0
- package/typings/classes/AudioEffectInstance.d.ts +16 -0
- package/typings/classes/AudioEffectLimiter.d.ts +26 -0
- package/typings/classes/AudioEffectLowPassFilter.d.ts +6 -0
- package/typings/classes/AudioEffectLowShelfFilter.d.ts +6 -0
- package/typings/classes/AudioEffectNotchFilter.d.ts +6 -0
- package/typings/classes/AudioEffectPanner.d.ts +15 -0
- package/typings/classes/AudioEffectPhaser.d.ts +37 -0
- package/typings/classes/AudioEffectPitchShift.d.ts +47 -0
- package/typings/classes/AudioEffectRecord.d.ts +19 -0
- package/typings/classes/AudioEffectReverb.d.ts +55 -0
- package/typings/classes/AudioEffectSpectrumAnalyzer.d.ts +40 -0
- package/typings/classes/AudioEffectSpectrumAnalyzerInstance.d.ts +17 -0
- package/typings/classes/AudioEffectStereoEnhance.d.ts +27 -0
- package/typings/classes/AudioListener2D.d.ts +15 -0
- package/typings/classes/AudioListener3D.d.ts +37 -0
- package/typings/classes/AudioSample.d.ts +6 -0
- package/typings/classes/AudioSamplePlayback.d.ts +6 -0
- package/typings/classes/AudioServer.d.ts +199 -0
- package/typings/classes/AudioStream.d.ts +66 -0
- package/typings/classes/AudioStreamGenerator.d.ts +38 -0
- package/typings/classes/AudioStreamGeneratorPlayback.d.ts +28 -0
- package/typings/classes/AudioStreamMicrophone.d.ts +6 -0
- package/typings/classes/AudioStreamPlayback.d.ts +69 -0
- package/typings/classes/AudioStreamPlaybackPolyphonic.d.ts +32 -0
- package/typings/classes/AudioStreamPlaybackResampled.d.ts +16 -0
- package/typings/classes/AudioStreamPlayer.d.ts +110 -0
- package/typings/classes/AudioStreamPlayer2D.d.ts +96 -0
- package/typings/classes/AudioStreamPlayer3D.d.ts +162 -0
- package/typings/classes/AudioStreamPolyphonic.d.ts +12 -0
- package/typings/classes/AudioStreamRandomizer.d.ts +67 -0
- package/typings/classes/AudioStreamWAV.d.ts +87 -0
- package/typings/classes/AwaitTweener.d.ts +10 -0
- package/typings/classes/BackBufferCopy.d.ts +26 -0
- package/typings/classes/BaseButton.d.ts +116 -0
- package/typings/classes/BaseMaterial3D.d.ts +1021 -0
- package/typings/classes/Basis.d.ts +225 -0
- package/typings/classes/BitMap.d.ts +42 -0
- package/typings/classes/BlitMaterial.d.ts +22 -0
- package/typings/classes/Bone2D.d.ts +45 -0
- package/typings/classes/BoneAttachment3D.d.ts +39 -0
- package/typings/classes/BoneConstraint3D.d.ts +67 -0
- package/typings/classes/BoneMap.d.ts +39 -0
- package/typings/classes/BoneTwistDisperser3D.d.ts +126 -0
- package/typings/classes/BoxContainer.d.ts +36 -0
- package/typings/classes/BoxMesh.d.ts +22 -0
- package/typings/classes/BoxOccluder3D.d.ts +10 -0
- package/typings/classes/BoxShape3D.d.ts +10 -0
- package/typings/classes/Button.d.ts +75 -0
- package/typings/classes/ButtonGroup.d.ts +21 -0
- package/typings/classes/CCDIK3D.d.ts +6 -0
- package/typings/classes/CPUParticles2D.d.ts +397 -0
- package/typings/classes/CPUParticles3D.d.ts +421 -0
- package/typings/classes/Callable.d.ts +203 -0
- package/typings/classes/CallbackTweener.d.ts +11 -0
- package/typings/classes/Camera2D.d.ts +214 -0
- package/typings/classes/Camera3D.d.ts +207 -0
- package/typings/classes/CameraAttributes.d.ts +35 -0
- package/typings/classes/CameraAttributesPhysical.d.ts +61 -0
- package/typings/classes/CameraAttributesPractical.d.ts +64 -0
- package/typings/classes/CameraFeed.d.ts +81 -0
- package/typings/classes/CameraServer.d.ts +44 -0
- package/typings/classes/CameraTexture.d.ts +19 -0
- package/typings/classes/CanvasGroup.d.ts +24 -0
- package/typings/classes/CanvasItem.d.ts +503 -0
- package/typings/classes/CanvasItemMaterial.d.ts +61 -0
- package/typings/classes/CanvasLayer.d.ts +74 -0
- package/typings/classes/CanvasModulate.d.ts +10 -0
- package/typings/classes/CanvasTexture.d.ts +42 -0
- package/typings/classes/CapsuleMesh.d.ts +28 -0
- package/typings/classes/CapsuleShape2D.d.ts +26 -0
- package/typings/classes/CapsuleShape3D.d.ts +26 -0
- package/typings/classes/CenterContainer.d.ts +10 -0
- package/typings/classes/ChainIK3D.d.ts +50 -0
- package/typings/classes/CharFXTransform.d.ts +88 -0
- package/typings/classes/CharacterBody2D.d.ts +199 -0
- package/typings/classes/CharacterBody3D.d.ts +201 -0
- package/typings/classes/CheckBox.d.ts +8 -0
- package/typings/classes/CheckButton.d.ts +8 -0
- package/typings/classes/CircleShape2D.d.ts +10 -0
- package/typings/classes/ClassDB.d.ts +110 -0
- package/typings/classes/CodeEdit.d.ts +402 -0
- package/typings/classes/CodeHighlighter.d.ts +81 -0
- package/typings/classes/CollisionObject2D.d.ts +171 -0
- package/typings/classes/CollisionObject3D.d.ts +141 -0
- package/typings/classes/CollisionPolygon2D.d.ts +51 -0
- package/typings/classes/CollisionPolygon3D.d.ts +39 -0
- package/typings/classes/CollisionShape2D.d.ts +41 -0
- package/typings/classes/CollisionShape3D.d.ts +36 -0
- package/typings/classes/Color.d.ts +517 -0
- package/typings/classes/ColorPalette.d.ts +12 -0
- package/typings/classes/ColorPicker.d.ts +118 -0
- package/typings/classes/ColorPickerButton.d.ts +37 -0
- package/typings/classes/ColorRect.d.ts +10 -0
- package/typings/classes/Compositor.d.ts +12 -0
- package/typings/classes/CompositorEffect.d.ts +76 -0
- package/typings/classes/CompressedCubemap.d.ts +6 -0
- package/typings/classes/CompressedCubemapArray.d.ts +6 -0
- package/typings/classes/CompressedTexture2D.d.ts +13 -0
- package/typings/classes/CompressedTexture2DArray.d.ts +6 -0
- package/typings/classes/CompressedTexture3D.d.ts +12 -0
- package/typings/classes/CompressedTextureLayered.d.ts +12 -0
- package/typings/classes/ConcavePolygonShape2D.d.ts +12 -0
- package/typings/classes/ConcavePolygonShape3D.d.ts +21 -0
- package/typings/classes/ConeTwistJoint3D.d.ts +63 -0
- package/typings/classes/ConfigFile.d.ts +71 -0
- package/typings/classes/ConfirmationDialog.d.ts +19 -0
- package/typings/classes/Container.d.ts +42 -0
- package/typings/classes/Control.d.ts +1125 -0
- package/typings/classes/ConvertTransformModifier3D.d.ts +65 -0
- package/typings/classes/ConvexPolygonShape2D.d.ts +18 -0
- package/typings/classes/ConvexPolygonShape3D.d.ts +10 -0
- package/typings/classes/CopyTransformModifier3D.d.ts +117 -0
- package/typings/classes/Crypto.d.ts +41 -0
- package/typings/classes/CryptoKey.d.ts +26 -0
- package/typings/classes/Cubemap.d.ts +8 -0
- package/typings/classes/CubemapArray.d.ts +8 -0
- package/typings/classes/Curve.d.ts +96 -0
- package/typings/classes/Curve2D.d.ts +97 -0
- package/typings/classes/Curve3D.d.ts +129 -0
- package/typings/classes/CurveTexture.d.ts +30 -0
- package/typings/classes/CurveXYZTexture.d.ts +25 -0
- package/typings/classes/CylinderMesh.d.ts +48 -0
- package/typings/classes/CylinderShape3D.d.ts +14 -0
- package/typings/classes/DPITexture.d.ts +48 -0
- package/typings/classes/DTLSServer.d.ts +13 -0
- package/typings/classes/DampedSpringJoint2D.d.ts +28 -0
- package/typings/classes/Decal.d.ts +120 -0
- package/typings/classes/Dictionary.d.ts +181 -0
- package/typings/classes/DirAccess.d.ts +199 -0
- package/typings/classes/DirectionalLight2D.d.ts +16 -0
- package/typings/classes/DirectionalLight3D.d.ts +71 -0
- package/typings/classes/DisplayServer.d.ts +2153 -0
- package/typings/classes/DrawableTexture2D.d.ts +47 -0
- package/typings/classes/EditorCommandPalette.d.ts +21 -0
- package/typings/classes/EditorContextMenuPlugin.d.ts +59 -0
- package/typings/classes/EditorDebuggerPlugin.d.ts +33 -0
- package/typings/classes/EditorDebuggerSession.d.ts +41 -0
- package/typings/classes/EditorDock.d.ts +141 -0
- package/typings/classes/EditorExportPlatform.d.ts +125 -0
- package/typings/classes/EditorExportPlatformAppleEmbedded.d.ts +6 -0
- package/typings/classes/EditorExportPlatformExtension.d.ts +131 -0
- package/typings/classes/EditorExportPlatformPC.d.ts +6 -0
- package/typings/classes/EditorExportPlugin.d.ts +207 -0
- package/typings/classes/EditorExportPreset.d.ts +83 -0
- package/typings/classes/EditorFeatureProfile.d.ts +90 -0
- package/typings/classes/EditorFileDialog.d.ts +15 -0
- package/typings/classes/EditorFileSystem.d.ts +48 -0
- package/typings/classes/EditorFileSystemDirectory.d.ts +42 -0
- package/typings/classes/EditorFileSystemImportFormatSupportQuery.d.ts +12 -0
- package/typings/classes/EditorImportPlugin.d.ts +67 -0
- package/typings/classes/EditorInspector.d.ts +54 -0
- package/typings/classes/EditorInspectorPlugin.d.ts +34 -0
- package/typings/classes/EditorInterface.d.ts +254 -0
- package/typings/classes/EditorNode3DGizmo.d.ts +104 -0
- package/typings/classes/EditorNode3DGizmoPlugin.d.ts +103 -0
- package/typings/classes/EditorPaths.d.ts +52 -0
- package/typings/classes/EditorPlugin.d.ts +384 -0
- package/typings/classes/EditorProperty.d.ts +133 -0
- package/typings/classes/EditorResourceConversionPlugin.d.ts +20 -0
- package/typings/classes/EditorResourcePicker.d.ts +47 -0
- package/typings/classes/EditorResourcePreview.d.ts +25 -0
- package/typings/classes/EditorResourcePreviewGenerator.d.ts +34 -0
- package/typings/classes/EditorResourceTooltipPlugin.d.ts +20 -0
- package/typings/classes/EditorSceneFormatImporter.d.ts +36 -0
- package/typings/classes/EditorScenePostImport.d.ts +10 -0
- package/typings/classes/EditorScenePostImportPlugin.d.ts +57 -0
- package/typings/classes/EditorScript.d.ts +18 -0
- package/typings/classes/EditorScriptPicker.d.ts +10 -0
- package/typings/classes/EditorSelection.d.ts +29 -0
- package/typings/classes/EditorSettings.d.ts +1821 -0
- package/typings/classes/EditorSpinSlider.d.ts +65 -0
- package/typings/classes/EditorSyntaxHighlighter.d.ts +12 -0
- package/typings/classes/EditorToaster.d.ts +16 -0
- package/typings/classes/EditorTranslationParserPlugin.d.ts +12 -0
- package/typings/classes/EditorUndoRedoManager.d.ts +86 -0
- package/typings/classes/EditorVCSInterface.d.ts +121 -0
- package/typings/classes/EncodedObjectAsID.d.ts +12 -0
- package/typings/classes/Engine.d.ts +202 -0
- package/typings/classes/EngineDebugger.d.ts +66 -0
- package/typings/classes/EngineProfiler.d.ts +14 -0
- package/typings/classes/Environment.d.ts +720 -0
- package/typings/classes/Expression.d.ts +20 -0
- package/typings/classes/ExternalTexture.d.ts +22 -0
- package/typings/classes/FABRIK3D.d.ts +6 -0
- package/typings/classes/FileAccess.d.ts +411 -0
- package/typings/classes/FileDialog.d.ts +277 -0
- package/typings/classes/FileSystemDock.d.ts +35 -0
- package/typings/classes/FlowContainer.d.ts +64 -0
- package/typings/classes/FogMaterial.d.ts +43 -0
- package/typings/classes/FogVolume.d.ts +26 -0
- package/typings/classes/FoldableContainer.d.ts +65 -0
- package/typings/classes/FoldableGroup.d.ts +21 -0
- package/typings/classes/Font.d.ts +144 -0
- package/typings/classes/FontFile.d.ts +286 -0
- package/typings/classes/FontVariation.d.ts +56 -0
- package/typings/classes/FramebufferCacheRD.d.ts +10 -0
- package/typings/classes/GDExtension.d.ts +26 -0
- package/typings/classes/GDExtensionManager.d.ts +60 -0
- package/typings/classes/GPUParticles2D.d.ts +220 -0
- package/typings/classes/GPUParticles3D.d.ts +239 -0
- package/typings/classes/GPUParticlesAttractor3D.d.ts +33 -0
- package/typings/classes/GPUParticlesAttractorBox3D.d.ts +10 -0
- package/typings/classes/GPUParticlesAttractorSphere3D.d.ts +13 -0
- package/typings/classes/GPUParticlesAttractorVectorField3D.d.ts +19 -0
- package/typings/classes/GPUParticlesCollision3D.d.ts +14 -0
- package/typings/classes/GPUParticlesCollisionBox3D.d.ts +10 -0
- package/typings/classes/GPUParticlesCollisionHeightField3D.d.ts +75 -0
- package/typings/classes/GPUParticlesCollisionSDF3D.d.ts +59 -0
- package/typings/classes/GPUParticlesCollisionSphere3D.d.ts +10 -0
- package/typings/classes/Generic6DOFJoint3D.d.ts +241 -0
- package/typings/classes/Geometry2D.d.ts +147 -0
- package/typings/classes/Geometry3D.d.ts +67 -0
- package/typings/classes/GeometryInstance3D.d.ts +183 -0
- package/typings/classes/GodotInstance.d.ts +20 -0
- package/typings/classes/Gradient.d.ts +74 -0
- package/typings/classes/GradientTexture1D.d.ts +18 -0
- package/typings/classes/GradientTexture2D.d.ts +64 -0
- package/typings/classes/GraphEdit.d.ts +306 -0
- package/typings/classes/GraphElement.d.ts +56 -0
- package/typings/classes/GraphFrame.d.ts +46 -0
- package/typings/classes/GraphNode.d.ts +132 -0
- package/typings/classes/GridContainer.d.ts +12 -0
- package/typings/classes/GrooveJoint2D.d.ts +18 -0
- package/typings/classes/HBoxContainer.d.ts +6 -0
- package/typings/classes/HFlowContainer.d.ts +6 -0
- package/typings/classes/HMACContext.d.ts +16 -0
- package/typings/classes/HScrollBar.d.ts +6 -0
- package/typings/classes/HSeparator.d.ts +6 -0
- package/typings/classes/HSlider.d.ts +6 -0
- package/typings/classes/HSplitContainer.d.ts +8 -0
- package/typings/classes/HTTPClient.d.ts +384 -0
- package/typings/classes/HTTPRequest.d.ts +124 -0
- package/typings/classes/HashingContext.d.ts +22 -0
- package/typings/classes/HeightMapShape3D.d.ts +36 -0
- package/typings/classes/HingeJoint3D.d.ts +66 -0
- package/typings/classes/IKModifier3D.d.ts +22 -0
- package/typings/classes/IP.d.ts +71 -0
- package/typings/classes/Image.d.ts +567 -0
- package/typings/classes/ImageFormatLoader.d.ts +11 -0
- package/typings/classes/ImageFormatLoaderExtension.d.ts +20 -0
- package/typings/classes/ImageTexture.d.ts +25 -0
- package/typings/classes/ImageTexture3D.d.ts +14 -0
- package/typings/classes/ImageTextureLayered.d.ts +20 -0
- package/typings/classes/ImmediateMesh.d.ts +31 -0
- package/typings/classes/ImporterMesh.d.ts +84 -0
- package/typings/classes/ImporterMeshInstance3D.d.ts +35 -0
- package/typings/classes/Input.d.ts +504 -0
- package/typings/classes/InputEvent.d.ts +85 -0
- package/typings/classes/InputEventAction.d.ts +27 -0
- package/typings/classes/InputEventFromWindow.d.ts +10 -0
- package/typings/classes/InputEventGesture.d.ts +11 -0
- package/typings/classes/InputEventJoypadButton.d.ts +16 -0
- package/typings/classes/InputEventJoypadMotion.d.ts +16 -0
- package/typings/classes/InputEventKey.d.ts +86 -0
- package/typings/classes/InputEventMIDI.d.ts +59 -0
- package/typings/classes/InputEventMagnifyGesture.d.ts +12 -0
- package/typings/classes/InputEventMouse.d.ts +25 -0
- package/typings/classes/InputEventMouseButton.d.ts +26 -0
- package/typings/classes/InputEventMouseMotion.d.ts +54 -0
- package/typings/classes/InputEventPanGesture.d.ts +10 -0
- package/typings/classes/InputEventScreenDrag.d.ts +54 -0
- package/typings/classes/InputEventScreenTouch.d.ts +24 -0
- package/typings/classes/InputEventShortcut.d.ts +12 -0
- package/typings/classes/InputEventWithModifiers.d.ts +37 -0
- package/typings/classes/InputMap.d.ts +50 -0
- package/typings/classes/InstancePlaceholder.d.ts +20 -0
- package/typings/classes/IntervalTweener.d.ts +6 -0
- package/typings/classes/ItemList.d.ts +277 -0
- package/typings/classes/IterateIK3D.d.ts +85 -0
- package/typings/classes/JNISingleton.d.ts +8 -0
- package/typings/classes/JSON.d.ts +53 -0
- package/typings/classes/JSONRPC.d.ts +59 -0
- package/typings/classes/JacobianIK3D.d.ts +6 -0
- package/typings/classes/JavaClass.d.ts +16 -0
- package/typings/classes/JavaClassWrapper.d.ts +20 -0
- package/typings/classes/JavaObject.d.ts +10 -0
- package/typings/classes/JavaScriptBridge.d.ts +62 -0
- package/typings/classes/JavaScriptObject.d.ts +6 -0
- package/typings/classes/Joint2D.d.ts +28 -0
- package/typings/classes/Joint3D.d.ts +34 -0
- package/typings/classes/JointLimitation3D.d.ts +6 -0
- package/typings/classes/JointLimitationCone3D.d.ts +13 -0
- package/typings/classes/KinematicCollision2D.d.ts +36 -0
- package/typings/classes/KinematicCollision3D.d.ts +50 -0
- package/typings/classes/Label.d.ts +134 -0
- package/typings/classes/Label3D.d.ts +202 -0
- package/typings/classes/LabelSettings.d.ts +93 -0
- package/typings/classes/Light2D.d.ts +109 -0
- package/typings/classes/Light3D.d.ts +227 -0
- package/typings/classes/LightOccluder2D.d.ts +22 -0
- package/typings/classes/LightmapGI.d.ts +225 -0
- package/typings/classes/LightmapGIData.d.ts +50 -0
- package/typings/classes/LightmapProbe.d.ts +6 -0
- package/typings/classes/Lightmapper.d.ts +6 -0
- package/typings/classes/LightmapperRD.d.ts +6 -0
- package/typings/classes/LimitAngularVelocityModifier3D.d.ts +50 -0
- package/typings/classes/Line2D.d.ts +127 -0
- package/typings/classes/LineEdit.d.ts +370 -0
- package/typings/classes/LinkButton.d.ts +54 -0
- package/typings/classes/Logger.d.ts +31 -0
- package/typings/classes/LookAtModifier3D.d.ts +196 -0
- package/typings/classes/MainLoop.d.ts +80 -0
- package/typings/classes/MarginContainer.d.ts +6 -0
- package/typings/classes/Marker2D.d.ts +10 -0
- package/typings/classes/Marker3D.d.ts +10 -0
- package/typings/classes/Marshalls.d.ts +27 -0
- package/typings/classes/Material.d.ts +50 -0
- package/typings/classes/MenuBar.d.ts +64 -0
- package/typings/classes/MenuButton.d.ts +35 -0
- package/typings/classes/Mesh.d.ts +255 -0
- package/typings/classes/MeshConvexDecompositionSettings.d.ts +68 -0
- package/typings/classes/MeshDataTool.d.ts +99 -0
- package/typings/classes/MeshInstance2D.d.ts +19 -0
- package/typings/classes/MeshInstance3D.d.ts +87 -0
- package/typings/classes/MeshLibrary.d.ts +68 -0
- package/typings/classes/MeshTexture.d.ts +19 -0
- package/typings/classes/MethodTweener.d.ts +18 -0
- package/typings/classes/MissingNode.d.ts +26 -0
- package/typings/classes/MissingResource.d.ts +16 -0
- package/typings/classes/ModifierBoneTarget3D.d.ts +14 -0
- package/typings/classes/MovieWriter.d.ts +36 -0
- package/typings/classes/MultiMesh.d.ts +138 -0
- package/typings/classes/MultiMeshInstance2D.d.ts +19 -0
- package/typings/classes/MultiMeshInstance3D.d.ts +12 -0
- package/typings/classes/MultiplayerAPI.d.ts +93 -0
- package/typings/classes/MultiplayerAPIExtension.d.ts +24 -0
- package/typings/classes/MultiplayerPeer.d.ts +90 -0
- package/typings/classes/MultiplayerPeerExtension.d.ts +90 -0
- package/typings/classes/Mutex.d.ts +22 -0
- package/typings/classes/NativeMenu.d.ts +428 -0
- package/typings/classes/NavigationAgent2D.d.ts +292 -0
- package/typings/classes/NavigationAgent3D.d.ts +311 -0
- package/typings/classes/NavigationLink2D.d.ts +77 -0
- package/typings/classes/NavigationLink3D.d.ts +77 -0
- package/typings/classes/NavigationMesh.d.ts +207 -0
- package/typings/classes/NavigationMeshGenerator.d.ts +22 -0
- package/typings/classes/NavigationMeshSourceGeometryData2D.d.ts +52 -0
- package/typings/classes/NavigationMeshSourceGeometryData3D.d.ts +64 -0
- package/typings/classes/NavigationObstacle2D.d.ts +67 -0
- package/typings/classes/NavigationObstacle3D.d.ts +80 -0
- package/typings/classes/NavigationPathQueryParameters2D.d.ts +114 -0
- package/typings/classes/NavigationPathQueryParameters3D.d.ts +114 -0
- package/typings/classes/NavigationPathQueryResult2D.d.ts +41 -0
- package/typings/classes/NavigationPathQueryResult3D.d.ts +41 -0
- package/typings/classes/NavigationPolygon.d.ts +150 -0
- package/typings/classes/NavigationRegion2D.d.ts +74 -0
- package/typings/classes/NavigationRegion3D.d.ts +72 -0
- package/typings/classes/NavigationServer2D.d.ts +443 -0
- package/typings/classes/NavigationServer2DManager.d.ts +16 -0
- package/typings/classes/NavigationServer3D.d.ts +499 -0
- package/typings/classes/NavigationServer3DManager.d.ts +16 -0
- package/typings/classes/NinePatchRect.d.ts +65 -0
- package/typings/classes/Node.d.ts +1021 -0
- package/typings/classes/Node2D.d.ts +107 -0
- package/typings/classes/Node3D.d.ts +331 -0
- package/typings/classes/Node3DGizmo.d.ts +6 -0
- package/typings/classes/NodePath.d.ts +107 -0
- package/typings/classes/ORMMaterial3D.d.ts +6 -0
- package/typings/classes/OS.d.ts +556 -0
- package/typings/classes/Object.d.ts +434 -0
- package/typings/classes/Occluder3D.d.ts +10 -0
- package/typings/classes/OccluderInstance3D.d.ts +39 -0
- package/typings/classes/OccluderPolygon2D.d.ts +28 -0
- package/typings/classes/OmniLight3D.d.ts +31 -0
- package/typings/classes/OptimizedTranslation.d.ts +12 -0
- package/typings/classes/OptionButton.d.ts +136 -0
- package/typings/classes/PCKPacker.d.ts +27 -0
- package/typings/classes/PackedByteArray.d.ts +327 -0
- package/typings/classes/PackedColorArray.d.ts +125 -0
- package/typings/classes/PackedDataContainer.d.ts +13 -0
- package/typings/classes/PackedDataContainerRef.d.ts +8 -0
- package/typings/classes/PackedFloat32Array.d.ts +140 -0
- package/typings/classes/PackedFloat64Array.d.ts +140 -0
- package/typings/classes/PackedInt32Array.d.ts +127 -0
- package/typings/classes/PackedInt64Array.d.ts +127 -0
- package/typings/classes/PackedScene.d.ts +40 -0
- package/typings/classes/PackedStringArray.d.ts +124 -0
- package/typings/classes/PackedVector2Array.d.ts +139 -0
- package/typings/classes/PackedVector3Array.d.ts +139 -0
- package/typings/classes/PackedVector4Array.d.ts +138 -0
- package/typings/classes/PacketPeer.d.ts +33 -0
- package/typings/classes/PacketPeerDTLS.d.ts +34 -0
- package/typings/classes/PacketPeerExtension.d.ts +9 -0
- package/typings/classes/PacketPeerStream.d.ts +16 -0
- package/typings/classes/PacketPeerUDP.d.ts +61 -0
- package/typings/classes/Panel.d.ts +6 -0
- package/typings/classes/PanelContainer.d.ts +7 -0
- package/typings/classes/PanoramaSkyMaterial.d.ts +18 -0
- package/typings/classes/Parallax2D.d.ts +63 -0
- package/typings/classes/ParallaxBackground.d.ts +37 -0
- package/typings/classes/ParallaxLayer.d.ts +26 -0
- package/typings/classes/ParticleProcessMaterial.d.ts +595 -0
- package/typings/classes/Path2D.d.ts +10 -0
- package/typings/classes/Path3D.d.ts +21 -0
- package/typings/classes/PathFollow2D.d.ts +45 -0
- package/typings/classes/PathFollow3D.d.ts +76 -0
- package/typings/classes/Performance.d.ts +229 -0
- package/typings/classes/PhysicalBone2D.d.ts +44 -0
- package/typings/classes/PhysicalBone3D.d.ts +130 -0
- package/typings/classes/PhysicalBoneSimulator3D.d.ts +29 -0
- package/typings/classes/PhysicalSkyMaterial.d.ts +66 -0
- package/typings/classes/PhysicsBody2D.d.ts +34 -0
- package/typings/classes/PhysicsBody3D.d.ts +51 -0
- package/typings/classes/PhysicsDirectBodyState2D.d.ts +162 -0
- package/typings/classes/PhysicsDirectBodyState2DExtension.d.ts +132 -0
- package/typings/classes/PhysicsDirectBodyState3D.d.ts +165 -0
- package/typings/classes/PhysicsDirectBodyState3DExtension.d.ts +58 -0
- package/typings/classes/PhysicsDirectSpaceState2D.d.ts +58 -0
- package/typings/classes/PhysicsDirectSpaceState2DExtension.d.ts +15 -0
- package/typings/classes/PhysicsDirectSpaceState3D.d.ts +62 -0
- package/typings/classes/PhysicsDirectSpaceState3DExtension.d.ts +16 -0
- package/typings/classes/PhysicsMaterial.d.ts +27 -0
- package/typings/classes/PhysicsPointQueryParameters2D.d.ts +38 -0
- package/typings/classes/PhysicsPointQueryParameters3D.d.ts +31 -0
- package/typings/classes/PhysicsRayQueryParameters2D.d.ts +46 -0
- package/typings/classes/PhysicsRayQueryParameters3D.d.ts +52 -0
- package/typings/classes/PhysicsServer2D.d.ts +739 -0
- package/typings/classes/PhysicsServer2DExtension.d.ts +354 -0
- package/typings/classes/PhysicsServer2DManager.d.ts +16 -0
- package/typings/classes/PhysicsServer3D.d.ts +1028 -0
- package/typings/classes/PhysicsServer3DExtension.d.ts +204 -0
- package/typings/classes/PhysicsServer3DManager.d.ts +16 -0
- package/typings/classes/PhysicsServer3DRenderingServerHandler.d.ts +26 -0
- package/typings/classes/PhysicsShapeQueryParameters2D.d.ts +51 -0
- package/typings/classes/PhysicsShapeQueryParameters3D.d.ts +51 -0
- package/typings/classes/PhysicsTestMotionParameters2D.d.ts +46 -0
- package/typings/classes/PhysicsTestMotionParameters3D.d.ts +52 -0
- package/typings/classes/PhysicsTestMotionResult2D.d.ts +38 -0
- package/typings/classes/PhysicsTestMotionResult3D.d.ts +54 -0
- package/typings/classes/PinJoint2D.d.ts +34 -0
- package/typings/classes/PinJoint3D.d.ts +35 -0
- package/typings/classes/PlaceholderCubemap.d.ts +6 -0
- package/typings/classes/PlaceholderCubemapArray.d.ts +6 -0
- package/typings/classes/PlaceholderMaterial.d.ts +6 -0
- package/typings/classes/PlaceholderMesh.d.ts +9 -0
- package/typings/classes/PlaceholderTexture2D.d.ts +11 -0
- package/typings/classes/PlaceholderTexture2DArray.d.ts +6 -0
- package/typings/classes/PlaceholderTexture3D.d.ts +10 -0
- package/typings/classes/PlaceholderTextureLayered.d.ts +13 -0
- package/typings/classes/Plane.d.ts +143 -0
- package/typings/classes/PlaneMesh.d.ts +38 -0
- package/typings/classes/PointLight2D.d.ts +22 -0
- package/typings/classes/PointMesh.d.ts +6 -0
- package/typings/classes/Polygon2D.d.ts +101 -0
- package/typings/classes/PolygonOccluder3D.d.ts +13 -0
- package/typings/classes/PolygonPathFinder.d.ts +18 -0
- package/typings/classes/Popup.d.ts +18 -0
- package/typings/classes/PopupMenu.d.ts +349 -0
- package/typings/classes/PopupPanel.d.ts +10 -0
- package/typings/classes/PortableCompressedTexture2D.d.ts +47 -0
- package/typings/classes/PrimitiveMesh.d.ts +48 -0
- package/typings/classes/PrismMesh.d.ts +28 -0
- package/typings/classes/ProceduralSkyMaterial.d.ts +68 -0
- package/typings/classes/ProgressBar.d.ts +38 -0
- package/typings/classes/ProjectSettings.d.ts +3818 -0
- package/typings/classes/Projection.d.ts +193 -0
- package/typings/classes/PropertyTweener.d.ts +38 -0
- package/typings/classes/QuadMesh.d.ts +8 -0
- package/typings/classes/QuadOccluder3D.d.ts +10 -0
- package/typings/classes/Quaternion.d.ts +188 -0
- package/typings/classes/RDAttachmentFormat.d.ts +18 -0
- package/typings/classes/RDFramebufferPass.d.ts +33 -0
- package/typings/classes/RDPipelineColorBlendState.d.ts +22 -0
- package/typings/classes/RDPipelineColorBlendStateAttachment.d.ts +61 -0
- package/typings/classes/RDPipelineDepthStencilState.d.ts +102 -0
- package/typings/classes/RDPipelineMultisampleState.d.ts +42 -0
- package/typings/classes/RDPipelineRasterizationState.d.ts +64 -0
- package/typings/classes/RDPipelineSpecializationConstant.d.ts +18 -0
- package/typings/classes/RDSamplerState.d.ts +91 -0
- package/typings/classes/RDShaderFile.d.ts +21 -0
- package/typings/classes/RDShaderSPIRV.d.ts +85 -0
- package/typings/classes/RDShaderSource.d.ts +40 -0
- package/typings/classes/RDTextureFormat.d.ts +62 -0
- package/typings/classes/RDTextureView.d.ts +28 -0
- package/typings/classes/RDUniform.d.ts +23 -0
- package/typings/classes/RDVertexAttribute.d.ts +35 -0
- package/typings/classes/RID.d.ts +65 -0
- package/typings/classes/RandomNumberGenerator.d.ts +45 -0
- package/typings/classes/Range.d.ts +76 -0
- package/typings/classes/RayCast2D.d.ts +90 -0
- package/typings/classes/RayCast3D.d.ts +113 -0
- package/typings/classes/Rect2.d.ts +135 -0
- package/typings/classes/Rect2i.d.ts +127 -0
- package/typings/classes/RectangleShape2D.d.ts +10 -0
- package/typings/classes/RefCounted.d.ts +23 -0
- package/typings/classes/ReferenceRect.d.ts +22 -0
- package/typings/classes/ReflectionProbe.d.ts +118 -0
- package/typings/classes/RemoteTransform2D.d.ts +33 -0
- package/typings/classes/RemoteTransform3D.d.ts +33 -0
- package/typings/classes/RenderData.d.ts +20 -0
- package/typings/classes/RenderDataExtension.d.ts +18 -0
- package/typings/classes/RenderDataRD.d.ts +6 -0
- package/typings/classes/RenderSceneBuffers.d.ts +10 -0
- package/typings/classes/RenderSceneBuffersConfiguration.d.ts +48 -0
- package/typings/classes/RenderSceneBuffersExtension.d.ts +16 -0
- package/typings/classes/RenderSceneBuffersRD.d.ts +85 -0
- package/typings/classes/RenderSceneData.d.ts +29 -0
- package/typings/classes/RenderSceneDataExtension.d.ts +20 -0
- package/typings/classes/RenderSceneDataRD.d.ts +6 -0
- package/typings/classes/RenderingDevice.d.ts +2373 -0
- package/typings/classes/RenderingServer.d.ts +3501 -0
- package/typings/classes/Resource.d.ts +130 -0
- package/typings/classes/ResourceFormatLoader.d.ts +73 -0
- package/typings/classes/ResourceFormatSaver.d.ts +26 -0
- package/typings/classes/ResourceImporter.d.ts +18 -0
- package/typings/classes/ResourceImporterBMFont.d.ts +14 -0
- package/typings/classes/ResourceImporterBitMap.d.ts +16 -0
- package/typings/classes/ResourceImporterCSVTranslation.d.ts +23 -0
- package/typings/classes/ResourceImporterDynamicFont.d.ts +96 -0
- package/typings/classes/ResourceImporterImage.d.ts +6 -0
- package/typings/classes/ResourceImporterImageFont.d.ts +46 -0
- package/typings/classes/ResourceImporterLayeredTexture.d.ts +65 -0
- package/typings/classes/ResourceImporterOBJ.d.ts +38 -0
- package/typings/classes/ResourceImporterSVG.d.ts +24 -0
- package/typings/classes/ResourceImporterScene.d.ts +114 -0
- package/typings/classes/ResourceImporterShaderFile.d.ts +6 -0
- package/typings/classes/ResourceImporterTexture.d.ts +188 -0
- package/typings/classes/ResourceImporterTextureAtlas.d.ts +27 -0
- package/typings/classes/ResourceImporterWAV.d.ts +57 -0
- package/typings/classes/ResourceLoader.d.ts +106 -0
- package/typings/classes/ResourcePreloader.d.ts +20 -0
- package/typings/classes/ResourceSaver.d.ts +53 -0
- package/typings/classes/ResourceUID.d.ts +59 -0
- package/typings/classes/RetargetModifier3D.d.ts +51 -0
- package/typings/classes/RibbonTrailMesh.d.ts +42 -0
- package/typings/classes/RichTextEffect.d.ts +10 -0
- package/typings/classes/RichTextLabel.d.ts +524 -0
- package/typings/classes/RigidBody2D.d.ts +280 -0
- package/typings/classes/RigidBody3D.d.ts +271 -0
- package/typings/classes/RootMotionView.d.ts +30 -0
- package/typings/classes/SceneState.d.ts +93 -0
- package/typings/classes/SceneTree.d.ts +257 -0
- package/typings/classes/SceneTreeTimer.d.ts +13 -0
- package/typings/classes/Script.d.ts +64 -0
- package/typings/classes/ScriptBacktrace.d.ts +63 -0
- package/typings/classes/ScriptCreateDialog.d.ts +17 -0
- package/typings/classes/ScriptEditor.d.ts +60 -0
- package/typings/classes/ScriptEditorBase.d.ts +39 -0
- package/typings/classes/ScriptExtension.d.ts +48 -0
- package/typings/classes/ScriptLanguage.d.ts +12 -0
- package/typings/classes/ScriptLanguageExtension.d.ts +110 -0
- package/typings/classes/ScrollBar.d.ts +19 -0
- package/typings/classes/ScrollContainer.d.ts +120 -0
- package/typings/classes/SegmentShape2D.d.ts +14 -0
- package/typings/classes/Semaphore.d.ts +14 -0
- package/typings/classes/SeparationRayShape2D.d.ts +17 -0
- package/typings/classes/SeparationRayShape3D.d.ts +17 -0
- package/typings/classes/Separator.d.ts +6 -0
- package/typings/classes/Shader.d.ts +48 -0
- package/typings/classes/ShaderGlobalsOverride.d.ts +6 -0
- package/typings/classes/ShaderInclude.d.ts +12 -0
- package/typings/classes/ShaderIncludeDB.d.ts +14 -0
- package/typings/classes/ShaderMaterial.d.ts +19 -0
- package/typings/classes/Shape2D.d.ts +44 -0
- package/typings/classes/Shape3D.d.ts +24 -0
- package/typings/classes/ShapeCast2D.d.ts +107 -0
- package/typings/classes/ShapeCast3D.d.ts +116 -0
- package/typings/classes/Shortcut.d.ts +22 -0
- package/typings/classes/Signal.d.ts +86 -0
- package/typings/classes/Skeleton2D.d.ts +35 -0
- package/typings/classes/Skeleton3D.d.ts +225 -0
- package/typings/classes/SkeletonIK3D.d.ts +83 -0
- package/typings/classes/SkeletonModification2D.d.ts +52 -0
- package/typings/classes/SkeletonModification2DCCDIK.d.ts +64 -0
- package/typings/classes/SkeletonModification2DFABRIK.d.ts +40 -0
- package/typings/classes/SkeletonModification2DJiggle.d.ts +97 -0
- package/typings/classes/SkeletonModification2DLookAt.d.ts +48 -0
- package/typings/classes/SkeletonModification2DPhysicalBones.d.ts +32 -0
- package/typings/classes/SkeletonModification2DStackHolder.d.ts +12 -0
- package/typings/classes/SkeletonModification2DTwoBoneIK.d.ts +57 -0
- package/typings/classes/SkeletonModificationStack2D.d.ts +46 -0
- package/typings/classes/SkeletonModifier3D.d.ts +101 -0
- package/typings/classes/SkeletonProfile.d.ts +119 -0
- package/typings/classes/SkeletonProfileHumanoid.d.ts +10 -0
- package/typings/classes/Skin.d.ts +16 -0
- package/typings/classes/SkinReference.d.ts +15 -0
- package/typings/classes/Sky.d.ts +61 -0
- package/typings/classes/Slider.d.ts +49 -0
- package/typings/classes/SliderJoint3D.d.ts +166 -0
- package/typings/classes/SocketServer.d.ts +14 -0
- package/typings/classes/SoftBody3D.d.ts +136 -0
- package/typings/classes/SphereMesh.d.ts +29 -0
- package/typings/classes/SphereOccluder3D.d.ts +10 -0
- package/typings/classes/SphereShape3D.d.ts +10 -0
- package/typings/classes/SpinBox.d.ts +60 -0
- package/typings/classes/SplineIK3D.d.ts +37 -0
- package/typings/classes/SplitContainer.d.ts +114 -0
- package/typings/classes/SpotLight3D.d.ts +28 -0
- package/typings/classes/SpringArm3D.d.ts +47 -0
- package/typings/classes/SpringBoneCollision3D.d.ts +25 -0
- package/typings/classes/SpringBoneCollisionCapsule3D.d.ts +30 -0
- package/typings/classes/SpringBoneCollisionPlane3D.d.ts +6 -0
- package/typings/classes/SpringBoneCollisionSphere3D.d.ts +14 -0
- package/typings/classes/SpringBoneSimulator3D.d.ts +283 -0
- package/typings/classes/Sprite2D.d.ts +88 -0
- package/typings/classes/Sprite3D.d.ts +51 -0
- package/typings/classes/SpriteBase3D.d.ts +147 -0
- package/typings/classes/SpriteFrames.d.ts +57 -0
- package/typings/classes/StandardMaterial3D.d.ts +6 -0
- package/typings/classes/StaticBody2D.d.ts +27 -0
- package/typings/classes/StaticBody3D.d.ts +27 -0
- package/typings/classes/StatusIndicator.d.ts +36 -0
- package/typings/classes/StreamPeer.d.ts +102 -0
- package/typings/classes/StreamPeerBuffer.d.ts +23 -0
- package/typings/classes/StreamPeerExtension.d.ts +10 -0
- package/typings/classes/StreamPeerGZIP.d.ts +21 -0
- package/typings/classes/StreamPeerSocket.d.ts +22 -0
- package/typings/classes/StreamPeerTCP.d.ts +26 -0
- package/typings/classes/StreamPeerTLS.d.ts +40 -0
- package/typings/classes/StreamPeerUDS.d.ts +15 -0
- package/typings/classes/String.d.ts +475 -0
- package/typings/classes/StringName.d.ts +4 -0
- package/typings/classes/StyleBox.d.ts +64 -0
- package/typings/classes/StyleBoxEmpty.d.ts +6 -0
- package/typings/classes/StyleBoxFlat.d.ts +120 -0
- package/typings/classes/StyleBoxLine.d.ts +30 -0
- package/typings/classes/StyleBoxTexture.d.ts +99 -0
- package/typings/classes/SubViewport.d.ts +57 -0
- package/typings/classes/SubViewportContainer.d.ts +33 -0
- package/typings/classes/SubtweenTweener.d.ts +10 -0
- package/typings/classes/SurfaceTool.d.ts +178 -0
- package/typings/classes/SyntaxHighlighter.d.ts +33 -0
- package/typings/classes/SystemFont.d.ts +94 -0
- package/typings/classes/TCPServer.d.ts +17 -0
- package/typings/classes/TLSOptions.d.ts +38 -0
- package/typings/classes/TabBar.d.ts +203 -0
- package/typings/classes/TabContainer.d.ts +184 -0
- package/typings/classes/TextEdit.d.ts +877 -0
- package/typings/classes/TextLine.d.ts +100 -0
- package/typings/classes/TextMesh.d.ts +103 -0
- package/typings/classes/TextParagraph.d.ts +160 -0
- package/typings/classes/TextServer.d.ts +1006 -0
- package/typings/classes/TextServerDummy.d.ts +6 -0
- package/typings/classes/TextServerExtension.d.ts +586 -0
- package/typings/classes/TextServerManager.d.ts +31 -0
- package/typings/classes/Texture.d.ts +6 -0
- package/typings/classes/Texture2D.d.ts +69 -0
- package/typings/classes/Texture2DArray.d.ts +10 -0
- package/typings/classes/Texture2DArrayRD.d.ts +6 -0
- package/typings/classes/Texture2DRD.d.ts +11 -0
- package/typings/classes/Texture3D.d.ts +36 -0
- package/typings/classes/Texture3DRD.d.ts +10 -0
- package/typings/classes/TextureButton.d.ts +80 -0
- package/typings/classes/TextureCubemapArrayRD.d.ts +6 -0
- package/typings/classes/TextureCubemapRD.d.ts +6 -0
- package/typings/classes/TextureLayered.d.ts +46 -0
- package/typings/classes/TextureLayeredRD.d.ts +10 -0
- package/typings/classes/TextureProgressBar.d.ts +120 -0
- package/typings/classes/TextureRect.d.ts +69 -0
- package/typings/classes/Theme.d.ts +335 -0
- package/typings/classes/ThemeDB.d.ts +58 -0
- package/typings/classes/Thread.d.ts +55 -0
- package/typings/classes/TileData.d.ts +155 -0
- package/typings/classes/TileMap.d.ts +303 -0
- package/typings/classes/TileMapLayer.d.ts +244 -0
- package/typings/classes/TileMapPattern.d.ts +26 -0
- package/typings/classes/TileSet.d.ts +348 -0
- package/typings/classes/TileSetAtlasSource.d.ts +160 -0
- package/typings/classes/TileSetScenesCollectionSource.d.ts +37 -0
- package/typings/classes/TileSetSource.d.ts +24 -0
- package/typings/classes/Time.d.ts +149 -0
- package/typings/classes/Timer.d.ts +71 -0
- package/typings/classes/TorusMesh.d.ts +22 -0
- package/typings/classes/TouchScreenButton.d.ts +61 -0
- package/typings/classes/Transform2D.d.ts +207 -0
- package/typings/classes/Transform3D.d.ts +173 -0
- package/typings/classes/Translation.d.ts +51 -0
- package/typings/classes/TranslationDomain.d.ts +115 -0
- package/typings/classes/TranslationServer.d.ts +117 -0
- package/typings/classes/Tree.d.ts +298 -0
- package/typings/classes/TreeItem.d.ts +374 -0
- package/typings/classes/TriangleMesh.d.ts +33 -0
- package/typings/classes/TubeTrailMesh.d.ts +50 -0
- package/typings/classes/Tween.d.ts +218 -0
- package/typings/classes/Tweener.d.ts +11 -0
- package/typings/classes/TwoBoneIK3D.d.ts +87 -0
- package/typings/classes/UDPServer.d.ts +35 -0
- package/typings/classes/UDSServer.d.ts +13 -0
- package/typings/classes/UndoRedo.d.ts +92 -0
- package/typings/classes/UniformSetCacheRD.d.ts +8 -0
- package/typings/classes/VBoxContainer.d.ts +6 -0
- package/typings/classes/VFlowContainer.d.ts +6 -0
- package/typings/classes/VScrollBar.d.ts +8 -0
- package/typings/classes/VSeparator.d.ts +6 -0
- package/typings/classes/VSlider.d.ts +8 -0
- package/typings/classes/VSplitContainer.d.ts +8 -0
- package/typings/classes/Variant.d.ts +6 -0
- package/typings/classes/Vector2.d.ts +298 -0
- package/typings/classes/Vector2i.d.ts +166 -0
- package/typings/classes/Vector3.d.ts +309 -0
- package/typings/classes/Vector3i.d.ts +172 -0
- package/typings/classes/Vector4.d.ts +216 -0
- package/typings/classes/Vector4i.d.ts +164 -0
- package/typings/classes/VehicleBody3D.d.ts +26 -0
- package/typings/classes/VehicleWheel3D.d.ts +112 -0
- package/typings/classes/VideoStream.d.ts +18 -0
- package/typings/classes/VideoStreamPlayback.d.ts +52 -0
- package/typings/classes/VideoStreamPlayer.d.ts +82 -0
- package/typings/classes/Viewport.d.ts +815 -0
- package/typings/classes/ViewportTexture.d.ts +13 -0
- package/typings/classes/VirtualJoystick.d.ts +94 -0
- package/typings/classes/VisibleOnScreenEnabler2D.d.ts +26 -0
- package/typings/classes/VisibleOnScreenEnabler3D.d.ts +26 -0
- package/typings/classes/VisibleOnScreenNotifier2D.d.ts +27 -0
- package/typings/classes/VisibleOnScreenNotifier3D.d.ts +20 -0
- package/typings/classes/VisualInstance3D.d.ts +53 -0
- package/typings/classes/VisualShader.d.ts +112 -0
- package/typings/classes/VisualShaderNode.d.ts +63 -0
- package/typings/classes/VisualShaderNodeBillboard.d.ts +28 -0
- package/typings/classes/VisualShaderNodeBooleanConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeBooleanParameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeClamp.d.ts +26 -0
- package/typings/classes/VisualShaderNodeColorConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeColorFunc.d.ts +32 -0
- package/typings/classes/VisualShaderNodeColorOp.d.ts +32 -0
- package/typings/classes/VisualShaderNodeColorParameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeComment.d.ts +12 -0
- package/typings/classes/VisualShaderNodeCompare.d.ts +68 -0
- package/typings/classes/VisualShaderNodeConstant.d.ts +6 -0
- package/typings/classes/VisualShaderNodeCubemap.d.ts +43 -0
- package/typings/classes/VisualShaderNodeCubemapParameter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeCurveTexture.d.ts +10 -0
- package/typings/classes/VisualShaderNodeCurveXYZTexture.d.ts +10 -0
- package/typings/classes/VisualShaderNodeCustom.d.ts +122 -0
- package/typings/classes/VisualShaderNodeDerivativeFunc.d.ts +56 -0
- package/typings/classes/VisualShaderNodeDeterminant.d.ts +6 -0
- package/typings/classes/VisualShaderNodeDistanceFade.d.ts +6 -0
- package/typings/classes/VisualShaderNodeDotProduct.d.ts +6 -0
- package/typings/classes/VisualShaderNodeExpression.d.ts +12 -0
- package/typings/classes/VisualShaderNodeFaceForward.d.ts +8 -0
- package/typings/classes/VisualShaderNodeFloatConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeFloatFunc.d.ts +108 -0
- package/typings/classes/VisualShaderNodeFloatOp.d.ts +36 -0
- package/typings/classes/VisualShaderNodeFloatParameter.d.ts +52 -0
- package/typings/classes/VisualShaderNodeFrame.d.ts +35 -0
- package/typings/classes/VisualShaderNodeFresnel.d.ts +6 -0
- package/typings/classes/VisualShaderNodeGlobalExpression.d.ts +6 -0
- package/typings/classes/VisualShaderNodeGroupBase.d.ts +60 -0
- package/typings/classes/VisualShaderNodeIf.d.ts +8 -0
- package/typings/classes/VisualShaderNodeInput.d.ts +20 -0
- package/typings/classes/VisualShaderNodeIntConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeIntFunc.d.ts +24 -0
- package/typings/classes/VisualShaderNodeIntOp.d.ts +48 -0
- package/typings/classes/VisualShaderNodeIntParameter.d.ts +58 -0
- package/typings/classes/VisualShaderNodeIs.d.ts +18 -0
- package/typings/classes/VisualShaderNodeLinearSceneDepth.d.ts +6 -0
- package/typings/classes/VisualShaderNodeMix.d.ts +28 -0
- package/typings/classes/VisualShaderNodeMultiplyAdd.d.ts +22 -0
- package/typings/classes/VisualShaderNodeOuterProduct.d.ts +6 -0
- package/typings/classes/VisualShaderNodeOutput.d.ts +6 -0
- package/typings/classes/VisualShaderNodeParameter.d.ts +32 -0
- package/typings/classes/VisualShaderNodeParameterRef.d.ts +10 -0
- package/typings/classes/VisualShaderNodeParticleAccelerator.d.ts +20 -0
- package/typings/classes/VisualShaderNodeParticleBoxEmitter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeParticleConeVelocity.d.ts +6 -0
- package/typings/classes/VisualShaderNodeParticleEmit.d.ts +22 -0
- package/typings/classes/VisualShaderNodeParticleEmitter.d.ts +12 -0
- package/typings/classes/VisualShaderNodeParticleMeshEmitter.d.ts +20 -0
- package/typings/classes/VisualShaderNodeParticleMultiplyByAxisAngle.d.ts +10 -0
- package/typings/classes/VisualShaderNodeParticleOutput.d.ts +6 -0
- package/typings/classes/VisualShaderNodeParticleRandomness.d.ts +22 -0
- package/typings/classes/VisualShaderNodeParticleRingEmitter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeParticleSphereEmitter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeProximityFade.d.ts +6 -0
- package/typings/classes/VisualShaderNodeRandomRange.d.ts +6 -0
- package/typings/classes/VisualShaderNodeRemap.d.ts +33 -0
- package/typings/classes/VisualShaderNodeReroute.d.ts +8 -0
- package/typings/classes/VisualShaderNodeResizableBase.d.ts +10 -0
- package/typings/classes/VisualShaderNodeRotationByAxis.d.ts +6 -0
- package/typings/classes/VisualShaderNodeSDFRaymarch.d.ts +6 -0
- package/typings/classes/VisualShaderNodeSDFToScreenUV.d.ts +8 -0
- package/typings/classes/VisualShaderNodeSample3D.d.ts +18 -0
- package/typings/classes/VisualShaderNodeScreenNormalWorldSpace.d.ts +6 -0
- package/typings/classes/VisualShaderNodeScreenUVToSDF.d.ts +8 -0
- package/typings/classes/VisualShaderNodeSmoothStep.d.ts +28 -0
- package/typings/classes/VisualShaderNodeStep.d.ts +28 -0
- package/typings/classes/VisualShaderNodeSwitch.d.ts +30 -0
- package/typings/classes/VisualShaderNodeTexture.d.ts +57 -0
- package/typings/classes/VisualShaderNodeTexture2DArray.d.ts +12 -0
- package/typings/classes/VisualShaderNodeTexture2DArrayParameter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTexture2DParameter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTexture3D.d.ts +12 -0
- package/typings/classes/VisualShaderNodeTexture3DParameter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTextureParameter.d.ts +104 -0
- package/typings/classes/VisualShaderNodeTextureParameterTriplanar.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTextureSDF.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTextureSDFNormal.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTransformCompose.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTransformConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeTransformDecompose.d.ts +6 -0
- package/typings/classes/VisualShaderNodeTransformFunc.d.ts +18 -0
- package/typings/classes/VisualShaderNodeTransformOp.d.ts +32 -0
- package/typings/classes/VisualShaderNodeTransformParameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeTransformVecMult.d.ts +22 -0
- package/typings/classes/VisualShaderNodeUIntConstant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeUIntFunc.d.ts +20 -0
- package/typings/classes/VisualShaderNodeUIntOp.d.ts +48 -0
- package/typings/classes/VisualShaderNodeUIntParameter.d.ts +16 -0
- package/typings/classes/VisualShaderNodeUVFunc.d.ts +22 -0
- package/typings/classes/VisualShaderNodeUVPolarCoord.d.ts +6 -0
- package/typings/classes/VisualShaderNodeVarying.d.ts +14 -0
- package/typings/classes/VisualShaderNodeVaryingGetter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeVaryingSetter.d.ts +6 -0
- package/typings/classes/VisualShaderNodeVec2Constant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeVec2Parameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeVec3Constant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeVec3Parameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeVec4Constant.d.ts +10 -0
- package/typings/classes/VisualShaderNodeVec4Parameter.d.ts +14 -0
- package/typings/classes/VisualShaderNodeVectorBase.d.ts +20 -0
- package/typings/classes/VisualShaderNodeVectorCompose.d.ts +8 -0
- package/typings/classes/VisualShaderNodeVectorDecompose.d.ts +8 -0
- package/typings/classes/VisualShaderNodeVectorDistance.d.ts +6 -0
- package/typings/classes/VisualShaderNodeVectorFunc.d.ts +84 -0
- package/typings/classes/VisualShaderNodeVectorLen.d.ts +6 -0
- package/typings/classes/VisualShaderNodeVectorOp.d.ts +42 -0
- package/typings/classes/VisualShaderNodeVectorRefract.d.ts +8 -0
- package/typings/classes/VisualShaderNodeWorldPositionFromDepth.d.ts +8 -0
- package/typings/classes/VoxelGI.d.ts +54 -0
- package/typings/classes/VoxelGIData.d.ts +70 -0
- package/typings/classes/WeakRef.d.ts +12 -0
- package/typings/classes/Window.d.ts +790 -0
- package/typings/classes/WorkerThreadPool.d.ts +55 -0
- package/typings/classes/World2D.d.ts +24 -0
- package/typings/classes/World3D.d.ts +32 -0
- package/typings/classes/WorldBoundaryShape2D.d.ts +19 -0
- package/typings/classes/WorldBoundaryShape3D.d.ts +10 -0
- package/typings/classes/WorldEnvironment.d.ts +22 -0
- package/typings/classes/X509Certificate.d.ts +16 -0
- package/typings/classes/XMLParser.d.ts +74 -0
- package/typings/classes/XRAnchor3D.d.ts +12 -0
- package/typings/classes/XRBodyModifier3D.d.ts +35 -0
- package/typings/classes/XRBodyTracker.d.ts +218 -0
- package/typings/classes/XRCamera3D.d.ts +7 -0
- package/typings/classes/XRController3D.d.ts +39 -0
- package/typings/classes/XRControllerTracker.d.ts +7 -0
- package/typings/classes/XRFaceModifier3D.d.ts +14 -0
- package/typings/classes/XRFaceTracker.d.ts +308 -0
- package/typings/classes/XRHandModifier3D.d.ts +24 -0
- package/typings/classes/XRHandTracker.d.ts +127 -0
- package/typings/classes/XRInterface.d.ts +181 -0
- package/typings/classes/XRInterfaceExtension.d.ts +94 -0
- package/typings/classes/XRNode3D.d.ts +46 -0
- package/typings/classes/XROrigin3D.d.ts +18 -0
- package/typings/classes/XRPose.d.ts +55 -0
- package/typings/classes/XRPositionalTracker.d.ts +64 -0
- package/typings/classes/XRServer.d.ts +130 -0
- package/typings/classes/XRTracker.d.ts +27 -0
- package/typings/classes/XRVRS.d.ts +28 -0
- package/typings/classes/_globals.d.ts +2243 -0
- package/typings/classes/_number-ops.d.ts +19 -0
- package/typings/classes/index.d.ts +915 -0
- package/typings/globals/gd-helpers.d.ts +354 -0
- package/typings/globals/globals.d.ts +511 -0
- package/typings/godot-class-registry.json +61322 -0
- package/typings/index.d.ts +3 -0
- package/typings-overrides/_globals.d.ts +114 -0
- package/typings-overrides/array.d.ts +54 -0
- package/typings-overrides/callable-function.d.ts +92 -0
- package/typings-overrides/class-db.d.ts +19 -0
- package/typings-overrides/dictionary.d.ts +26 -0
- package/typings-overrides/function.d.ts +29 -0
- package/typings-overrides/godot-object.d.ts +32 -0
- package/typings-overrides/node.d.ts +9 -0
- package/typings-overrides/non-nullable.json +117 -0
- package/typings-overrides/packed-scene.d.ts +7 -0
- package/typings-overrides/project-settings.d.ts +73 -0
- package/typings-overrides/property-tweener.d.ts +8 -0
- package/typings-overrides/resource.d.ts +3 -0
- package/typings-overrides/scene-tree.d.ts +54 -0
- package/typings-overrides/signal.d.ts +10 -0
- package/typings-overrides/tween.d.ts +18 -0
|
@@ -0,0 +1,2243 @@
|
|
|
1
|
+
// AUTO-GENERATED from Godot class documentation.
|
|
2
|
+
// Manual overrides applied from typings-overrides/*.d.ts
|
|
3
|
+
|
|
4
|
+
// @GlobalScope — global functions and constants
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Override: Global functions — adds generic type parameters to polymorphic functions.
|
|
8
|
+
*/
|
|
9
|
+
declare function abs<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T): T;
|
|
10
|
+
/** Returns the absolute value of float parameter `x` (i.e. positive value). */
|
|
11
|
+
declare function absf(x: float): float;
|
|
12
|
+
/** Returns the absolute value of int parameter `x` (i.e. positive value). */
|
|
13
|
+
declare function absi(x: int): int;
|
|
14
|
+
/**
|
|
15
|
+
* Returns the arc cosine of `x` in radians. Use to get the angle of cosine `x`. `x` will be clamped between `-1.0` and `1.0` (inclusive), in order to prevent {@link acos} from returning {@link @GDScript.NAN}.
|
|
16
|
+
*/
|
|
17
|
+
declare function acos(x: float): float;
|
|
18
|
+
/**
|
|
19
|
+
* Returns the hyperbolic arc (also called inverse) cosine of `x`, returning a value in radians. Use it to get the angle from an angle's cosine in hyperbolic space if `x` is larger or equal to 1. For values of `x` lower than 1, it will return 0, in order to prevent {@link acosh} from returning {@link @GDScript.NAN}.
|
|
20
|
+
*/
|
|
21
|
+
declare function acosh(x: float): float;
|
|
22
|
+
/**
|
|
23
|
+
* Returns the difference between the two angles (in radians), in the range of `[-PI, +PI]`. When `from` and `to` are opposite, returns `-PI` if `from` is smaller than `to`, or `PI` otherwise.
|
|
24
|
+
*/
|
|
25
|
+
declare function angle_difference(from_: float, to: float): float;
|
|
26
|
+
/**
|
|
27
|
+
* Returns the arc sine of `x` in radians. Use to get the angle of sine `x`. `x` will be clamped between `-1.0` and `1.0` (inclusive), in order to prevent {@link asin} from returning {@link @GDScript.NAN}.
|
|
28
|
+
*/
|
|
29
|
+
declare function asin(x: float): float;
|
|
30
|
+
/**
|
|
31
|
+
* Returns the hyperbolic arc (also called inverse) sine of `x`, returning a value in radians. Use it to get the angle from an angle's sine in hyperbolic space.
|
|
32
|
+
*/
|
|
33
|
+
declare function asinh(x: float): float;
|
|
34
|
+
/**
|
|
35
|
+
* Returns the arc tangent of `x` in radians. Use it to get the angle from an angle's tangent in trigonometry.
|
|
36
|
+
* The method cannot know in which quadrant the angle should fall. See {@link atan2} if you have both `y` and [code skip-lint]x[/code].
|
|
37
|
+
* If `x` is between `-PI / 2` and `PI / 2` (inclusive), `atan(tan(x))` is equal to `x`.
|
|
38
|
+
*/
|
|
39
|
+
declare function atan(x: float): float;
|
|
40
|
+
/**
|
|
41
|
+
* Returns the arc tangent of `y/x` in radians. Use to get the angle of tangent `y/x`. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant.
|
|
42
|
+
* Important note: The Y coordinate comes first, by convention.
|
|
43
|
+
*/
|
|
44
|
+
declare function atan2(y: float, x: float): float;
|
|
45
|
+
/**
|
|
46
|
+
* Returns the hyperbolic arc (also called inverse) tangent of `x`, returning a value in radians. Use it to get the angle from an angle's tangent in hyperbolic space if `x` is between -1 and 1 (non-inclusive).
|
|
47
|
+
* In mathematics, the inverse hyperbolic tangent is only defined for -1 < `x` < 1 in the real set, so values equal or lower to -1 for `x` return negative {@link @GDScript.INF} and values equal or higher than 1 return positive {@link @GDScript.INF} in order to prevent {@link atanh} from returning {@link @GDScript.NAN}.
|
|
48
|
+
*/
|
|
49
|
+
declare function atanh(x: float): float;
|
|
50
|
+
/**
|
|
51
|
+
* Returns the derivative at the given `t` on a one-dimensional Bézier curve (https://en.wikipedia.org/wiki/B%C3%A9zier_curve) defined by the given `control_1`, `control_2`, and `end` points.
|
|
52
|
+
*/
|
|
53
|
+
declare function bezier_derivative(start: float, control_1: float, control_2: float, end: float, t: float): float;
|
|
54
|
+
/**
|
|
55
|
+
* Returns the point at the given `t` on a one-dimensional Bézier curve (https://en.wikipedia.org/wiki/B%C3%A9zier_curve) defined by the given `control_1`, `control_2`, and `end` points.
|
|
56
|
+
*/
|
|
57
|
+
declare function bezier_interpolate(start: float, control_1: float, control_2: float, end: float, t: float): float;
|
|
58
|
+
/**
|
|
59
|
+
* Decodes a byte array back to a {@link Variant} value, without decoding objects.
|
|
60
|
+
* **Note:** If you need object deserialization, see {@link bytes_to_var_with_objects}.
|
|
61
|
+
*/
|
|
62
|
+
declare function bytes_to_var(bytes: PackedByteArray): unknown;
|
|
63
|
+
/**
|
|
64
|
+
* Decodes a byte array back to a {@link Variant} value. Decoding objects is allowed.
|
|
65
|
+
* **Warning:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).
|
|
66
|
+
*/
|
|
67
|
+
declare function bytes_to_var_with_objects(bytes: PackedByteArray): unknown;
|
|
68
|
+
/**
|
|
69
|
+
* Rounds `x` upward (towards positive infinity), returning the smallest whole number that is not less than `x`. Supported types: [int], [float], {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}.
|
|
70
|
+
* See also {@link floor}, {@link round}, and {@link snapped}.
|
|
71
|
+
* **Note:** For better type safety, use {@link ceilf}, {@link ceili}, {@link Vector2.ceil}, {@link Vector3.ceil}, or {@link Vector4.ceil}.
|
|
72
|
+
*/
|
|
73
|
+
declare function ceil<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T): T;
|
|
74
|
+
/**
|
|
75
|
+
* Rounds `x` upward (towards positive infinity), returning the smallest whole number that is not less than `x`.
|
|
76
|
+
* A type-safe version of {@link ceil}, returning a [float].
|
|
77
|
+
*/
|
|
78
|
+
declare function ceilf(x: float): float;
|
|
79
|
+
/**
|
|
80
|
+
* Rounds `x` upward (towards positive infinity), returning the smallest whole number that is not less than `x`.
|
|
81
|
+
* A type-safe version of {@link ceil}, returning an [int].
|
|
82
|
+
*/
|
|
83
|
+
declare function ceili(x: float): int;
|
|
84
|
+
/**
|
|
85
|
+
* Clamps the `value`, returning a {@link Variant} not less than `min` and not more than `max`. Any values that can be compared with the less than and greater than operators will work.
|
|
86
|
+
* **Note:** For better type safety, use {@link clampf}, {@link clampi}, {@link Vector2.clamp}, {@link Vector2i.clamp}, {@link Vector3.clamp}, {@link Vector3i.clamp}, {@link Vector4.clamp}, {@link Vector4i.clamp}, or {@link Color.clamp} (not currently supported by this method).
|
|
87
|
+
* **Note:** When using this on vectors it will *not* perform component-wise clamping, and will pick `min` if `value < min` or `max` if `value > max`. To perform component-wise clamping use the methods listed above.
|
|
88
|
+
*/
|
|
89
|
+
declare function clamp<T extends int | float>(value: T, min: T, max: T): T;
|
|
90
|
+
/** Clamps the `value`, returning a [float] not less than `min` and not more than `max`. */
|
|
91
|
+
declare function clampf(value: float, min: float, max: float): float;
|
|
92
|
+
/** Clamps the `value`, returning an [int] not less than `min` and not more than `max`. */
|
|
93
|
+
declare function clampi(value: int, min: int, max: int): int;
|
|
94
|
+
/** Returns the cosine of angle `angle_rad` in radians. */
|
|
95
|
+
declare function cos(angle_rad: float): float;
|
|
96
|
+
/** Returns the hyperbolic cosine of `x` in radians. */
|
|
97
|
+
declare function cosh(x: float): float;
|
|
98
|
+
/**
|
|
99
|
+
* Cubic interpolates between two values by the factor defined in `weight` with `pre` and `post` values.
|
|
100
|
+
*/
|
|
101
|
+
declare function cubic_interpolate(from_: float, to: float, pre: float, post: float, weight: float): float;
|
|
102
|
+
/**
|
|
103
|
+
* Cubic interpolates between two rotation values with shortest path by the factor defined in `weight` with `pre` and `post` values. See also {@link lerp_angle}.
|
|
104
|
+
*/
|
|
105
|
+
declare function cubic_interpolate_angle(from_: float, to: float, pre: float, post: float, weight: float): float;
|
|
106
|
+
/**
|
|
107
|
+
* Cubic interpolates between two rotation values with shortest path by the factor defined in `weight` with `pre` and `post` values. See also {@link lerp_angle}.
|
|
108
|
+
* It can perform smoother interpolation than {@link cubic_interpolate} by the time values.
|
|
109
|
+
*/
|
|
110
|
+
declare function cubic_interpolate_angle_in_time(from_: float, to: float, pre: float, post: float, weight: float, to_t: float, pre_t: float, post_t: float): float;
|
|
111
|
+
/**
|
|
112
|
+
* Cubic interpolates between two values by the factor defined in `weight` with `pre` and `post` values.
|
|
113
|
+
* It can perform smoother interpolation than {@link cubic_interpolate} by the time values.
|
|
114
|
+
*/
|
|
115
|
+
declare function cubic_interpolate_in_time(from_: float, to: float, pre: float, post: float, weight: float, to_t: float, pre_t: float, post_t: float): float;
|
|
116
|
+
/** Converts from decibels to linear energy (audio). */
|
|
117
|
+
declare function db_to_linear(db: float): float;
|
|
118
|
+
/** Converts an angle expressed in degrees to radians. */
|
|
119
|
+
declare function deg_to_rad(deg: float): float;
|
|
120
|
+
/**
|
|
121
|
+
* Returns an "eased" value of `x` based on an easing function defined with `curve`. This easing function is based on an exponent. The `curve` can be any floating-point number, with specific values leading to the following behaviors:
|
|
122
|
+
* [codeblock lang=text]
|
|
123
|
+
* - Lower than -1.0 (exclusive): Ease in-out
|
|
124
|
+
* - -1.0: Linear
|
|
125
|
+
* - Between -1.0 and 0.0 (exclusive): Ease out-in
|
|
126
|
+
* - 0.0: Constant
|
|
127
|
+
* - Between 0.0 to 1.0 (exclusive): Ease out
|
|
128
|
+
* - 1.0: Linear
|
|
129
|
+
* - Greater than 1.0 (exclusive): Ease in
|
|
130
|
+
* [/codeblock]
|
|
131
|
+
* ease() curve values cheatsheet (https://raw.githubusercontent.com/godotengine/godot-docs/master/img/ease_cheatsheet.png)
|
|
132
|
+
* See also {@link smoothstep}. If you need to perform more advanced transitions, use {@link Tween.interpolate_value}.
|
|
133
|
+
*/
|
|
134
|
+
declare function ease(x: float, curve: float): float;
|
|
135
|
+
/** Returns a human-readable name for the given {@link Error} code. */
|
|
136
|
+
declare function error_string(error: int): string;
|
|
137
|
+
/**
|
|
138
|
+
* The natural exponential function. It raises the mathematical constant *e* to the power of `x` and returns it.
|
|
139
|
+
* *e* has an approximate value of 2.71828, and can be obtained with `exp(1)`.
|
|
140
|
+
* For exponents to other bases use the method {@link pow}.
|
|
141
|
+
*/
|
|
142
|
+
declare function exp(x: float): float;
|
|
143
|
+
/**
|
|
144
|
+
* Rounds `x` downward (towards negative infinity), returning the largest whole number that is not more than `x`. Supported types: [int], [float], {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}.
|
|
145
|
+
* See also {@link ceil}, {@link round}, and {@link snapped}.
|
|
146
|
+
* **Note:** For better type safety, use {@link floorf}, {@link floori}, {@link Vector2.floor}, {@link Vector3.floor}, or {@link Vector4.floor}.
|
|
147
|
+
*/
|
|
148
|
+
declare function floor<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T): T;
|
|
149
|
+
/**
|
|
150
|
+
* Rounds `x` downward (towards negative infinity), returning the largest whole number that is not more than `x`.
|
|
151
|
+
* A type-safe version of {@link floor}, returning a [float].
|
|
152
|
+
*/
|
|
153
|
+
declare function floorf(x: float): float;
|
|
154
|
+
/**
|
|
155
|
+
* Rounds `x` downward (towards negative infinity), returning the largest whole number that is not more than `x`.
|
|
156
|
+
* A type-safe version of {@link floor}, returning an [int].
|
|
157
|
+
* **Note:** This function is *not* the same as `int(x)`, which rounds towards 0.
|
|
158
|
+
*/
|
|
159
|
+
declare function floori(x: float): int;
|
|
160
|
+
/**
|
|
161
|
+
* Returns the floating-point remainder of `x` divided by `y`, keeping the sign of `x`.
|
|
162
|
+
* For the integer remainder operation, use the `%` operator.
|
|
163
|
+
*/
|
|
164
|
+
declare function fmod(x: float, y: float): float;
|
|
165
|
+
/**
|
|
166
|
+
* Returns the floating-point modulus of `x` divided by `y`, wrapping equally in positive and negative.
|
|
167
|
+
* Prints:
|
|
168
|
+
* [codeblock lang=text]
|
|
169
|
+
* (x) (fmod(x, 1.5)) (fposmod(x, 1.5))
|
|
170
|
+
* -1.5 -0.0 | 0.0
|
|
171
|
+
* -1.0 -1.0 | 0.5
|
|
172
|
+
* -0.5 -0.5 | 1.0
|
|
173
|
+
* 0.0 0.0 | 0.0
|
|
174
|
+
* 0.5 0.5 | 0.5
|
|
175
|
+
* 1.0 1.0 | 1.0
|
|
176
|
+
* 1.5 0.0 | 0.0
|
|
177
|
+
* [/codeblock]
|
|
178
|
+
*/
|
|
179
|
+
declare function fposmod(x: float, y: float): float;
|
|
180
|
+
/** Returns the integer hash of the passed `variable`. */
|
|
181
|
+
declare function hash(variable: unknown): int;
|
|
182
|
+
/**
|
|
183
|
+
* Returns the {@link Object} that corresponds to `instance_id`. All Objects have a unique instance ID. See also {@link Object.get_instance_id}.
|
|
184
|
+
*/
|
|
185
|
+
declare function instance_from_id(instance_id: int): GodotObject;
|
|
186
|
+
/**
|
|
187
|
+
* Returns an interpolation or extrapolation factor considering the range specified in `from` and `to`, and the interpolated value specified in `weight`. The returned value will be between `0.0` and `1.0` if `weight` is between `from` and `to` (inclusive). If `weight` is located outside this range, then an extrapolation factor will be returned (return value lower than `0.0` or greater than `1.0`). Use {@link clamp} on the result of {@link inverse_lerp} if this is not desired.
|
|
188
|
+
* See also {@link lerp}, which performs the reverse of this operation, and {@link remap} to map a continuous series of values to another.
|
|
189
|
+
*/
|
|
190
|
+
declare function inverse_lerp(from_: float, to: float, weight: float): float;
|
|
191
|
+
/**
|
|
192
|
+
* Returns `true` if `a` and `b` are approximately equal to each other.
|
|
193
|
+
* Here, "approximately equal" means that `a` and `b` are within a small internal epsilon of each other, which scales with the magnitude of the numbers.
|
|
194
|
+
* Infinity values of the same sign are considered equal.
|
|
195
|
+
*/
|
|
196
|
+
declare function is_equal_approx(a: float, b: float): boolean;
|
|
197
|
+
/**
|
|
198
|
+
* Returns whether `x` is a finite value, i.e. it is not {@link @GDScript.NAN}, positive infinity, or negative infinity. See also {@link is_inf} and {@link is_nan}.
|
|
199
|
+
*/
|
|
200
|
+
declare function is_finite(x: float): boolean;
|
|
201
|
+
/**
|
|
202
|
+
* Returns `true` if `x` is either positive infinity or negative infinity. See also {@link is_finite} and {@link is_nan}.
|
|
203
|
+
*/
|
|
204
|
+
declare function is_inf(x: float): boolean;
|
|
205
|
+
/**
|
|
206
|
+
* Returns `true` if the Object that corresponds to `id` is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID.
|
|
207
|
+
*/
|
|
208
|
+
declare function is_instance_id_valid(id: int): boolean;
|
|
209
|
+
/** Returns `true` if `instance` is a valid Object (e.g. has not been deleted from memory). */
|
|
210
|
+
declare function is_instance_valid(instance: unknown): boolean;
|
|
211
|
+
/**
|
|
212
|
+
* Returns `true` if `x` is a NaN ("Not a Number" or invalid) value. This method is needed as {@link @GDScript.NAN} is not equal to itself, which means `x == NAN` can't be used to check whether a value is a NaN.
|
|
213
|
+
*/
|
|
214
|
+
declare function is_nan(x: float): boolean;
|
|
215
|
+
/**
|
|
216
|
+
* Returns `true`, for value types, if `a` and `b` share the same value. Returns `true`, for reference types, if the references of `a` and `b` are the same.
|
|
217
|
+
* These are {@link Variant} value types: `null`, [bool], [int], [float], {@link String}, {@link StringName}, {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}, {@link Rect2}, {@link Rect2i}, {@link Transform2D}, {@link Transform3D}, {@link Plane}, {@link Quaternion}, {@link AABB}, {@link Basis}, {@link Projection}, {@link Color}, {@link NodePath}, {@link RID}, {@link Callable} and {@link Signal}.
|
|
218
|
+
* These are {@link Variant} reference types: {@link Object}, {@link Dictionary}, {@link Array}, {@link PackedByteArray}, {@link PackedInt32Array}, {@link PackedInt64Array}, {@link PackedFloat32Array}, {@link PackedFloat64Array}, {@link PackedStringArray}, {@link PackedVector2Array}, {@link PackedVector3Array}, {@link PackedVector4Array}, and {@link PackedColorArray}.
|
|
219
|
+
*/
|
|
220
|
+
declare function is_same(a: unknown, b: unknown): boolean;
|
|
221
|
+
/**
|
|
222
|
+
* Returns `true` if `x` is zero or almost zero. The comparison is done using a tolerance calculation with a small internal epsilon.
|
|
223
|
+
* This function is faster than using {@link is_equal_approx} with one value as zero.
|
|
224
|
+
*/
|
|
225
|
+
declare function is_zero_approx(x: float): boolean;
|
|
226
|
+
/**
|
|
227
|
+
* Linearly interpolates between two values by the factor defined in `weight`. To perform interpolation, `weight` should be between `0.0` and `1.0` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use {@link clampf} to limit `weight`.
|
|
228
|
+
* Both `from` and `to` must be the same type. Supported types: [int], [float], {@link Vector2}, {@link Vector3}, {@link Vector4}, {@link Color}, {@link Quaternion}, {@link Basis}, {@link Transform2D}, {@link Transform3D}.
|
|
229
|
+
* See also {@link inverse_lerp} which performs the reverse of this operation. To perform eased interpolation with {@link lerp}, combine it with {@link ease} or {@link smoothstep}. See also {@link remap} to map a continuous series of values to another.
|
|
230
|
+
* **Note:** For better type safety, use {@link lerpf}, {@link Vector2.lerp}, {@link Vector3.lerp}, {@link Vector4.lerp}, {@link Color.lerp}, {@link Quaternion.slerp}, {@link Basis.slerp}, {@link Transform2D.interpolate_with}, or {@link Transform3D.interpolate_with}.
|
|
231
|
+
*/
|
|
232
|
+
declare function lerp<T extends int | float | Vector2 | Vector3 | Vector4 | Color | Quaternion | Basis | Transform2D | Transform3D>(from_: T, to: T, weight: float): T;
|
|
233
|
+
/**
|
|
234
|
+
* Linearly interpolates between two angles (in radians) by a `weight` value between 0.0 and 1.0.
|
|
235
|
+
* Similar to {@link lerp}, but interpolates correctly when the angles wrap around {@link @GDScript.TAU}. To perform eased interpolation with {@link lerp_angle}, combine it with {@link ease} or {@link smoothstep}.
|
|
236
|
+
* **Note:** This function lerps through the shortest path between `from` and `to`. However, when these two angles are approximately `PI + k * TAU` apart for any integer `k`, it's not obvious which way they lerp due to floating-point precision errors. For example, `lerp_angle(0, PI, weight)` lerps counter-clockwise, while `lerp_angle(0, PI + 5 * TAU, weight)` lerps clockwise.
|
|
237
|
+
*/
|
|
238
|
+
declare function lerp_angle(from_: float, to: float, weight: float): float;
|
|
239
|
+
/**
|
|
240
|
+
* Linearly interpolates between two values by the factor defined in `weight`. To perform interpolation, `weight` should be between `0.0` and `1.0` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use {@link clampf} on the result of this function.
|
|
241
|
+
* See also {@link inverse_lerp} which performs the reverse of this operation. To perform eased interpolation with {@link lerp}, combine it with {@link ease} or {@link smoothstep}.
|
|
242
|
+
*/
|
|
243
|
+
declare function lerpf(from_: float, to: float, weight: float): float;
|
|
244
|
+
/**
|
|
245
|
+
* Converts from linear energy to decibels (audio). Since volume is not normally linear, this can be used to implement volume sliders that behave as expected.
|
|
246
|
+
* **Example:** Change the Master bus's volume through a {@link Slider} node, which ranges from `0.0` to `1.0`:
|
|
247
|
+
*/
|
|
248
|
+
declare function linear_to_db(lin: float): float;
|
|
249
|
+
/**
|
|
250
|
+
* Returns the natural logarithm (https://en.wikipedia.org/wiki/Natural_logarithm) of `x` (base *e* (https://en.wikipedia.org/wiki/E_(mathematical_constant)), with *e* being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth.
|
|
251
|
+
* **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use `log(x) / log(10)`.
|
|
252
|
+
* **Note:** The logarithm of `0` returns `-inf`, while negative values return `-nan`.
|
|
253
|
+
*/
|
|
254
|
+
declare function log(x: float): float;
|
|
255
|
+
/**
|
|
256
|
+
* Returns the maximum of the given numeric values. This function can take any number of arguments.
|
|
257
|
+
* **Note:** When using this on vectors it will *not* perform component-wise maximum, and will pick the largest value when compared using `x < y`. To perform component-wise maximum, use {@link Vector2.max}, {@link Vector2i.max}, {@link Vector3.max}, {@link Vector3i.max}, {@link Vector4.max}, and {@link Vector4i.max}.
|
|
258
|
+
*/
|
|
259
|
+
declare function max<T extends int | float>(...args: T[]): T;
|
|
260
|
+
/** Returns the maximum of two [float] values. */
|
|
261
|
+
declare function maxf(a: float, b: float): float;
|
|
262
|
+
/** Returns the maximum of two [int] values. */
|
|
263
|
+
declare function maxi(a: int, b: int): int;
|
|
264
|
+
/**
|
|
265
|
+
* Returns the minimum of the given numeric values. This function can take any number of arguments.
|
|
266
|
+
* **Note:** When using this on vectors it will *not* perform component-wise minimum, and will pick the smallest value when compared using `x < y`. To perform component-wise minimum, use {@link Vector2.min}, {@link Vector2i.min}, {@link Vector3.min}, {@link Vector3i.min}, {@link Vector4.min}, and {@link Vector4i.min}.
|
|
267
|
+
*/
|
|
268
|
+
declare function min<T extends int | float>(...args: T[]): T;
|
|
269
|
+
/** Returns the minimum of two [float] values. */
|
|
270
|
+
declare function minf(a: float, b: float): float;
|
|
271
|
+
/** Returns the minimum of two [int] values. */
|
|
272
|
+
declare function mini(a: int, b: int): int;
|
|
273
|
+
/**
|
|
274
|
+
* Moves `from` toward `to` by the `delta` amount. Will not go past `to`.
|
|
275
|
+
* Use a negative `delta` value to move away.
|
|
276
|
+
*/
|
|
277
|
+
declare function move_toward(from_: float, to: float, delta: float): float;
|
|
278
|
+
/**
|
|
279
|
+
* Returns the smallest integer power of 2 that is greater than or equal to `value`.
|
|
280
|
+
* **Warning:** Due to its implementation, this method returns `0` rather than `1` for values less than or equal to `0`, with an exception for `value` being the smallest negative 64-bit integer (`-9223372036854775808`) in which case the `value` is returned unchanged.
|
|
281
|
+
*/
|
|
282
|
+
declare function nearest_po2(value: int): int;
|
|
283
|
+
/**
|
|
284
|
+
* Wraps `value` between `0` and the `length`. If the limit is reached, the next value the function returns is decreased to the `0` side or increased to the `length` side (like a triangle wave). If `length` is less than zero, it becomes positive.
|
|
285
|
+
*/
|
|
286
|
+
declare function pingpong(value: float, length: float): float;
|
|
287
|
+
/**
|
|
288
|
+
* Returns the integer modulus of `x` divided by `y` that wraps equally in positive and negative.
|
|
289
|
+
* Prints:
|
|
290
|
+
* [codeblock lang=text]
|
|
291
|
+
* (i) (i % 3) (posmod(i, 3))
|
|
292
|
+
* -3 0 | 0
|
|
293
|
+
* -2 -2 | 1
|
|
294
|
+
* -1 -1 | 2
|
|
295
|
+
* 0 0 | 0
|
|
296
|
+
* 1 1 | 1
|
|
297
|
+
* 2 2 | 2
|
|
298
|
+
* 3 0 | 0
|
|
299
|
+
* [/codeblock]
|
|
300
|
+
*/
|
|
301
|
+
declare function posmod(x: int, y: int): int;
|
|
302
|
+
/**
|
|
303
|
+
* Returns the result of `base` raised to the power of `exp`.
|
|
304
|
+
* In GDScript, this is the equivalent of the `**` operator.
|
|
305
|
+
*/
|
|
306
|
+
declare function pow(base: float, exp: float): float;
|
|
307
|
+
/**
|
|
308
|
+
* Converts one or more arguments of any type to string in the best way possible and prints them to the console.
|
|
309
|
+
* **Note:** Consider using {@link push_error} and {@link push_warning} to print error and warning messages instead of {@link print} or {@link print_rich}. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed. See also {@link Engine.print_to_stdout} and {@link ProjectSettings.application/run/disable_stdout}.
|
|
310
|
+
*/
|
|
311
|
+
declare function print(...args: any[]): void;
|
|
312
|
+
/**
|
|
313
|
+
* Converts one or more arguments of any type to string in the best way possible and prints them to the console.
|
|
314
|
+
* The following BBCode tags are supported: `b`, `i`, `u`, `s`, `indent`, `code`, `url`, `center`, `right`, `color`, `bgcolor`, `fgcolor`.
|
|
315
|
+
* URL tags only support URLs wrapped by a URL tag, not URLs with a different title.
|
|
316
|
+
* When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, `code` is represented with faint text but without any font change. Unsupported tags are left as-is in standard output.
|
|
317
|
+
* **Note:** Consider using {@link push_error} and {@link push_warning} to print error and warning messages instead of {@link print} or {@link print_rich}. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed.
|
|
318
|
+
* **Note:** Output displayed in the editor supports clickable [code skip-lint]text (address)[/code] tags. The [code skip-lint][url][/code] tag's `address` value is handled by {@link OS.shell_open} when clicked.
|
|
319
|
+
*/
|
|
320
|
+
declare function print_rich(...args: any[]): void;
|
|
321
|
+
/**
|
|
322
|
+
* If verbose mode is enabled ({@link OS.is_stdout_verbose} returning `true`), converts one or more arguments of any type to string in the best way possible and prints them to the console.
|
|
323
|
+
*/
|
|
324
|
+
declare function print_verbose(...args: any[]): void;
|
|
325
|
+
/** Prints one or more arguments to strings in the best way possible to standard error line. */
|
|
326
|
+
declare function printerr(...args: any[]): void;
|
|
327
|
+
/**
|
|
328
|
+
* Prints one or more arguments to strings in the best way possible to the OS terminal. Unlike {@link print}, no newline is automatically added at the end.
|
|
329
|
+
* **Note:** The OS terminal is *not* the same as the editor's Output dock. The output sent to the OS terminal can be seen when running Godot from a terminal. On Windows, this requires using the `console.exe` executable.
|
|
330
|
+
*/
|
|
331
|
+
declare function printraw(...args: any[]): void;
|
|
332
|
+
/** Prints one or more arguments to the console with a space between each argument. */
|
|
333
|
+
declare function prints(...args: any[]): void;
|
|
334
|
+
/** Prints one or more arguments to the console with a tab between each argument. */
|
|
335
|
+
declare function printt(...args: any[]): void;
|
|
336
|
+
/**
|
|
337
|
+
* Pushes an error message to Godot's built-in debugger and to the OS terminal.
|
|
338
|
+
* **Note:** This function does not pause project execution. To print an error message and pause project execution in debug builds, use `assert(false, "test error")` instead.
|
|
339
|
+
*/
|
|
340
|
+
declare function push_error(...args: any[]): void;
|
|
341
|
+
/** Pushes a warning message to Godot's built-in debugger and to the OS terminal. */
|
|
342
|
+
declare function push_warning(...args: any[]): void;
|
|
343
|
+
/** Converts an angle expressed in radians to degrees. */
|
|
344
|
+
declare function rad_to_deg(rad: float): float;
|
|
345
|
+
/**
|
|
346
|
+
* Given a `seed`, returns a {@link PackedInt64Array} of size `2`, where its first element is the randomized [int] value, and the second element is the same as `seed`. Passing the same `seed` consistently returns the same array.
|
|
347
|
+
* **Note:** "Seed" here refers to the internal state of the pseudo random number generator, currently implemented as a 64 bit integer.
|
|
348
|
+
*/
|
|
349
|
+
declare function rand_from_seed(seed: int): PackedInt64Array;
|
|
350
|
+
/** Returns a random floating-point value between `0.0` and `1.0` (inclusive). */
|
|
351
|
+
declare function randf(): float;
|
|
352
|
+
/** Returns a random floating-point value between `from` and `to` (inclusive). */
|
|
353
|
+
declare function randf_range(from_: float, to: float): float;
|
|
354
|
+
/**
|
|
355
|
+
* Returns a normally-distributed (https://en.wikipedia.org/wiki/Normal_distribution), pseudo-random floating-point value from the specified `mean` and a standard `deviation`. This is also known as a Gaussian distribution.
|
|
356
|
+
* **Note:** This method uses the Box-Muller transform (https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform) algorithm.
|
|
357
|
+
*/
|
|
358
|
+
declare function randfn(mean: float, deviation: float): float;
|
|
359
|
+
/**
|
|
360
|
+
* Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval `[0, N - 1]` (where N is smaller than 2^32).
|
|
361
|
+
*/
|
|
362
|
+
declare function randi(): int;
|
|
363
|
+
/**
|
|
364
|
+
* Returns a random signed 32-bit integer between `from` and `to` (inclusive). If `to` is lesser than `from`, they are swapped.
|
|
365
|
+
*/
|
|
366
|
+
declare function randi_range(from_: int, to: int): int;
|
|
367
|
+
/**
|
|
368
|
+
* Randomizes the seed (or the internal state) of the random number generator. The current implementation uses a number based on the device's time.
|
|
369
|
+
* **Note:** This function is called automatically when the project is run. If you need to fix the seed to have consistent, reproducible results, use {@link seed} to initialize the random number generator.
|
|
370
|
+
*/
|
|
371
|
+
declare function randomize(): void;
|
|
372
|
+
/**
|
|
373
|
+
* Maps a `value` from range `[istart, istop]` to `[ostart, ostop]`. See also {@link lerp} and {@link inverse_lerp}. If `value` is outside `[istart, istop]`, then the resulting value will also be outside `[ostart, ostop]`. If this is not desired, use {@link clamp} on the result of this function.
|
|
374
|
+
* For complex use cases where multiple ranges are needed, consider using {@link Curve} or {@link Gradient} instead.
|
|
375
|
+
* **Note:** If `istart == istop`, the return value is undefined (most likely NaN, INF, or -INF).
|
|
376
|
+
*/
|
|
377
|
+
declare function remap(value: float, istart: float, istop: float, ostart: float, ostop: float): float;
|
|
378
|
+
/**
|
|
379
|
+
* Allocates a unique ID which can be used by the implementation to construct an RID. This is used mainly from native extensions to implement servers.
|
|
380
|
+
*/
|
|
381
|
+
declare function rid_allocate_id(): int;
|
|
382
|
+
/** Creates an RID from a `base`. This is used mainly from native extensions to build servers. */
|
|
383
|
+
declare function rid_from_int64(base: int): RID;
|
|
384
|
+
/**
|
|
385
|
+
* Rotates `from` toward `to` by the `delta` amount. Will not go past `to`.
|
|
386
|
+
* Similar to {@link move_toward}, but interpolates correctly when the angles wrap around {@link @GDScript.TAU}.
|
|
387
|
+
* If `delta` is negative, this function will rotate away from `to`, toward the opposite angle, and will not go past the opposite angle.
|
|
388
|
+
*/
|
|
389
|
+
declare function rotate_toward(from_: float, to: float, delta: float): float;
|
|
390
|
+
/**
|
|
391
|
+
* Rounds `x` to the nearest whole number, with halfway cases rounded away from 0. Supported types: [int], [float], {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}.
|
|
392
|
+
* See also {@link floor}, {@link ceil}, and {@link snapped}.
|
|
393
|
+
* **Note:** For better type safety, use {@link roundf}, {@link roundi}, {@link Vector2.round}, {@link Vector3.round}, or {@link Vector4.round}.
|
|
394
|
+
*/
|
|
395
|
+
declare function round<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T): T;
|
|
396
|
+
/**
|
|
397
|
+
* Rounds `x` to the nearest whole number, with halfway cases rounded away from 0.
|
|
398
|
+
* A type-safe version of {@link round}, returning a [float].
|
|
399
|
+
*/
|
|
400
|
+
declare function roundf(x: float): float;
|
|
401
|
+
/**
|
|
402
|
+
* Rounds `x` to the nearest whole number, with halfway cases rounded away from 0.
|
|
403
|
+
* A type-safe version of {@link round}, returning an [int].
|
|
404
|
+
*/
|
|
405
|
+
declare function roundi(x: float): int;
|
|
406
|
+
/**
|
|
407
|
+
* Sets the seed for the random number generator to `base`. Setting the seed manually can ensure consistent, repeatable results for most random functions.
|
|
408
|
+
*/
|
|
409
|
+
declare function seed(base: int): void;
|
|
410
|
+
/**
|
|
411
|
+
* Returns the same type of {@link Variant} as `x`, with `-1` for negative values, `1` for positive values, and `0` for zeros. For `nan` values it returns 0.
|
|
412
|
+
* Supported types: [int], [float], {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}.
|
|
413
|
+
* **Note:** For better type safety, use {@link signf}, {@link signi}, {@link Vector2.sign}, {@link Vector2i.sign}, {@link Vector3.sign}, {@link Vector3i.sign}, {@link Vector4.sign}, or {@link Vector4i.sign}.
|
|
414
|
+
*/
|
|
415
|
+
declare function sign<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T): T;
|
|
416
|
+
/**
|
|
417
|
+
* Returns `-1.0` if `x` is negative, `1.0` if `x` is positive, and `0.0` if `x` is zero. For `nan` values of `x` it returns 0.0.
|
|
418
|
+
*/
|
|
419
|
+
declare function signf(x: float): float;
|
|
420
|
+
/** Returns `-1` if `x` is negative, `1` if `x` is positive, and `0` if `x` is zero. */
|
|
421
|
+
declare function signi(x: int): int;
|
|
422
|
+
/** Returns the sine of angle `angle_rad` in radians. */
|
|
423
|
+
declare function sin(angle_rad: float): float;
|
|
424
|
+
/** Returns the hyperbolic sine of `x`. */
|
|
425
|
+
declare function sinh(x: float): float;
|
|
426
|
+
/**
|
|
427
|
+
* Returns a smooth cubic Hermite interpolation between `0` and `1`.
|
|
428
|
+
* For positive ranges (when `from <= to`) the return value is `0` when `x <= from`, and `1` when `x >= to`. If `x` lies between `from` and `to`, the return value follows an S-shaped curve that smoothly transitions from `0` to `1`.
|
|
429
|
+
* For negative ranges (when `from > to`) the function is mirrored and returns `1` when `x <= to` and `0` when `x >= from`.
|
|
430
|
+
* This S-shaped curve is the cubic Hermite interpolator, given by `f(y) = 3*y^2 - 2*y^3` where `y = (x-from) / (to-from)`.
|
|
431
|
+
* Compared to {@link ease} with a curve value of `-1.6521`, {@link smoothstep} returns the smoothest possible curve with no sudden changes in the derivative. If you need to perform more advanced transitions, use {@link Tween} or {@link AnimationPlayer}.
|
|
432
|
+
* Comparison between smoothstep() and ease(x, -1.6521) return values (https://raw.githubusercontent.com/godotengine/godot-docs/master/img/smoothstep_ease_comparison.png)
|
|
433
|
+
* Smoothstep() return values with positive, zero, and negative ranges (https://raw.githubusercontent.com/godotengine/godot-docs/master/img/smoothstep_range.webp)
|
|
434
|
+
*/
|
|
435
|
+
declare function smoothstep(from_: float, to: float, x: float): float;
|
|
436
|
+
/**
|
|
437
|
+
* Returns the multiple of `step` that is the closest to `x`. This can also be used to round a floating-point number to an arbitrary number of decimals.
|
|
438
|
+
* The returned value is the same type of {@link Variant} as `step`. Supported types: [int], [float], {@link Vector2}, {@link Vector2i}, {@link Vector3}, {@link Vector3i}, {@link Vector4}, {@link Vector4i}.
|
|
439
|
+
* See also {@link ceil}, {@link floor}, and {@link round}.
|
|
440
|
+
* **Note:** For better type safety, use {@link snappedf}, {@link snappedi}, {@link Vector2.snapped}, {@link Vector2i.snapped}, {@link Vector3.snapped}, {@link Vector3i.snapped}, {@link Vector4.snapped}, or {@link Vector4i.snapped}.
|
|
441
|
+
*/
|
|
442
|
+
declare function snapped<T extends int | float | Vector2 | Vector2i | Vector3 | Vector3i | Vector4 | Vector4i>(x: T, step: T): T;
|
|
443
|
+
/**
|
|
444
|
+
* Returns the multiple of `step` that is the closest to `x`. This can also be used to round a floating-point number to an arbitrary number of decimals.
|
|
445
|
+
* A type-safe version of {@link snapped}, returning a [float].
|
|
446
|
+
*/
|
|
447
|
+
declare function snappedf(x: float, step: float): float;
|
|
448
|
+
/**
|
|
449
|
+
* Returns the multiple of `step` that is the closest to `x`.
|
|
450
|
+
* A type-safe version of {@link snapped}, returning an [int].
|
|
451
|
+
*/
|
|
452
|
+
declare function snappedi(x: float, step: int): int;
|
|
453
|
+
/**
|
|
454
|
+
* Returns the square root of `x`, where `x` is a non-negative number.
|
|
455
|
+
* **Note:** Negative values of `x` return NaN ("Not a Number"). In C#, if you need negative inputs, use `System.Numerics.Complex`.
|
|
456
|
+
*/
|
|
457
|
+
declare function sqrt(x: float): float;
|
|
458
|
+
/**
|
|
459
|
+
* Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation.
|
|
460
|
+
*/
|
|
461
|
+
declare function step_decimals(x: float): int;
|
|
462
|
+
/**
|
|
463
|
+
* Converts one or more arguments of any {@link Variant} type to a {@link String} in the best way possible.
|
|
464
|
+
*/
|
|
465
|
+
declare function str(...args: any[]): string;
|
|
466
|
+
/**
|
|
467
|
+
* Converts a formatted `string` that was returned by {@link var_to_str} to the original {@link Variant}.
|
|
468
|
+
*/
|
|
469
|
+
declare function str_to_var(string: string): unknown;
|
|
470
|
+
/** Returns the tangent of angle `angle_rad` in radians. */
|
|
471
|
+
declare function tan(angle_rad: float): float;
|
|
472
|
+
/** Returns the hyperbolic tangent of `x`. */
|
|
473
|
+
declare function tanh(x: float): float;
|
|
474
|
+
/**
|
|
475
|
+
* Converts the given `variant` to the given `type`, using the {@link Variant.Type} values. This method is generous with how it handles types, it can automatically convert between array types, convert numeric {@link String}s to [int], and converting most things to {@link String}.
|
|
476
|
+
* If the type conversion cannot be done, this method will return the default value for that type, for example converting {@link Rect2} to {@link Vector2} will always return {@link Vector2.ZERO}. This method will never show error messages as long as `type` is a valid Variant type.
|
|
477
|
+
* The returned value is a {@link Variant}, but the data inside and its type will be the same as the requested type.
|
|
478
|
+
*/
|
|
479
|
+
declare function type_convert(variant: unknown, type_: int): unknown;
|
|
480
|
+
/**
|
|
481
|
+
* Returns a human-readable name of the given `type`, using the {@link Variant.Type} values.
|
|
482
|
+
* See also {@link typeof}.
|
|
483
|
+
*/
|
|
484
|
+
declare function type_string(type_: int): string;
|
|
485
|
+
/**
|
|
486
|
+
* Returns the internal type of the given `variable`, using the {@link Variant.Type} values.
|
|
487
|
+
* See also {@link type_string}.
|
|
488
|
+
*/
|
|
489
|
+
declare function typeof_(variable: unknown): int;
|
|
490
|
+
/**
|
|
491
|
+
* Encodes a {@link Variant} value to a byte array, without encoding objects. Deserialization can be done with {@link bytes_to_var}.
|
|
492
|
+
* **Note:** If you need object serialization, see {@link var_to_bytes_with_objects}.
|
|
493
|
+
* **Note:** Encoding {@link Callable} is not supported and will result in an empty value, regardless of the data.
|
|
494
|
+
*/
|
|
495
|
+
declare function var_to_bytes(variable: unknown): PackedByteArray;
|
|
496
|
+
/**
|
|
497
|
+
* Encodes a {@link Variant} value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with {@link bytes_to_var_with_objects}.
|
|
498
|
+
* **Note:** Encoding {@link Callable} is not supported and will result in an empty value, regardless of the data.
|
|
499
|
+
*/
|
|
500
|
+
declare function var_to_bytes_with_objects(variable: unknown): PackedByteArray;
|
|
501
|
+
/**
|
|
502
|
+
* Converts a {@link Variant} `variable` to a formatted {@link String} that can then be parsed using {@link str_to_var}.
|
|
503
|
+
* Prints:
|
|
504
|
+
* [codeblock lang=text]
|
|
505
|
+
* {
|
|
506
|
+
* "a": 1,
|
|
507
|
+
* "b": 2
|
|
508
|
+
* }
|
|
509
|
+
* [/codeblock]
|
|
510
|
+
* **Note:** Converting {@link Signal} or {@link Callable} is not supported and will result in an empty value for these types, regardless of their data.
|
|
511
|
+
*/
|
|
512
|
+
declare function var_to_str(variable: unknown): string;
|
|
513
|
+
/**
|
|
514
|
+
* Returns a {@link WeakRef} instance holding a weak reference to `obj`. Returns an empty {@link WeakRef} instance if `obj` is `null`. Prints an error and returns `null` if `obj` is neither {@link Object}-derived nor `null`.
|
|
515
|
+
* A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it.
|
|
516
|
+
*/
|
|
517
|
+
declare function weakref(obj: GodotObject): WeakRef;
|
|
518
|
+
/**
|
|
519
|
+
* Wraps the {@link Variant} `value` between `min` and `max`. `min` is *inclusive* while `max` is *exclusive*. This can be used for creating loop-like behavior or infinite surfaces.
|
|
520
|
+
* Variant types [int] and [float] are supported. If any of the arguments is [float], this function returns a [float], otherwise it returns an [int].
|
|
521
|
+
*/
|
|
522
|
+
declare function wrap<T extends int | float>(value: T, min: T, max: T): T;
|
|
523
|
+
/**
|
|
524
|
+
* Wraps the float `value` between `min` and `max`. `min` is *inclusive* while `max` is *exclusive*. This can be used for creating loop-like behavior or infinite surfaces.
|
|
525
|
+
* **Note:** If `min` is `0`, this is equivalent to {@link fposmod}, so prefer using that instead. {@link wrapf} is more flexible than using the {@link fposmod} approach by giving the user control over the minimum value.
|
|
526
|
+
*/
|
|
527
|
+
declare function wrapf(value: float, min: float, max: float): float;
|
|
528
|
+
/**
|
|
529
|
+
* Wraps the integer `value` between `min` and `max`. `min` is *inclusive* while `max` is *exclusive*. This can be used for creating loop-like behavior or infinite surfaces.
|
|
530
|
+
*/
|
|
531
|
+
declare function wrapi(value: int, min: int, max: int): int;
|
|
532
|
+
|
|
533
|
+
declare const enum Side {
|
|
534
|
+
/** Left side, usually used for {@link Control} or {@link StyleBox}-derived classes. */
|
|
535
|
+
SIDE_LEFT = 0,
|
|
536
|
+
/** Top side, usually used for {@link Control} or {@link StyleBox}-derived classes. */
|
|
537
|
+
SIDE_TOP = 1,
|
|
538
|
+
/** Right side, usually used for {@link Control} or {@link StyleBox}-derived classes. */
|
|
539
|
+
SIDE_RIGHT = 2,
|
|
540
|
+
/** Bottom side, usually used for {@link Control} or {@link StyleBox}-derived classes. */
|
|
541
|
+
SIDE_BOTTOM = 3,
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
declare const enum Corner {
|
|
545
|
+
/** Top-left corner. */
|
|
546
|
+
CORNER_TOP_LEFT = 0,
|
|
547
|
+
/** Top-right corner. */
|
|
548
|
+
CORNER_TOP_RIGHT = 1,
|
|
549
|
+
/** Bottom-right corner. */
|
|
550
|
+
CORNER_BOTTOM_RIGHT = 2,
|
|
551
|
+
/** Bottom-left corner. */
|
|
552
|
+
CORNER_BOTTOM_LEFT = 3,
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
declare const enum Orientation {
|
|
556
|
+
/**
|
|
557
|
+
* General vertical alignment, usually used for {@link Separator}, {@link ScrollBar}, {@link Slider}, etc.
|
|
558
|
+
*/
|
|
559
|
+
VERTICAL = 1,
|
|
560
|
+
/**
|
|
561
|
+
* General horizontal alignment, usually used for {@link Separator}, {@link ScrollBar}, {@link Slider}, etc.
|
|
562
|
+
*/
|
|
563
|
+
HORIZONTAL = 0,
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
declare const enum ClockDirection {
|
|
567
|
+
/** Clockwise rotation. Used by some methods (e.g. {@link Image.rotate_90}). */
|
|
568
|
+
CLOCKWISE = 0,
|
|
569
|
+
/** Counter-clockwise rotation. Used by some methods (e.g. {@link Image.rotate_90}). */
|
|
570
|
+
COUNTERCLOCKWISE = 1,
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
declare const enum HorizontalAlignment {
|
|
574
|
+
/** Horizontal left alignment, usually for text-derived classes. */
|
|
575
|
+
HORIZONTAL_ALIGNMENT_LEFT = 0,
|
|
576
|
+
/** Horizontal center alignment, usually for text-derived classes. */
|
|
577
|
+
HORIZONTAL_ALIGNMENT_CENTER = 1,
|
|
578
|
+
/** Horizontal right alignment, usually for text-derived classes. */
|
|
579
|
+
HORIZONTAL_ALIGNMENT_RIGHT = 2,
|
|
580
|
+
/** Expand row to fit width, usually for text-derived classes. */
|
|
581
|
+
HORIZONTAL_ALIGNMENT_FILL = 3,
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
declare const enum VerticalAlignment {
|
|
585
|
+
/** Vertical top alignment, usually for text-derived classes. */
|
|
586
|
+
VERTICAL_ALIGNMENT_TOP = 0,
|
|
587
|
+
/** Vertical center alignment, usually for text-derived classes. */
|
|
588
|
+
VERTICAL_ALIGNMENT_CENTER = 1,
|
|
589
|
+
/** Vertical bottom alignment, usually for text-derived classes. */
|
|
590
|
+
VERTICAL_ALIGNMENT_BOTTOM = 2,
|
|
591
|
+
/** Expand rows to fit height, usually for text-derived classes. */
|
|
592
|
+
VERTICAL_ALIGNMENT_FILL = 3,
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
declare const enum InlineAlignment {
|
|
596
|
+
/**
|
|
597
|
+
* Aligns the top of the inline object (e.g. image, table) to the position of the text specified by `INLINE_ALIGNMENT_TO_*` constant.
|
|
598
|
+
*/
|
|
599
|
+
INLINE_ALIGNMENT_TOP_TO = 0,
|
|
600
|
+
/**
|
|
601
|
+
* Aligns the center of the inline object (e.g. image, table) to the position of the text specified by `INLINE_ALIGNMENT_TO_*` constant.
|
|
602
|
+
*/
|
|
603
|
+
INLINE_ALIGNMENT_CENTER_TO = 1,
|
|
604
|
+
/**
|
|
605
|
+
* Aligns the baseline (user defined) of the inline object (e.g. image, table) to the position of the text specified by `INLINE_ALIGNMENT_TO_*` constant.
|
|
606
|
+
*/
|
|
607
|
+
INLINE_ALIGNMENT_BASELINE_TO = 3,
|
|
608
|
+
/**
|
|
609
|
+
* Aligns the bottom of the inline object (e.g. image, table) to the position of the text specified by `INLINE_ALIGNMENT_TO_*` constant.
|
|
610
|
+
*/
|
|
611
|
+
INLINE_ALIGNMENT_BOTTOM_TO = 2,
|
|
612
|
+
/**
|
|
613
|
+
* Aligns the position of the inline object (e.g. image, table) specified by `INLINE_ALIGNMENT_*_TO` constant to the top of the text.
|
|
614
|
+
*/
|
|
615
|
+
INLINE_ALIGNMENT_TO_TOP = 0,
|
|
616
|
+
/**
|
|
617
|
+
* Aligns the position of the inline object (e.g. image, table) specified by `INLINE_ALIGNMENT_*_TO` constant to the center of the text.
|
|
618
|
+
*/
|
|
619
|
+
INLINE_ALIGNMENT_TO_CENTER = 4,
|
|
620
|
+
/**
|
|
621
|
+
* Aligns the position of the inline object (e.g. image, table) specified by `INLINE_ALIGNMENT_*_TO` constant to the baseline of the text.
|
|
622
|
+
*/
|
|
623
|
+
INLINE_ALIGNMENT_TO_BASELINE = 8,
|
|
624
|
+
/** Aligns inline object (e.g. image, table) to the bottom of the text. */
|
|
625
|
+
INLINE_ALIGNMENT_TO_BOTTOM = 12,
|
|
626
|
+
/**
|
|
627
|
+
* Aligns top of the inline object (e.g. image, table) to the top of the text. Equivalent to `INLINE_ALIGNMENT_TOP_TO | INLINE_ALIGNMENT_TO_TOP`.
|
|
628
|
+
*/
|
|
629
|
+
INLINE_ALIGNMENT_TOP = 0,
|
|
630
|
+
/**
|
|
631
|
+
* Aligns center of the inline object (e.g. image, table) to the center of the text. Equivalent to `INLINE_ALIGNMENT_CENTER_TO | INLINE_ALIGNMENT_TO_CENTER`.
|
|
632
|
+
*/
|
|
633
|
+
INLINE_ALIGNMENT_CENTER = 5,
|
|
634
|
+
/**
|
|
635
|
+
* Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equivalent to `INLINE_ALIGNMENT_BOTTOM_TO | INLINE_ALIGNMENT_TO_BOTTOM`.
|
|
636
|
+
*/
|
|
637
|
+
INLINE_ALIGNMENT_BOTTOM = 14,
|
|
638
|
+
/** A bit mask for `INLINE_ALIGNMENT_*_TO` alignment constants. */
|
|
639
|
+
INLINE_ALIGNMENT_IMAGE_MASK = 3,
|
|
640
|
+
/** A bit mask for `INLINE_ALIGNMENT_TO_*` alignment constants. */
|
|
641
|
+
INLINE_ALIGNMENT_TEXT_MASK = 12,
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
declare const enum EulerOrder {
|
|
645
|
+
/**
|
|
646
|
+
* Specifies that Euler angles should be in XYZ order. When composing, the order is X, Y, Z. When decomposing, the order is reversed, first Z, then Y, and X last.
|
|
647
|
+
*/
|
|
648
|
+
EULER_ORDER_XYZ = 0,
|
|
649
|
+
/**
|
|
650
|
+
* Specifies that Euler angles should be in XZY order. When composing, the order is X, Z, Y. When decomposing, the order is reversed, first Y, then Z, and X last.
|
|
651
|
+
*/
|
|
652
|
+
EULER_ORDER_XZY = 1,
|
|
653
|
+
/**
|
|
654
|
+
* Specifies that Euler angles should be in YXZ order. When composing, the order is Y, X, Z. When decomposing, the order is reversed, first Z, then X, and Y last.
|
|
655
|
+
*/
|
|
656
|
+
EULER_ORDER_YXZ = 2,
|
|
657
|
+
/**
|
|
658
|
+
* Specifies that Euler angles should be in YZX order. When composing, the order is Y, Z, X. When decomposing, the order is reversed, first X, then Z, and Y last.
|
|
659
|
+
*/
|
|
660
|
+
EULER_ORDER_YZX = 3,
|
|
661
|
+
/**
|
|
662
|
+
* Specifies that Euler angles should be in ZXY order. When composing, the order is Z, X, Y. When decomposing, the order is reversed, first Y, then X, and Z last.
|
|
663
|
+
*/
|
|
664
|
+
EULER_ORDER_ZXY = 4,
|
|
665
|
+
/**
|
|
666
|
+
* Specifies that Euler angles should be in ZYX order. When composing, the order is Z, Y, X. When decomposing, the order is reversed, first X, then Y, and Z last.
|
|
667
|
+
*/
|
|
668
|
+
EULER_ORDER_ZYX = 5,
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
declare const enum Key {
|
|
672
|
+
/**
|
|
673
|
+
* Enum value which doesn't correspond to any key. This is used to initialize {@link Key} properties with a generic state.
|
|
674
|
+
*/
|
|
675
|
+
KEY_NONE = 0,
|
|
676
|
+
/** Keycodes with this bit applied are non-printable. */
|
|
677
|
+
KEY_SPECIAL = 4194304,
|
|
678
|
+
/** Escape key. */
|
|
679
|
+
KEY_ESCAPE = 4194305,
|
|
680
|
+
/** Tab key. */
|
|
681
|
+
KEY_TAB = 4194306,
|
|
682
|
+
/** Shift + Tab key. */
|
|
683
|
+
KEY_BACKTAB = 4194307,
|
|
684
|
+
/** Backspace key. */
|
|
685
|
+
KEY_BACKSPACE = 4194308,
|
|
686
|
+
/** Return key (on the main keyboard). */
|
|
687
|
+
KEY_ENTER = 4194309,
|
|
688
|
+
/** Enter key on the numeric keypad. */
|
|
689
|
+
KEY_KP_ENTER = 4194310,
|
|
690
|
+
/** Insert key. */
|
|
691
|
+
KEY_INSERT = 4194311,
|
|
692
|
+
/** Delete key. */
|
|
693
|
+
KEY_DELETE = 4194312,
|
|
694
|
+
/** Pause key. */
|
|
695
|
+
KEY_PAUSE = 4194313,
|
|
696
|
+
/** Print Screen key. */
|
|
697
|
+
KEY_PRINT = 4194314,
|
|
698
|
+
/** System Request key. */
|
|
699
|
+
KEY_SYSREQ = 4194315,
|
|
700
|
+
/** Clear key. */
|
|
701
|
+
KEY_CLEAR = 4194316,
|
|
702
|
+
/** Home key. */
|
|
703
|
+
KEY_HOME = 4194317,
|
|
704
|
+
/** End key. */
|
|
705
|
+
KEY_END = 4194318,
|
|
706
|
+
/** Left arrow key. */
|
|
707
|
+
KEY_LEFT = 4194319,
|
|
708
|
+
/** Up arrow key. */
|
|
709
|
+
KEY_UP = 4194320,
|
|
710
|
+
/** Right arrow key. */
|
|
711
|
+
KEY_RIGHT = 4194321,
|
|
712
|
+
/** Down arrow key. */
|
|
713
|
+
KEY_DOWN = 4194322,
|
|
714
|
+
/** Page Up key. */
|
|
715
|
+
KEY_PAGEUP = 4194323,
|
|
716
|
+
/** Page Down key. */
|
|
717
|
+
KEY_PAGEDOWN = 4194324,
|
|
718
|
+
/** Shift key. */
|
|
719
|
+
KEY_SHIFT = 4194325,
|
|
720
|
+
/** Control key. */
|
|
721
|
+
KEY_CTRL = 4194326,
|
|
722
|
+
/** Meta key. */
|
|
723
|
+
KEY_META = 4194327,
|
|
724
|
+
/** Alt key. */
|
|
725
|
+
KEY_ALT = 4194328,
|
|
726
|
+
/** Caps Lock key. */
|
|
727
|
+
KEY_CAPSLOCK = 4194329,
|
|
728
|
+
/** Num Lock key. */
|
|
729
|
+
KEY_NUMLOCK = 4194330,
|
|
730
|
+
/** Scroll Lock key. */
|
|
731
|
+
KEY_SCROLLLOCK = 4194331,
|
|
732
|
+
/** F1 key. */
|
|
733
|
+
KEY_F1 = 4194332,
|
|
734
|
+
/** F2 key. */
|
|
735
|
+
KEY_F2 = 4194333,
|
|
736
|
+
/** F3 key. */
|
|
737
|
+
KEY_F3 = 4194334,
|
|
738
|
+
/** F4 key. */
|
|
739
|
+
KEY_F4 = 4194335,
|
|
740
|
+
/** F5 key. */
|
|
741
|
+
KEY_F5 = 4194336,
|
|
742
|
+
/** F6 key. */
|
|
743
|
+
KEY_F6 = 4194337,
|
|
744
|
+
/** F7 key. */
|
|
745
|
+
KEY_F7 = 4194338,
|
|
746
|
+
/** F8 key. */
|
|
747
|
+
KEY_F8 = 4194339,
|
|
748
|
+
/** F9 key. */
|
|
749
|
+
KEY_F9 = 4194340,
|
|
750
|
+
/** F10 key. */
|
|
751
|
+
KEY_F10 = 4194341,
|
|
752
|
+
/** F11 key. */
|
|
753
|
+
KEY_F11 = 4194342,
|
|
754
|
+
/** F12 key. */
|
|
755
|
+
KEY_F12 = 4194343,
|
|
756
|
+
/** F13 key. */
|
|
757
|
+
KEY_F13 = 4194344,
|
|
758
|
+
/** F14 key. */
|
|
759
|
+
KEY_F14 = 4194345,
|
|
760
|
+
/** F15 key. */
|
|
761
|
+
KEY_F15 = 4194346,
|
|
762
|
+
/** F16 key. */
|
|
763
|
+
KEY_F16 = 4194347,
|
|
764
|
+
/** F17 key. */
|
|
765
|
+
KEY_F17 = 4194348,
|
|
766
|
+
/** F18 key. */
|
|
767
|
+
KEY_F18 = 4194349,
|
|
768
|
+
/** F19 key. */
|
|
769
|
+
KEY_F19 = 4194350,
|
|
770
|
+
/** F20 key. */
|
|
771
|
+
KEY_F20 = 4194351,
|
|
772
|
+
/** F21 key. */
|
|
773
|
+
KEY_F21 = 4194352,
|
|
774
|
+
/** F22 key. */
|
|
775
|
+
KEY_F22 = 4194353,
|
|
776
|
+
/** F23 key. */
|
|
777
|
+
KEY_F23 = 4194354,
|
|
778
|
+
/** F24 key. */
|
|
779
|
+
KEY_F24 = 4194355,
|
|
780
|
+
/** F25 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
781
|
+
KEY_F25 = 4194356,
|
|
782
|
+
/** F26 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
783
|
+
KEY_F26 = 4194357,
|
|
784
|
+
/** F27 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
785
|
+
KEY_F27 = 4194358,
|
|
786
|
+
/** F28 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
787
|
+
KEY_F28 = 4194359,
|
|
788
|
+
/** F29 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
789
|
+
KEY_F29 = 4194360,
|
|
790
|
+
/** F30 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
791
|
+
KEY_F30 = 4194361,
|
|
792
|
+
/** F31 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
793
|
+
KEY_F31 = 4194362,
|
|
794
|
+
/** F32 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
795
|
+
KEY_F32 = 4194363,
|
|
796
|
+
/** F33 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
797
|
+
KEY_F33 = 4194364,
|
|
798
|
+
/** F34 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
799
|
+
KEY_F34 = 4194365,
|
|
800
|
+
/** F35 key. Only supported on macOS and Linux due to a Windows limitation. */
|
|
801
|
+
KEY_F35 = 4194366,
|
|
802
|
+
/** Multiply (*) key on the numeric keypad. */
|
|
803
|
+
KEY_KP_MULTIPLY = 4194433,
|
|
804
|
+
/** Divide (/) key on the numeric keypad. */
|
|
805
|
+
KEY_KP_DIVIDE = 4194434,
|
|
806
|
+
/** Subtract (-) key on the numeric keypad. */
|
|
807
|
+
KEY_KP_SUBTRACT = 4194435,
|
|
808
|
+
/** Period (.) key on the numeric keypad. */
|
|
809
|
+
KEY_KP_PERIOD = 4194436,
|
|
810
|
+
/** Add (+) key on the numeric keypad. */
|
|
811
|
+
KEY_KP_ADD = 4194437,
|
|
812
|
+
/** Number 0 on the numeric keypad. */
|
|
813
|
+
KEY_KP_0 = 4194438,
|
|
814
|
+
/** Number 1 on the numeric keypad. */
|
|
815
|
+
KEY_KP_1 = 4194439,
|
|
816
|
+
/** Number 2 on the numeric keypad. */
|
|
817
|
+
KEY_KP_2 = 4194440,
|
|
818
|
+
/** Number 3 on the numeric keypad. */
|
|
819
|
+
KEY_KP_3 = 4194441,
|
|
820
|
+
/** Number 4 on the numeric keypad. */
|
|
821
|
+
KEY_KP_4 = 4194442,
|
|
822
|
+
/** Number 5 on the numeric keypad. */
|
|
823
|
+
KEY_KP_5 = 4194443,
|
|
824
|
+
/** Number 6 on the numeric keypad. */
|
|
825
|
+
KEY_KP_6 = 4194444,
|
|
826
|
+
/** Number 7 on the numeric keypad. */
|
|
827
|
+
KEY_KP_7 = 4194445,
|
|
828
|
+
/** Number 8 on the numeric keypad. */
|
|
829
|
+
KEY_KP_8 = 4194446,
|
|
830
|
+
/** Number 9 on the numeric keypad. */
|
|
831
|
+
KEY_KP_9 = 4194447,
|
|
832
|
+
/** Context menu key. */
|
|
833
|
+
KEY_MENU = 4194370,
|
|
834
|
+
/** Hyper key. (On Linux/X11 only). */
|
|
835
|
+
KEY_HYPER = 4194371,
|
|
836
|
+
/** Help key. */
|
|
837
|
+
KEY_HELP = 4194373,
|
|
838
|
+
/** Back key. */
|
|
839
|
+
KEY_BACK = 4194376,
|
|
840
|
+
/** Forward key. */
|
|
841
|
+
KEY_FORWARD = 4194377,
|
|
842
|
+
/** Media stop key. */
|
|
843
|
+
KEY_STOP = 4194378,
|
|
844
|
+
/** Refresh key. */
|
|
845
|
+
KEY_REFRESH = 4194379,
|
|
846
|
+
/** Volume down key. */
|
|
847
|
+
KEY_VOLUMEDOWN = 4194380,
|
|
848
|
+
/** Mute volume key. */
|
|
849
|
+
KEY_VOLUMEMUTE = 4194381,
|
|
850
|
+
/** Volume up key. */
|
|
851
|
+
KEY_VOLUMEUP = 4194382,
|
|
852
|
+
/** Media play key. */
|
|
853
|
+
KEY_MEDIAPLAY = 4194388,
|
|
854
|
+
/** Media stop key. */
|
|
855
|
+
KEY_MEDIASTOP = 4194389,
|
|
856
|
+
/** Previous song key. */
|
|
857
|
+
KEY_MEDIAPREVIOUS = 4194390,
|
|
858
|
+
/** Next song key. */
|
|
859
|
+
KEY_MEDIANEXT = 4194391,
|
|
860
|
+
/** Media record key. */
|
|
861
|
+
KEY_MEDIARECORD = 4194392,
|
|
862
|
+
/** Home page key. */
|
|
863
|
+
KEY_HOMEPAGE = 4194393,
|
|
864
|
+
/** Favorites key. */
|
|
865
|
+
KEY_FAVORITES = 4194394,
|
|
866
|
+
/** Search key. */
|
|
867
|
+
KEY_SEARCH = 4194395,
|
|
868
|
+
/** Standby key. */
|
|
869
|
+
KEY_STANDBY = 4194396,
|
|
870
|
+
/** Open URL / Launch Browser key. */
|
|
871
|
+
KEY_OPENURL = 4194397,
|
|
872
|
+
/** Launch Mail key. */
|
|
873
|
+
KEY_LAUNCHMAIL = 4194398,
|
|
874
|
+
/** Launch Media key. */
|
|
875
|
+
KEY_LAUNCHMEDIA = 4194399,
|
|
876
|
+
/** Launch Shortcut 0 key. */
|
|
877
|
+
KEY_LAUNCH0 = 4194400,
|
|
878
|
+
/** Launch Shortcut 1 key. */
|
|
879
|
+
KEY_LAUNCH1 = 4194401,
|
|
880
|
+
/** Launch Shortcut 2 key. */
|
|
881
|
+
KEY_LAUNCH2 = 4194402,
|
|
882
|
+
/** Launch Shortcut 3 key. */
|
|
883
|
+
KEY_LAUNCH3 = 4194403,
|
|
884
|
+
/** Launch Shortcut 4 key. */
|
|
885
|
+
KEY_LAUNCH4 = 4194404,
|
|
886
|
+
/** Launch Shortcut 5 key. */
|
|
887
|
+
KEY_LAUNCH5 = 4194405,
|
|
888
|
+
/** Launch Shortcut 6 key. */
|
|
889
|
+
KEY_LAUNCH6 = 4194406,
|
|
890
|
+
/** Launch Shortcut 7 key. */
|
|
891
|
+
KEY_LAUNCH7 = 4194407,
|
|
892
|
+
/** Launch Shortcut 8 key. */
|
|
893
|
+
KEY_LAUNCH8 = 4194408,
|
|
894
|
+
/** Launch Shortcut 9 key. */
|
|
895
|
+
KEY_LAUNCH9 = 4194409,
|
|
896
|
+
/** Launch Shortcut A key. */
|
|
897
|
+
KEY_LAUNCHA = 4194410,
|
|
898
|
+
/** Launch Shortcut B key. */
|
|
899
|
+
KEY_LAUNCHB = 4194411,
|
|
900
|
+
/** Launch Shortcut C key. */
|
|
901
|
+
KEY_LAUNCHC = 4194412,
|
|
902
|
+
/** Launch Shortcut D key. */
|
|
903
|
+
KEY_LAUNCHD = 4194413,
|
|
904
|
+
/** Launch Shortcut E key. */
|
|
905
|
+
KEY_LAUNCHE = 4194414,
|
|
906
|
+
/** Launch Shortcut F key. */
|
|
907
|
+
KEY_LAUNCHF = 4194415,
|
|
908
|
+
/** "Globe" key on Mac / iPad keyboard. */
|
|
909
|
+
KEY_GLOBE = 4194416,
|
|
910
|
+
/** "On-screen keyboard" key on iPad keyboard. */
|
|
911
|
+
KEY_KEYBOARD = 4194417,
|
|
912
|
+
/** 英数 key on Mac keyboard. */
|
|
913
|
+
KEY_JIS_EISU = 4194418,
|
|
914
|
+
/** かな key on Mac keyboard. */
|
|
915
|
+
KEY_JIS_KANA = 4194419,
|
|
916
|
+
/** Unknown key. */
|
|
917
|
+
KEY_UNKNOWN = 8388607,
|
|
918
|
+
/** Space key. */
|
|
919
|
+
KEY_SPACE = 32,
|
|
920
|
+
/** Exclamation mark (`!`) key. */
|
|
921
|
+
KEY_EXCLAM = 33,
|
|
922
|
+
/** Double quotation mark (`"`) key. */
|
|
923
|
+
KEY_QUOTEDBL = 34,
|
|
924
|
+
/** Number sign or *hash* (`#`) key. */
|
|
925
|
+
KEY_NUMBERSIGN = 35,
|
|
926
|
+
/** Dollar sign (`$`) key. */
|
|
927
|
+
KEY_DOLLAR = 36,
|
|
928
|
+
/** Percent sign (`%`) key. */
|
|
929
|
+
KEY_PERCENT = 37,
|
|
930
|
+
/** Ampersand (`&`) key. */
|
|
931
|
+
KEY_AMPERSAND = 38,
|
|
932
|
+
/** Apostrophe (`'`) key. */
|
|
933
|
+
KEY_APOSTROPHE = 39,
|
|
934
|
+
/** Left parenthesis (`(`) key. */
|
|
935
|
+
KEY_PARENLEFT = 40,
|
|
936
|
+
/** Right parenthesis (`)`) key. */
|
|
937
|
+
KEY_PARENRIGHT = 41,
|
|
938
|
+
/** Asterisk (`*`) key. */
|
|
939
|
+
KEY_ASTERISK = 42,
|
|
940
|
+
/** Plus (`+`) key. */
|
|
941
|
+
KEY_PLUS = 43,
|
|
942
|
+
/** Comma (`,`) key. */
|
|
943
|
+
KEY_COMMA = 44,
|
|
944
|
+
/** Minus (`-`) key. */
|
|
945
|
+
KEY_MINUS = 45,
|
|
946
|
+
/** Period (`.`) key. */
|
|
947
|
+
KEY_PERIOD = 46,
|
|
948
|
+
/** Slash (`/`) key. */
|
|
949
|
+
KEY_SLASH = 47,
|
|
950
|
+
/** Number 0 key. */
|
|
951
|
+
KEY_0 = 48,
|
|
952
|
+
/** Number 1 key. */
|
|
953
|
+
KEY_1 = 49,
|
|
954
|
+
/** Number 2 key. */
|
|
955
|
+
KEY_2 = 50,
|
|
956
|
+
/** Number 3 key. */
|
|
957
|
+
KEY_3 = 51,
|
|
958
|
+
/** Number 4 key. */
|
|
959
|
+
KEY_4 = 52,
|
|
960
|
+
/** Number 5 key. */
|
|
961
|
+
KEY_5 = 53,
|
|
962
|
+
/** Number 6 key. */
|
|
963
|
+
KEY_6 = 54,
|
|
964
|
+
/** Number 7 key. */
|
|
965
|
+
KEY_7 = 55,
|
|
966
|
+
/** Number 8 key. */
|
|
967
|
+
KEY_8 = 56,
|
|
968
|
+
/** Number 9 key. */
|
|
969
|
+
KEY_9 = 57,
|
|
970
|
+
/** Colon (`:`) key. */
|
|
971
|
+
KEY_COLON = 58,
|
|
972
|
+
/** Semicolon (`;`) key. */
|
|
973
|
+
KEY_SEMICOLON = 59,
|
|
974
|
+
/** Less-than sign (`<`) key. */
|
|
975
|
+
KEY_LESS = 60,
|
|
976
|
+
/** Equal sign (`=`) key. */
|
|
977
|
+
KEY_EQUAL = 61,
|
|
978
|
+
/** Greater-than sign (`>`) key. */
|
|
979
|
+
KEY_GREATER = 62,
|
|
980
|
+
/** Question mark (`?`) key. */
|
|
981
|
+
KEY_QUESTION = 63,
|
|
982
|
+
/** At sign (`@`) key. */
|
|
983
|
+
KEY_AT = 64,
|
|
984
|
+
/** A key. */
|
|
985
|
+
KEY_A = 65,
|
|
986
|
+
/** B key. */
|
|
987
|
+
KEY_B = 66,
|
|
988
|
+
/** C key. */
|
|
989
|
+
KEY_C = 67,
|
|
990
|
+
/** D key. */
|
|
991
|
+
KEY_D = 68,
|
|
992
|
+
/** E key. */
|
|
993
|
+
KEY_E = 69,
|
|
994
|
+
/** F key. */
|
|
995
|
+
KEY_F = 70,
|
|
996
|
+
/** G key. */
|
|
997
|
+
KEY_G = 71,
|
|
998
|
+
/** H key. */
|
|
999
|
+
KEY_H = 72,
|
|
1000
|
+
/** I key. */
|
|
1001
|
+
KEY_I = 73,
|
|
1002
|
+
/** J key. */
|
|
1003
|
+
KEY_J = 74,
|
|
1004
|
+
/** K key. */
|
|
1005
|
+
KEY_K = 75,
|
|
1006
|
+
/** L key. */
|
|
1007
|
+
KEY_L = 76,
|
|
1008
|
+
/** M key. */
|
|
1009
|
+
KEY_M = 77,
|
|
1010
|
+
/** N key. */
|
|
1011
|
+
KEY_N = 78,
|
|
1012
|
+
/** O key. */
|
|
1013
|
+
KEY_O = 79,
|
|
1014
|
+
/** P key. */
|
|
1015
|
+
KEY_P = 80,
|
|
1016
|
+
/** Q key. */
|
|
1017
|
+
KEY_Q = 81,
|
|
1018
|
+
/** R key. */
|
|
1019
|
+
KEY_R = 82,
|
|
1020
|
+
/** S key. */
|
|
1021
|
+
KEY_S = 83,
|
|
1022
|
+
/** T key. */
|
|
1023
|
+
KEY_T = 84,
|
|
1024
|
+
/** U key. */
|
|
1025
|
+
KEY_U = 85,
|
|
1026
|
+
/** V key. */
|
|
1027
|
+
KEY_V = 86,
|
|
1028
|
+
/** W key. */
|
|
1029
|
+
KEY_W = 87,
|
|
1030
|
+
/** X key. */
|
|
1031
|
+
KEY_X = 88,
|
|
1032
|
+
/** Y key. */
|
|
1033
|
+
KEY_Y = 89,
|
|
1034
|
+
/** Z key. */
|
|
1035
|
+
KEY_Z = 90,
|
|
1036
|
+
/** Left bracket (`[lb]`) key. */
|
|
1037
|
+
KEY_BRACKETLEFT = 91,
|
|
1038
|
+
/** Backslash (`\`) key. */
|
|
1039
|
+
KEY_BACKSLASH = 92,
|
|
1040
|
+
/** Right bracket (`[rb]`) key. */
|
|
1041
|
+
KEY_BRACKETRIGHT = 93,
|
|
1042
|
+
/** Caret (`^`) key. */
|
|
1043
|
+
KEY_ASCIICIRCUM = 94,
|
|
1044
|
+
/** Underscore (`_`) key. */
|
|
1045
|
+
KEY_UNDERSCORE = 95,
|
|
1046
|
+
/** Backtick (```) key. */
|
|
1047
|
+
KEY_QUOTELEFT = 96,
|
|
1048
|
+
/** Left brace (`{`) key. */
|
|
1049
|
+
KEY_BRACELEFT = 123,
|
|
1050
|
+
/** Vertical bar or *pipe* (`|`) key. */
|
|
1051
|
+
KEY_BAR = 124,
|
|
1052
|
+
/** Right brace (`}`) key. */
|
|
1053
|
+
KEY_BRACERIGHT = 125,
|
|
1054
|
+
/** Tilde (`~`) key. */
|
|
1055
|
+
KEY_ASCIITILDE = 126,
|
|
1056
|
+
/** Yen symbol (`¥`) key. */
|
|
1057
|
+
KEY_YEN = 165,
|
|
1058
|
+
/** Section sign (`§`) key. */
|
|
1059
|
+
KEY_SECTION = 167,
|
|
1060
|
+
}
|
|
1061
|
+
|
|
1062
|
+
declare const enum KeyModifierMask {
|
|
1063
|
+
/** Key Code mask. */
|
|
1064
|
+
KEY_CODE_MASK = 8388607,
|
|
1065
|
+
/** Modifier key mask. */
|
|
1066
|
+
KEY_MODIFIER_MASK = 2130706432,
|
|
1067
|
+
/**
|
|
1068
|
+
* Automatically remapped to {@link KEY_META} on macOS and {@link KEY_CTRL} on other platforms, this mask is never set in the actual events, and should be used for key mapping only.
|
|
1069
|
+
*/
|
|
1070
|
+
KEY_MASK_CMD_OR_CTRL = 16777216,
|
|
1071
|
+
/** Shift key mask. */
|
|
1072
|
+
KEY_MASK_SHIFT = 33554432,
|
|
1073
|
+
/** Alt or Option (on macOS) key mask. */
|
|
1074
|
+
KEY_MASK_ALT = 67108864,
|
|
1075
|
+
/** Command (on macOS) or Meta/Windows key mask. */
|
|
1076
|
+
KEY_MASK_META = 134217728,
|
|
1077
|
+
/** Control key mask. */
|
|
1078
|
+
KEY_MASK_CTRL = 268435456,
|
|
1079
|
+
/** Keypad key mask. */
|
|
1080
|
+
KEY_MASK_KPAD = 536870912,
|
|
1081
|
+
/** Group Switch key mask. */
|
|
1082
|
+
KEY_MASK_GROUP_SWITCH = 1073741824,
|
|
1083
|
+
}
|
|
1084
|
+
|
|
1085
|
+
declare const enum KeyLocation {
|
|
1086
|
+
/**
|
|
1087
|
+
* Used for keys which only appear once, or when a comparison doesn't need to differentiate the `LEFT` and `RIGHT` versions.
|
|
1088
|
+
* For example, when using {@link InputEvent.is_match}, an event which has {@link KEY_LOCATION_UNSPECIFIED} will match any {@link KeyLocation} on the passed event.
|
|
1089
|
+
*/
|
|
1090
|
+
KEY_LOCATION_UNSPECIFIED = 0,
|
|
1091
|
+
/** A key which is to the left of its twin. */
|
|
1092
|
+
KEY_LOCATION_LEFT = 1,
|
|
1093
|
+
/** A key which is to the right of its twin. */
|
|
1094
|
+
KEY_LOCATION_RIGHT = 2,
|
|
1095
|
+
}
|
|
1096
|
+
|
|
1097
|
+
declare const enum MouseButton {
|
|
1098
|
+
/**
|
|
1099
|
+
* Enum value which doesn't correspond to any mouse button. This is used to initialize {@link MouseButton} properties with a generic state.
|
|
1100
|
+
*/
|
|
1101
|
+
MOUSE_BUTTON_NONE = 0,
|
|
1102
|
+
/** Primary mouse button, usually assigned to the left button. */
|
|
1103
|
+
MOUSE_BUTTON_LEFT = 1,
|
|
1104
|
+
/** Secondary mouse button, usually assigned to the right button. */
|
|
1105
|
+
MOUSE_BUTTON_RIGHT = 2,
|
|
1106
|
+
/** Middle mouse button. */
|
|
1107
|
+
MOUSE_BUTTON_MIDDLE = 3,
|
|
1108
|
+
/** Mouse wheel scrolling up. */
|
|
1109
|
+
MOUSE_BUTTON_WHEEL_UP = 4,
|
|
1110
|
+
/** Mouse wheel scrolling down. */
|
|
1111
|
+
MOUSE_BUTTON_WHEEL_DOWN = 5,
|
|
1112
|
+
/** Mouse wheel left button (only present on some mice). */
|
|
1113
|
+
MOUSE_BUTTON_WHEEL_LEFT = 6,
|
|
1114
|
+
/** Mouse wheel right button (only present on some mice). */
|
|
1115
|
+
MOUSE_BUTTON_WHEEL_RIGHT = 7,
|
|
1116
|
+
/** Extra mouse button 1. This is sometimes present, usually to the sides of the mouse. */
|
|
1117
|
+
MOUSE_BUTTON_XBUTTON1 = 8,
|
|
1118
|
+
/** Extra mouse button 2. This is sometimes present, usually to the sides of the mouse. */
|
|
1119
|
+
MOUSE_BUTTON_XBUTTON2 = 9,
|
|
1120
|
+
}
|
|
1121
|
+
|
|
1122
|
+
declare const enum MouseButtonMask {
|
|
1123
|
+
/** Primary mouse button mask, usually for the left button. */
|
|
1124
|
+
MOUSE_BUTTON_MASK_LEFT = 1,
|
|
1125
|
+
/** Secondary mouse button mask, usually for the right button. */
|
|
1126
|
+
MOUSE_BUTTON_MASK_RIGHT = 2,
|
|
1127
|
+
/** Middle mouse button mask. */
|
|
1128
|
+
MOUSE_BUTTON_MASK_MIDDLE = 4,
|
|
1129
|
+
/** Extra mouse button 1 mask. */
|
|
1130
|
+
MOUSE_BUTTON_MASK_MB_XBUTTON1 = 128,
|
|
1131
|
+
/** Extra mouse button 2 mask. */
|
|
1132
|
+
MOUSE_BUTTON_MASK_MB_XBUTTON2 = 256,
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
declare const enum JoyButton {
|
|
1136
|
+
/** An invalid game controller button. */
|
|
1137
|
+
JOY_BUTTON_INVALID = -1,
|
|
1138
|
+
/**
|
|
1139
|
+
* Game controller SDL button A. Corresponds to the bottom action button: Sony Cross, Xbox A, Nintendo B.
|
|
1140
|
+
*/
|
|
1141
|
+
JOY_BUTTON_A = 0,
|
|
1142
|
+
/**
|
|
1143
|
+
* Game controller SDL button B. Corresponds to the right action button: Sony Circle, Xbox B, Nintendo A.
|
|
1144
|
+
*/
|
|
1145
|
+
JOY_BUTTON_B = 1,
|
|
1146
|
+
/**
|
|
1147
|
+
* Game controller SDL button X. Corresponds to the left action button: Sony Square, Xbox X, Nintendo Y.
|
|
1148
|
+
*/
|
|
1149
|
+
JOY_BUTTON_X = 2,
|
|
1150
|
+
/**
|
|
1151
|
+
* Game controller SDL button Y. Corresponds to the top action button: Sony Triangle, Xbox Y, Nintendo X.
|
|
1152
|
+
*/
|
|
1153
|
+
JOY_BUTTON_Y = 3,
|
|
1154
|
+
/** Game controller SDL back button. Corresponds to the Sony Select, Xbox Back, Nintendo - button. */
|
|
1155
|
+
JOY_BUTTON_BACK = 4,
|
|
1156
|
+
/** Game controller SDL guide button. Corresponds to the Sony PS, Xbox Home button. */
|
|
1157
|
+
JOY_BUTTON_GUIDE = 5,
|
|
1158
|
+
/** Game controller SDL start button. Corresponds to the Sony Options, Xbox Menu, Nintendo + button. */
|
|
1159
|
+
JOY_BUTTON_START = 6,
|
|
1160
|
+
/** Game controller SDL left stick button. Corresponds to the Sony L3, Xbox L/LS button. */
|
|
1161
|
+
JOY_BUTTON_LEFT_STICK = 7,
|
|
1162
|
+
/** Game controller SDL right stick button. Corresponds to the Sony R3, Xbox R/RS button. */
|
|
1163
|
+
JOY_BUTTON_RIGHT_STICK = 8,
|
|
1164
|
+
/** Game controller SDL left shoulder button. Corresponds to the Sony L1, Xbox LB button. */
|
|
1165
|
+
JOY_BUTTON_LEFT_SHOULDER = 9,
|
|
1166
|
+
/** Game controller SDL right shoulder button. Corresponds to the Sony R1, Xbox RB button. */
|
|
1167
|
+
JOY_BUTTON_RIGHT_SHOULDER = 10,
|
|
1168
|
+
/** Game controller D-pad up button. */
|
|
1169
|
+
JOY_BUTTON_DPAD_UP = 11,
|
|
1170
|
+
/** Game controller D-pad down button. */
|
|
1171
|
+
JOY_BUTTON_DPAD_DOWN = 12,
|
|
1172
|
+
/** Game controller D-pad left button. */
|
|
1173
|
+
JOY_BUTTON_DPAD_LEFT = 13,
|
|
1174
|
+
/** Game controller D-pad right button. */
|
|
1175
|
+
JOY_BUTTON_DPAD_RIGHT = 14,
|
|
1176
|
+
/**
|
|
1177
|
+
* Game controller SDL miscellaneous button. Corresponds to Xbox share button, PS5 microphone button, Nintendo Switch capture button.
|
|
1178
|
+
*/
|
|
1179
|
+
JOY_BUTTON_MISC1 = 15,
|
|
1180
|
+
/** Game controller SDL paddle 1 button. */
|
|
1181
|
+
JOY_BUTTON_PADDLE1 = 16,
|
|
1182
|
+
/** Game controller SDL paddle 2 button. */
|
|
1183
|
+
JOY_BUTTON_PADDLE2 = 17,
|
|
1184
|
+
/** Game controller SDL paddle 3 button. */
|
|
1185
|
+
JOY_BUTTON_PADDLE3 = 18,
|
|
1186
|
+
/** Game controller SDL paddle 4 button. */
|
|
1187
|
+
JOY_BUTTON_PADDLE4 = 19,
|
|
1188
|
+
/** Game controller SDL touchpad button. */
|
|
1189
|
+
JOY_BUTTON_TOUCHPAD = 20,
|
|
1190
|
+
/**
|
|
1191
|
+
* Game controller SDL miscellaneous button. Used by Nintendo Switch 2 Pro Controller and Horipad Steam controllers.
|
|
1192
|
+
*/
|
|
1193
|
+
JOY_BUTTON_MISC2 = 21,
|
|
1194
|
+
/** Game controller SDL miscellaneous button. */
|
|
1195
|
+
JOY_BUTTON_MISC3 = 22,
|
|
1196
|
+
/** Game controller SDL miscellaneous button. */
|
|
1197
|
+
JOY_BUTTON_MISC4 = 23,
|
|
1198
|
+
/** Game controller SDL miscellaneous button. */
|
|
1199
|
+
JOY_BUTTON_MISC5 = 24,
|
|
1200
|
+
/** Game controller SDL miscellaneous button. */
|
|
1201
|
+
JOY_BUTTON_MISC6 = 25,
|
|
1202
|
+
/** The number of SDL game controller buttons. */
|
|
1203
|
+
JOY_BUTTON_SDL_MAX = 26,
|
|
1204
|
+
/**
|
|
1205
|
+
* The maximum number of game controller buttons supported by the engine. The actual limit may be lower on specific platforms:
|
|
1206
|
+
* - **Android:** Up to 36 buttons.
|
|
1207
|
+
* - **Linux:** Up to 80 buttons.
|
|
1208
|
+
* - **Windows** and **macOS:** Up to 128 buttons.
|
|
1209
|
+
*/
|
|
1210
|
+
JOY_BUTTON_MAX = 128,
|
|
1211
|
+
}
|
|
1212
|
+
|
|
1213
|
+
declare const enum JoyAxis {
|
|
1214
|
+
/** An invalid game controller axis. */
|
|
1215
|
+
JOY_AXIS_INVALID = -1,
|
|
1216
|
+
/** Game controller left joystick x-axis. */
|
|
1217
|
+
JOY_AXIS_LEFT_X = 0,
|
|
1218
|
+
/** Game controller left joystick y-axis. */
|
|
1219
|
+
JOY_AXIS_LEFT_Y = 1,
|
|
1220
|
+
/** Game controller right joystick x-axis. */
|
|
1221
|
+
JOY_AXIS_RIGHT_X = 2,
|
|
1222
|
+
/** Game controller right joystick y-axis. */
|
|
1223
|
+
JOY_AXIS_RIGHT_Y = 3,
|
|
1224
|
+
/** Game controller left trigger axis. */
|
|
1225
|
+
JOY_AXIS_TRIGGER_LEFT = 4,
|
|
1226
|
+
/** Game controller right trigger axis. */
|
|
1227
|
+
JOY_AXIS_TRIGGER_RIGHT = 5,
|
|
1228
|
+
/** The number of SDL game controller axes. */
|
|
1229
|
+
JOY_AXIS_SDL_MAX = 6,
|
|
1230
|
+
/**
|
|
1231
|
+
* The maximum number of game controller axes: OpenVR supports up to 5 Joysticks making a total of 10 axes.
|
|
1232
|
+
*/
|
|
1233
|
+
JOY_AXIS_MAX = 10,
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
declare const enum MIDIMessage {
|
|
1237
|
+
/**
|
|
1238
|
+
* Does not correspond to any MIDI message. This is the default value of {@link InputEventMIDI.message}.
|
|
1239
|
+
*/
|
|
1240
|
+
MIDI_MESSAGE_NONE = 0,
|
|
1241
|
+
/**
|
|
1242
|
+
* MIDI message sent when a note is released.
|
|
1243
|
+
* **Note:** Not all MIDI devices send this message; some may send {@link MIDI_MESSAGE_NOTE_ON} with {@link InputEventMIDI.velocity} set to `0`.
|
|
1244
|
+
*/
|
|
1245
|
+
MIDI_MESSAGE_NOTE_OFF = 8,
|
|
1246
|
+
/** MIDI message sent when a note is pressed. */
|
|
1247
|
+
MIDI_MESSAGE_NOTE_ON = 9,
|
|
1248
|
+
/**
|
|
1249
|
+
* MIDI message sent to indicate a change in pressure while a note is being pressed down, also called aftertouch.
|
|
1250
|
+
*/
|
|
1251
|
+
MIDI_MESSAGE_AFTERTOUCH = 10,
|
|
1252
|
+
/**
|
|
1253
|
+
* MIDI message sent when a controller value changes. In a MIDI device, a controller is any input that doesn't play notes. These may include sliders for volume, balance, and panning, as well as switches and pedals. See the General MIDI specification (https://en.wikipedia.org/wiki/General_MIDI#Controller_events) for a small list.
|
|
1254
|
+
*/
|
|
1255
|
+
MIDI_MESSAGE_CONTROL_CHANGE = 11,
|
|
1256
|
+
/**
|
|
1257
|
+
* MIDI message sent when the MIDI device changes its current instrument (also called *program* or *preset*).
|
|
1258
|
+
*/
|
|
1259
|
+
MIDI_MESSAGE_PROGRAM_CHANGE = 12,
|
|
1260
|
+
/**
|
|
1261
|
+
* MIDI message sent to indicate a change in pressure for the whole channel. Some MIDI devices may send this instead of {@link MIDI_MESSAGE_AFTERTOUCH}.
|
|
1262
|
+
*/
|
|
1263
|
+
MIDI_MESSAGE_CHANNEL_PRESSURE = 13,
|
|
1264
|
+
/** MIDI message sent when the value of the pitch bender changes, usually a wheel on the MIDI device. */
|
|
1265
|
+
MIDI_MESSAGE_PITCH_BEND = 14,
|
|
1266
|
+
/**
|
|
1267
|
+
* MIDI system exclusive (SysEx) message. This type of message is not standardized and it's highly dependent on the MIDI device sending it.
|
|
1268
|
+
* **Note:** Getting this message's data from {@link InputEventMIDI} is not implemented.
|
|
1269
|
+
*/
|
|
1270
|
+
MIDI_MESSAGE_SYSTEM_EXCLUSIVE = 240,
|
|
1271
|
+
/**
|
|
1272
|
+
* MIDI message sent every quarter frame to keep connected MIDI devices synchronized. Related to {@link MIDI_MESSAGE_TIMING_CLOCK}.
|
|
1273
|
+
* **Note:** Getting this message's data from {@link InputEventMIDI} is not implemented.
|
|
1274
|
+
*/
|
|
1275
|
+
MIDI_MESSAGE_QUARTER_FRAME = 241,
|
|
1276
|
+
/**
|
|
1277
|
+
* MIDI message sent to jump onto a new position in the current sequence or song.
|
|
1278
|
+
* **Note:** Getting this message's data from {@link InputEventMIDI} is not implemented.
|
|
1279
|
+
*/
|
|
1280
|
+
MIDI_MESSAGE_SONG_POSITION_POINTER = 242,
|
|
1281
|
+
/**
|
|
1282
|
+
* MIDI message sent to select a sequence or song to play.
|
|
1283
|
+
* **Note:** Getting this message's data from {@link InputEventMIDI} is not implemented.
|
|
1284
|
+
*/
|
|
1285
|
+
MIDI_MESSAGE_SONG_SELECT = 243,
|
|
1286
|
+
/**
|
|
1287
|
+
* MIDI message sent to request a tuning calibration. Used on analog synthesizers. Most modern MIDI devices do not need this message.
|
|
1288
|
+
*/
|
|
1289
|
+
MIDI_MESSAGE_TUNE_REQUEST = 246,
|
|
1290
|
+
/**
|
|
1291
|
+
* MIDI message sent 24 times after {@link MIDI_MESSAGE_QUARTER_FRAME}, to keep connected MIDI devices synchronized.
|
|
1292
|
+
*/
|
|
1293
|
+
MIDI_MESSAGE_TIMING_CLOCK = 248,
|
|
1294
|
+
/** MIDI message sent to start the current sequence or song from the beginning. */
|
|
1295
|
+
MIDI_MESSAGE_START = 250,
|
|
1296
|
+
/** MIDI message sent to resume from the point the current sequence or song was paused. */
|
|
1297
|
+
MIDI_MESSAGE_CONTINUE = 251,
|
|
1298
|
+
/** MIDI message sent to pause the current sequence or song. */
|
|
1299
|
+
MIDI_MESSAGE_STOP = 252,
|
|
1300
|
+
/**
|
|
1301
|
+
* MIDI message sent repeatedly while the MIDI device is idle, to tell the receiver that the connection is alive. Most MIDI devices do not send this message.
|
|
1302
|
+
*/
|
|
1303
|
+
MIDI_MESSAGE_ACTIVE_SENSING = 254,
|
|
1304
|
+
/**
|
|
1305
|
+
* MIDI message sent to reset a MIDI device to its default state, as if it was just turned on. It should not be sent when the MIDI device is being turned on.
|
|
1306
|
+
*/
|
|
1307
|
+
MIDI_MESSAGE_SYSTEM_RESET = 255,
|
|
1308
|
+
}
|
|
1309
|
+
|
|
1310
|
+
declare const enum Error {
|
|
1311
|
+
/**
|
|
1312
|
+
* Methods that return {@link Error} return {@link OK} when no error occurred.
|
|
1313
|
+
* Since {@link OK} has value `0`, and all other error constants are positive integers, it can also be used in boolean checks.
|
|
1314
|
+
* **Note:** Many functions do not return an error code, but will print error messages to standard output.
|
|
1315
|
+
*/
|
|
1316
|
+
OK = 0,
|
|
1317
|
+
/** Generic error. */
|
|
1318
|
+
FAILED = 1,
|
|
1319
|
+
/** Unavailable error. */
|
|
1320
|
+
ERR_UNAVAILABLE = 2,
|
|
1321
|
+
/** Unconfigured error. */
|
|
1322
|
+
ERR_UNCONFIGURED = 3,
|
|
1323
|
+
/** Unauthorized error. */
|
|
1324
|
+
ERR_UNAUTHORIZED = 4,
|
|
1325
|
+
/** Parameter range error. */
|
|
1326
|
+
ERR_PARAMETER_RANGE_ERROR = 5,
|
|
1327
|
+
/** Out of memory (OOM) error. */
|
|
1328
|
+
ERR_OUT_OF_MEMORY = 6,
|
|
1329
|
+
/** File: Not found error. */
|
|
1330
|
+
ERR_FILE_NOT_FOUND = 7,
|
|
1331
|
+
/** File: Bad drive error. */
|
|
1332
|
+
ERR_FILE_BAD_DRIVE = 8,
|
|
1333
|
+
/** File: Bad path error. */
|
|
1334
|
+
ERR_FILE_BAD_PATH = 9,
|
|
1335
|
+
/** File: No permission error. */
|
|
1336
|
+
ERR_FILE_NO_PERMISSION = 10,
|
|
1337
|
+
/** File: Already in use error. */
|
|
1338
|
+
ERR_FILE_ALREADY_IN_USE = 11,
|
|
1339
|
+
/** File: Can't open error. */
|
|
1340
|
+
ERR_FILE_CANT_OPEN = 12,
|
|
1341
|
+
/** File: Can't write error. */
|
|
1342
|
+
ERR_FILE_CANT_WRITE = 13,
|
|
1343
|
+
/** File: Can't read error. */
|
|
1344
|
+
ERR_FILE_CANT_READ = 14,
|
|
1345
|
+
/** File: Unrecognized error. */
|
|
1346
|
+
ERR_FILE_UNRECOGNIZED = 15,
|
|
1347
|
+
/** File: Corrupt error. */
|
|
1348
|
+
ERR_FILE_CORRUPT = 16,
|
|
1349
|
+
/** File: Missing dependencies error. */
|
|
1350
|
+
ERR_FILE_MISSING_DEPENDENCIES = 17,
|
|
1351
|
+
/** File: End of file (EOF) error. */
|
|
1352
|
+
ERR_FILE_EOF = 18,
|
|
1353
|
+
/** Can't open error. */
|
|
1354
|
+
ERR_CANT_OPEN = 19,
|
|
1355
|
+
/** Can't create error. */
|
|
1356
|
+
ERR_CANT_CREATE = 20,
|
|
1357
|
+
/** Query failed error. */
|
|
1358
|
+
ERR_QUERY_FAILED = 21,
|
|
1359
|
+
/** Already in use error. */
|
|
1360
|
+
ERR_ALREADY_IN_USE = 22,
|
|
1361
|
+
/** Locked error. */
|
|
1362
|
+
ERR_LOCKED = 23,
|
|
1363
|
+
/** Timeout error. */
|
|
1364
|
+
ERR_TIMEOUT = 24,
|
|
1365
|
+
/** Can't connect error. */
|
|
1366
|
+
ERR_CANT_CONNECT = 25,
|
|
1367
|
+
/** Can't resolve error. */
|
|
1368
|
+
ERR_CANT_RESOLVE = 26,
|
|
1369
|
+
/** Connection error. */
|
|
1370
|
+
ERR_CONNECTION_ERROR = 27,
|
|
1371
|
+
/** Can't acquire resource error. */
|
|
1372
|
+
ERR_CANT_ACQUIRE_RESOURCE = 28,
|
|
1373
|
+
/** Can't fork process error. */
|
|
1374
|
+
ERR_CANT_FORK = 29,
|
|
1375
|
+
/** Invalid data error. */
|
|
1376
|
+
ERR_INVALID_DATA = 30,
|
|
1377
|
+
/** Invalid parameter error. */
|
|
1378
|
+
ERR_INVALID_PARAMETER = 31,
|
|
1379
|
+
/** Already exists error. */
|
|
1380
|
+
ERR_ALREADY_EXISTS = 32,
|
|
1381
|
+
/** Does not exist error. */
|
|
1382
|
+
ERR_DOES_NOT_EXIST = 33,
|
|
1383
|
+
/** Database: Read error. */
|
|
1384
|
+
ERR_DATABASE_CANT_READ = 34,
|
|
1385
|
+
/** Database: Write error. */
|
|
1386
|
+
ERR_DATABASE_CANT_WRITE = 35,
|
|
1387
|
+
/** Compilation failed error. */
|
|
1388
|
+
ERR_COMPILATION_FAILED = 36,
|
|
1389
|
+
/** Method not found error. */
|
|
1390
|
+
ERR_METHOD_NOT_FOUND = 37,
|
|
1391
|
+
/** Linking failed error. */
|
|
1392
|
+
ERR_LINK_FAILED = 38,
|
|
1393
|
+
/** Script failed error. */
|
|
1394
|
+
ERR_SCRIPT_FAILED = 39,
|
|
1395
|
+
/** Cycling link (import cycle) error. */
|
|
1396
|
+
ERR_CYCLIC_LINK = 40,
|
|
1397
|
+
/** Invalid declaration error. */
|
|
1398
|
+
ERR_INVALID_DECLARATION = 41,
|
|
1399
|
+
/** Duplicate symbol error. */
|
|
1400
|
+
ERR_DUPLICATE_SYMBOL = 42,
|
|
1401
|
+
/** Parse error. */
|
|
1402
|
+
ERR_PARSE_ERROR = 43,
|
|
1403
|
+
/** Busy error. */
|
|
1404
|
+
ERR_BUSY = 44,
|
|
1405
|
+
/** Skip error. */
|
|
1406
|
+
ERR_SKIP = 45,
|
|
1407
|
+
/** Help error. Used internally when passing `--version` or `--help` as executable options. */
|
|
1408
|
+
ERR_HELP = 46,
|
|
1409
|
+
/**
|
|
1410
|
+
* Bug error, caused by an implementation issue in the method.
|
|
1411
|
+
* **Note:** If a built-in method returns this code, please open an issue on the GitHub Issue Tracker (https://github.com/godotengine/godot/issues).
|
|
1412
|
+
*/
|
|
1413
|
+
ERR_BUG = 47,
|
|
1414
|
+
/** Printer on fire error (This is an easter egg, no built-in methods return this error code). */
|
|
1415
|
+
ERR_PRINTER_ON_FIRE = 48,
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1418
|
+
declare const enum PropertyHint {
|
|
1419
|
+
/** The property has no hint for the editor. */
|
|
1420
|
+
PROPERTY_HINT_NONE = 0,
|
|
1421
|
+
/**
|
|
1422
|
+
* Hints that an [int] or [float] property should be within a range specified via the hint string `"min,max"` or `"min,max,step"`. The hint string can optionally include `"or_greater"` and/or `"or_less"` to allow manual input going respectively above the max or below the min values.
|
|
1423
|
+
* **Example:** `"-360,360,1,or_greater,or_less"`.
|
|
1424
|
+
* Additionally, other keywords can be included: `"exp"` for exponential range editing, `"radians_as_degrees"` for editing radian angles in degrees (the range values are also in degrees), `"degrees"` to hint at an angle, `"prefer_slider"` to show the slider for integers, `"hide_control"` to hide the slider or up-down arrows, and `"suffix:px/s"` to display a suffix indicating the value's unit (e.g. `px/s` for pixels per second).
|
|
1425
|
+
*/
|
|
1426
|
+
PROPERTY_HINT_RANGE = 1,
|
|
1427
|
+
/**
|
|
1428
|
+
* Hints that an [int], {@link String}, or {@link StringName} property is an enumerated value to pick in a list specified via a hint string.
|
|
1429
|
+
* The hint string is a comma separated list of names such as `"Hello,Something,Else"`. Whitespace is **not** removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending `:integer` to the name, e.g. `"Zero,One,Three:3,Four,Six:6"`.
|
|
1430
|
+
*/
|
|
1431
|
+
PROPERTY_HINT_ENUM = 2,
|
|
1432
|
+
/**
|
|
1433
|
+
* Hints that a {@link String} or {@link StringName} property can be an enumerated value to pick in a list specified via a hint string such as `"Hello,Something,Else"`. See {@link PROPERTY_HINT_ENUM} for details.
|
|
1434
|
+
* Unlike {@link PROPERTY_HINT_ENUM}, a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values.
|
|
1435
|
+
*/
|
|
1436
|
+
PROPERTY_HINT_ENUM_SUGGESTION = 3,
|
|
1437
|
+
/**
|
|
1438
|
+
* Hints that a [float] property should be edited via an exponential easing function. The hint string can include `"attenuation"` to flip the curve horizontally and/or `"positive_only"` to exclude in/out easing and limit values to be greater than or equal to zero.
|
|
1439
|
+
*/
|
|
1440
|
+
PROPERTY_HINT_EXP_EASING = 4,
|
|
1441
|
+
/**
|
|
1442
|
+
* Hints that a vector property should allow its components to be linked. For example, this allows {@link Vector2.x} and {@link Vector2.y} to be edited together.
|
|
1443
|
+
*/
|
|
1444
|
+
PROPERTY_HINT_LINK = 5,
|
|
1445
|
+
/**
|
|
1446
|
+
* Hints that an [int] property is a bitmask with named bit flags.
|
|
1447
|
+
* The hint string is a comma separated list of names such as `"Bit0,Bit1,Bit2,Bit3"`. Whitespace is **not** removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending `:integer` to the name, e.g. `"A:4,B:8,C:16"`. You can also combine several flags (`"A:4,B:8,AB:12,C:16"`).
|
|
1448
|
+
* **Note:** A flag value must be at least `1` and at most `2 ** 32 - 1`.
|
|
1449
|
+
* **Note:** Unlike {@link PROPERTY_HINT_ENUM}, the previous explicit value is not taken into account. For the hint `"A:16,B,C"`, A is 16, B is 2, C is 4.
|
|
1450
|
+
*/
|
|
1451
|
+
PROPERTY_HINT_FLAGS = 6,
|
|
1452
|
+
/** Hints that an [int] property is a bitmask using the optionally named 2D render layers. */
|
|
1453
|
+
PROPERTY_HINT_LAYERS_2D_RENDER = 7,
|
|
1454
|
+
/** Hints that an [int] property is a bitmask using the optionally named 2D physics layers. */
|
|
1455
|
+
PROPERTY_HINT_LAYERS_2D_PHYSICS = 8,
|
|
1456
|
+
/** Hints that an [int] property is a bitmask using the optionally named 2D navigation layers. */
|
|
1457
|
+
PROPERTY_HINT_LAYERS_2D_NAVIGATION = 9,
|
|
1458
|
+
/** Hints that an [int] property is a bitmask using the optionally named 3D render layers. */
|
|
1459
|
+
PROPERTY_HINT_LAYERS_3D_RENDER = 10,
|
|
1460
|
+
/** Hints that an [int] property is a bitmask using the optionally named 3D physics layers. */
|
|
1461
|
+
PROPERTY_HINT_LAYERS_3D_PHYSICS = 11,
|
|
1462
|
+
/** Hints that an [int] property is a bitmask using the optionally named 3D navigation layers. */
|
|
1463
|
+
PROPERTY_HINT_LAYERS_3D_NAVIGATION = 12,
|
|
1464
|
+
/** Hints that an integer property is a bitmask using the optionally named avoidance layers. */
|
|
1465
|
+
PROPERTY_HINT_LAYERS_AVOIDANCE = 37,
|
|
1466
|
+
/**
|
|
1467
|
+
* Hints that a {@link String} property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like `"*.png,*.jpg"`. By default the file will be stored as UID whenever available. You can use {@link ResourceUID} methods to convert it back to path. For storing a raw path, use {@link PROPERTY_HINT_FILE_PATH}.
|
|
1468
|
+
*/
|
|
1469
|
+
PROPERTY_HINT_FILE = 13,
|
|
1470
|
+
/**
|
|
1471
|
+
* Hints that a {@link String} property is a path to a directory. Editing it will show a file dialog for picking the path.
|
|
1472
|
+
*/
|
|
1473
|
+
PROPERTY_HINT_DIR = 14,
|
|
1474
|
+
/**
|
|
1475
|
+
* Hints that a {@link String} property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards, like `"*.png,*.jpg"`.
|
|
1476
|
+
*/
|
|
1477
|
+
PROPERTY_HINT_GLOBAL_FILE = 15,
|
|
1478
|
+
/**
|
|
1479
|
+
* Hints that a {@link String} property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.
|
|
1480
|
+
*/
|
|
1481
|
+
PROPERTY_HINT_GLOBAL_DIR = 16,
|
|
1482
|
+
/**
|
|
1483
|
+
* Hints that a property is an instance of a {@link Resource}-derived type, optionally specified via the hint string (e.g. `"Texture2D"`). Editing it will show a popup menu of valid resource types to instantiate.
|
|
1484
|
+
*/
|
|
1485
|
+
PROPERTY_HINT_RESOURCE_TYPE = 17,
|
|
1486
|
+
/**
|
|
1487
|
+
* Hints that a {@link String} property is text with line breaks. Editing it will show a text input field where line breaks can be typed.
|
|
1488
|
+
* The hint string can be set to `"monospace"` to force the input field to use a monospaced font.
|
|
1489
|
+
* If the hint string `"no_wrap"` is set, the input field will not wrap lines at boundaries, instead resorting to making the area scrollable.
|
|
1490
|
+
*/
|
|
1491
|
+
PROPERTY_HINT_MULTILINE_TEXT = 18,
|
|
1492
|
+
/** Hints that a {@link String} property is an {@link Expression}. */
|
|
1493
|
+
PROPERTY_HINT_EXPRESSION = 19,
|
|
1494
|
+
/**
|
|
1495
|
+
* Hints that a {@link String} property should show a placeholder text on its input field, if empty. The hint string is the placeholder text to use.
|
|
1496
|
+
*/
|
|
1497
|
+
PROPERTY_HINT_PLACEHOLDER_TEXT = 20,
|
|
1498
|
+
/**
|
|
1499
|
+
* Hints that a {@link Color} property should be edited without affecting its transparency ({@link Color.a} is not editable).
|
|
1500
|
+
*/
|
|
1501
|
+
PROPERTY_HINT_COLOR_NO_ALPHA = 21,
|
|
1502
|
+
/**
|
|
1503
|
+
* Hints that the property's value is an object encoded as object ID, with its type specified in the hint string. Used by the debugger.
|
|
1504
|
+
*/
|
|
1505
|
+
PROPERTY_HINT_OBJECT_ID = 22,
|
|
1506
|
+
/**
|
|
1507
|
+
* If a property is {@link String}, hints that the property represents a particular type (class). This allows to select a type from the create dialog. The property will store the selected type as a string.
|
|
1508
|
+
* If a property is {@link Array}, hints the editor how to show elements. The `hint_string` must encode nested types using `":"` and `"/"`.
|
|
1509
|
+
* If a property is {@link Dictionary}, hints the editor how to show elements. The `hint_string` is the same as {@link Array}, with a `";"` separating the key and value.
|
|
1510
|
+
* **Examples:**
|
|
1511
|
+
* **Note:** The trailing colon is required for properly detecting built-in types.
|
|
1512
|
+
*/
|
|
1513
|
+
PROPERTY_HINT_TYPE_STRING = 23,
|
|
1514
|
+
PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE = 24,
|
|
1515
|
+
/** Hints that an object is too big to be sent via the debugger. */
|
|
1516
|
+
PROPERTY_HINT_OBJECT_TOO_BIG = 25,
|
|
1517
|
+
/** Hints that the hint string specifies valid node types for property of type {@link NodePath}. */
|
|
1518
|
+
PROPERTY_HINT_NODE_PATH_VALID_TYPES = 26,
|
|
1519
|
+
/**
|
|
1520
|
+
* Hints that a {@link String} property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the project's directory. The hint string can be a set of filters with wildcards like `"*.png,*.jpg"`. See also {@link FileDialog.filters}.
|
|
1521
|
+
*/
|
|
1522
|
+
PROPERTY_HINT_SAVE_FILE = 27,
|
|
1523
|
+
/**
|
|
1524
|
+
* Hints that a {@link String} property is a path to a file. Editing it will show a file dialog for picking the path for the file to be saved at. The dialog has access to the entire filesystem. The hint string can be a set of filters with wildcards like `"*.png,*.jpg"`. See also {@link FileDialog.filters}.
|
|
1525
|
+
*/
|
|
1526
|
+
PROPERTY_HINT_GLOBAL_SAVE_FILE = 28,
|
|
1527
|
+
PROPERTY_HINT_INT_IS_OBJECTID = 29,
|
|
1528
|
+
/** Hints that an [int] property is a pointer. Used by GDExtension. */
|
|
1529
|
+
PROPERTY_HINT_INT_IS_POINTER = 30,
|
|
1530
|
+
/**
|
|
1531
|
+
* Hints that a property is an {@link Array} with the stored type specified in the hint string. The hint string contains the type of the array (e.g. `"String"`).
|
|
1532
|
+
* Use the hint string format from {@link PROPERTY_HINT_TYPE_STRING} for more control over the stored type.
|
|
1533
|
+
*/
|
|
1534
|
+
PROPERTY_HINT_ARRAY_TYPE = 31,
|
|
1535
|
+
/**
|
|
1536
|
+
* Hints that a property is a {@link Dictionary} with the stored types specified in the hint string. The hint string contains the key and value types separated by a semicolon (e.g. `"int;String"`).
|
|
1537
|
+
* Use the hint string format from {@link PROPERTY_HINT_TYPE_STRING} for more control over the stored types.
|
|
1538
|
+
*/
|
|
1539
|
+
PROPERTY_HINT_DICTIONARY_TYPE = 38,
|
|
1540
|
+
/**
|
|
1541
|
+
* Hints that a string property is a locale code. Editing it will show a locale dialog for picking language and country.
|
|
1542
|
+
*/
|
|
1543
|
+
PROPERTY_HINT_LOCALE_ID = 32,
|
|
1544
|
+
/**
|
|
1545
|
+
* Hints that a dictionary property is string translation map. Dictionary keys are locale codes and, values are translated strings.
|
|
1546
|
+
*/
|
|
1547
|
+
PROPERTY_HINT_LOCALIZABLE_STRING = 33,
|
|
1548
|
+
/**
|
|
1549
|
+
* Hints that a property is an instance of a {@link Node}-derived type, optionally specified via the hint string (e.g. `"Node2D"`). Editing it will show a dialog for picking a node from the scene.
|
|
1550
|
+
*/
|
|
1551
|
+
PROPERTY_HINT_NODE_TYPE = 34,
|
|
1552
|
+
/** Hints that a quaternion property should disable the temporary euler editor. */
|
|
1553
|
+
PROPERTY_HINT_HIDE_QUATERNION_EDIT = 35,
|
|
1554
|
+
/**
|
|
1555
|
+
* Hints that a string property is a password, and every character is replaced with the secret character.
|
|
1556
|
+
*/
|
|
1557
|
+
PROPERTY_HINT_PASSWORD = 36,
|
|
1558
|
+
/**
|
|
1559
|
+
* Hints that a {@link Callable} property should be displayed as a clickable button. When the button is pressed, the callable is called. The hint string specifies the button text and optionally an icon from the `"EditorIcons"` theme type.
|
|
1560
|
+
* [codeblock lang=text]
|
|
1561
|
+
* "Click me!" - A button with the text "Click me!" and the default "Callable" icon.
|
|
1562
|
+
* "Click me!,ColorRect" - A button with the text "Click me!" and the "ColorRect" icon.
|
|
1563
|
+
* [/codeblock]
|
|
1564
|
+
* **Note:** A {@link Callable} cannot be properly serialized and stored in a file, so it is recommended to use {@link PROPERTY_USAGE_EDITOR} instead of {@link PROPERTY_USAGE_DEFAULT}.
|
|
1565
|
+
*/
|
|
1566
|
+
PROPERTY_HINT_TOOL_BUTTON = 39,
|
|
1567
|
+
/**
|
|
1568
|
+
* Hints that a property will be changed on its own after setting, such as {@link AudioStreamPlayer.playing} or {@link GPUParticles3D.emitting}.
|
|
1569
|
+
*/
|
|
1570
|
+
PROPERTY_HINT_ONESHOT = 40,
|
|
1571
|
+
/**
|
|
1572
|
+
* Hints that a boolean property will enable the feature associated with the group that it occurs in. The property will be displayed as a checkbox on the group header. Only works within a group or subgroup.
|
|
1573
|
+
* By default, disabling the property hides all properties in the group. Use the optional hint string `"checkbox_only"` to disable this behavior.
|
|
1574
|
+
*/
|
|
1575
|
+
PROPERTY_HINT_GROUP_ENABLE = 42,
|
|
1576
|
+
/**
|
|
1577
|
+
* Hints that a {@link String} or {@link StringName} property is the name of an input action. This allows the selection of any action name from the Input Map in the Project Settings. The hint string may contain two options separated by commas:
|
|
1578
|
+
* - If it contains `"show_builtin"`, built-in input actions are included in the selection.
|
|
1579
|
+
* - If it contains `"loose_mode"`, loose mode is enabled. This allows inserting any action name even if it's not present in the input map.
|
|
1580
|
+
*/
|
|
1581
|
+
PROPERTY_HINT_INPUT_NAME = 43,
|
|
1582
|
+
/**
|
|
1583
|
+
* Like {@link PROPERTY_HINT_FILE}, but the property is stored as a raw path, not UID. That means the reference will be broken if you move the file. Consider using {@link PROPERTY_HINT_FILE} when possible.
|
|
1584
|
+
*/
|
|
1585
|
+
PROPERTY_HINT_FILE_PATH = 44,
|
|
1586
|
+
/** Represents the size of the {@link PropertyHint} enum. */
|
|
1587
|
+
PROPERTY_HINT_MAX = 45,
|
|
1588
|
+
}
|
|
1589
|
+
|
|
1590
|
+
declare const enum PropertyUsageFlags {
|
|
1591
|
+
/**
|
|
1592
|
+
* The property is not stored, and does not display in the editor. This is the default for non-exported properties.
|
|
1593
|
+
*/
|
|
1594
|
+
PROPERTY_USAGE_NONE = 0,
|
|
1595
|
+
/** The property is serialized and saved in the scene file (default for exported properties). */
|
|
1596
|
+
PROPERTY_USAGE_STORAGE = 2,
|
|
1597
|
+
/** The property is shown in the {@link EditorInspector} (default for exported properties). */
|
|
1598
|
+
PROPERTY_USAGE_EDITOR = 4,
|
|
1599
|
+
/** The property is excluded from the class reference. */
|
|
1600
|
+
PROPERTY_USAGE_INTERNAL = 8,
|
|
1601
|
+
/** The property can be checked in the {@link EditorInspector}. */
|
|
1602
|
+
PROPERTY_USAGE_CHECKABLE = 16,
|
|
1603
|
+
/** The property is checked in the {@link EditorInspector}. */
|
|
1604
|
+
PROPERTY_USAGE_CHECKED = 32,
|
|
1605
|
+
/** Used to group properties together in the editor. See {@link EditorInspector}. */
|
|
1606
|
+
PROPERTY_USAGE_GROUP = 64,
|
|
1607
|
+
/** Used to categorize properties together in the editor. */
|
|
1608
|
+
PROPERTY_USAGE_CATEGORY = 128,
|
|
1609
|
+
/**
|
|
1610
|
+
* Used to group properties together in the editor in a subgroup (under a group). See {@link EditorInspector}.
|
|
1611
|
+
*/
|
|
1612
|
+
PROPERTY_USAGE_SUBGROUP = 256,
|
|
1613
|
+
/** The property is a bitfield, i.e. it contains multiple flags represented as bits. */
|
|
1614
|
+
PROPERTY_USAGE_CLASS_IS_BITFIELD = 512,
|
|
1615
|
+
/** The property does not save its state in {@link PackedScene}. */
|
|
1616
|
+
PROPERTY_USAGE_NO_INSTANCE_STATE = 1024,
|
|
1617
|
+
/** Editing the property prompts the user for restarting the editor. */
|
|
1618
|
+
PROPERTY_USAGE_RESTART_IF_CHANGED = 2048,
|
|
1619
|
+
/**
|
|
1620
|
+
* The property is a script variable. {@link PROPERTY_USAGE_SCRIPT_VARIABLE} can be used to distinguish between exported script variables from built-in variables (which don't have this usage flag). By default, {@link PROPERTY_USAGE_SCRIPT_VARIABLE} is **not** applied to variables that are created by overriding {@link Object._get_property_list} in a script.
|
|
1621
|
+
*/
|
|
1622
|
+
PROPERTY_USAGE_SCRIPT_VARIABLE = 4096,
|
|
1623
|
+
/** The property value of type {@link Object} will be stored even if its value is `null`. */
|
|
1624
|
+
PROPERTY_USAGE_STORE_IF_NULL = 8192,
|
|
1625
|
+
/** If this property is modified, all inspector fields will be refreshed. */
|
|
1626
|
+
PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED = 16384,
|
|
1627
|
+
PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE = 32768,
|
|
1628
|
+
/**
|
|
1629
|
+
* The property is a variable of enum type, i.e. it only takes named integer constants from its associated enumeration.
|
|
1630
|
+
*/
|
|
1631
|
+
PROPERTY_USAGE_CLASS_IS_ENUM = 65536,
|
|
1632
|
+
/** If property has `nil` as default value, its type will be {@link Variant}. */
|
|
1633
|
+
PROPERTY_USAGE_NIL_IS_VARIANT = 131072,
|
|
1634
|
+
/**
|
|
1635
|
+
* The property is the element count of a property array, i.e. a list of groups of related properties. Properties defined with this usage also need a specific `class_name` field in the form of `label,prefix`. The field may also include additional comma-separated options:
|
|
1636
|
+
* - `page_size=N`: Overrides {@link EditorSettings.interface/inspector/max_array_dictionary_items_per_page} for this array.
|
|
1637
|
+
* - `add_button_text=text`: The text displayed by the "Add Element" button.
|
|
1638
|
+
* - `static`: The elements can't be re-arranged.
|
|
1639
|
+
* - `const`: New elements can't be added.
|
|
1640
|
+
* - `numbered`: An index will appear next to each element.
|
|
1641
|
+
* - `unfoldable`: The array can't be folded.
|
|
1642
|
+
* - `swap_method=method_name`: The method that will be called when two elements switch places. The method should take 2 [int] parameters, which will be indices of the elements being swapped.
|
|
1643
|
+
* Note that making a full-fledged property array requires boilerplate code involving {@link Object._get_property_list}.
|
|
1644
|
+
*/
|
|
1645
|
+
PROPERTY_USAGE_ARRAY = 262144,
|
|
1646
|
+
/**
|
|
1647
|
+
* When duplicating a resource with {@link Resource.duplicate}, and this flag is set on a property of that resource, the property should always be duplicated, regardless of the `subresources` bool parameter.
|
|
1648
|
+
*/
|
|
1649
|
+
PROPERTY_USAGE_ALWAYS_DUPLICATE = 524288,
|
|
1650
|
+
/**
|
|
1651
|
+
* When duplicating a resource with {@link Resource.duplicate}, and this flag is set on a property of that resource, the property should never be duplicated, regardless of the `subresources` bool parameter.
|
|
1652
|
+
*/
|
|
1653
|
+
PROPERTY_USAGE_NEVER_DUPLICATE = 1048576,
|
|
1654
|
+
/**
|
|
1655
|
+
* The property is only shown in the editor if modern renderers are supported (the Compatibility rendering method is excluded).
|
|
1656
|
+
*/
|
|
1657
|
+
PROPERTY_USAGE_HIGH_END_GFX = 2097152,
|
|
1658
|
+
/**
|
|
1659
|
+
* The {@link NodePath} property will always be relative to the scene's root. Mostly useful for local resources.
|
|
1660
|
+
*/
|
|
1661
|
+
PROPERTY_USAGE_NODE_PATH_FROM_SCENE_ROOT = 4194304,
|
|
1662
|
+
/**
|
|
1663
|
+
* Use when a resource is created on the fly, i.e. the getter will always return a different instance. {@link ResourceSaver} needs this information to properly save such resources.
|
|
1664
|
+
*/
|
|
1665
|
+
PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT = 8388608,
|
|
1666
|
+
/**
|
|
1667
|
+
* Inserting an animation key frame of this property will automatically increment the value, allowing to easily keyframe multiple values in a row.
|
|
1668
|
+
*/
|
|
1669
|
+
PROPERTY_USAGE_KEYING_INCREMENTS = 16777216,
|
|
1670
|
+
PROPERTY_USAGE_DEFERRED_SET_RESOURCE = 33554432,
|
|
1671
|
+
/**
|
|
1672
|
+
* When this property is a {@link Resource} and base object is a {@link Node}, a resource instance will be automatically created whenever the node is created in the editor.
|
|
1673
|
+
*/
|
|
1674
|
+
PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT = 67108864,
|
|
1675
|
+
/**
|
|
1676
|
+
* The property is considered a basic setting and will appear even when advanced mode is disabled. Used for project settings.
|
|
1677
|
+
*/
|
|
1678
|
+
PROPERTY_USAGE_EDITOR_BASIC_SETTING = 134217728,
|
|
1679
|
+
/** The property is read-only in the {@link EditorInspector}. */
|
|
1680
|
+
PROPERTY_USAGE_READ_ONLY = 268435456,
|
|
1681
|
+
/**
|
|
1682
|
+
* An export preset property with this flag contains confidential information and is stored separately from the rest of the export preset configuration.
|
|
1683
|
+
*/
|
|
1684
|
+
PROPERTY_USAGE_SECRET = 536870912,
|
|
1685
|
+
/** Default usage (storage and editor). */
|
|
1686
|
+
PROPERTY_USAGE_DEFAULT = 6,
|
|
1687
|
+
/** Default usage but without showing the property in the editor (storage). */
|
|
1688
|
+
PROPERTY_USAGE_NO_EDITOR = 2,
|
|
1689
|
+
}
|
|
1690
|
+
|
|
1691
|
+
declare const enum MethodFlags {
|
|
1692
|
+
/** Flag for a normal method. */
|
|
1693
|
+
METHOD_FLAG_NORMAL = 1,
|
|
1694
|
+
/** Flag for an editor method. */
|
|
1695
|
+
METHOD_FLAG_EDITOR = 2,
|
|
1696
|
+
/** Flag for a constant method. */
|
|
1697
|
+
METHOD_FLAG_CONST = 4,
|
|
1698
|
+
/** Flag for a virtual method. */
|
|
1699
|
+
METHOD_FLAG_VIRTUAL = 8,
|
|
1700
|
+
/** Flag for a method with a variable number of arguments. */
|
|
1701
|
+
METHOD_FLAG_VARARG = 16,
|
|
1702
|
+
/** Flag for a static method. */
|
|
1703
|
+
METHOD_FLAG_STATIC = 32,
|
|
1704
|
+
/**
|
|
1705
|
+
* Used internally. Allows to not dump core virtual methods (such as {@link Object._notification}) to the JSON API.
|
|
1706
|
+
*/
|
|
1707
|
+
METHOD_FLAG_OBJECT_CORE = 64,
|
|
1708
|
+
/** Flag for a virtual method that is required. In GDScript, this flag is set for abstract functions. */
|
|
1709
|
+
METHOD_FLAG_VIRTUAL_REQUIRED = 128,
|
|
1710
|
+
/** Default method flags (normal). */
|
|
1711
|
+
METHOD_FLAGS_DEFAULT = 1,
|
|
1712
|
+
}
|
|
1713
|
+
|
|
1714
|
+
declare const enum Variant_Type {
|
|
1715
|
+
/** Variable is `null`. */
|
|
1716
|
+
TYPE_NIL = 0,
|
|
1717
|
+
/** Variable is of type [bool]. */
|
|
1718
|
+
TYPE_BOOL = 1,
|
|
1719
|
+
/** Variable is of type [int]. */
|
|
1720
|
+
TYPE_INT = 2,
|
|
1721
|
+
/** Variable is of type [float]. */
|
|
1722
|
+
TYPE_FLOAT = 3,
|
|
1723
|
+
/** Variable is of type {@link String}. */
|
|
1724
|
+
TYPE_STRING = 4,
|
|
1725
|
+
/** Variable is of type {@link Vector2}. */
|
|
1726
|
+
TYPE_VECTOR2 = 5,
|
|
1727
|
+
/** Variable is of type {@link Vector2i}. */
|
|
1728
|
+
TYPE_VECTOR2I = 6,
|
|
1729
|
+
/** Variable is of type {@link Rect2}. */
|
|
1730
|
+
TYPE_RECT2 = 7,
|
|
1731
|
+
/** Variable is of type {@link Rect2i}. */
|
|
1732
|
+
TYPE_RECT2I = 8,
|
|
1733
|
+
/** Variable is of type {@link Vector3}. */
|
|
1734
|
+
TYPE_VECTOR3 = 9,
|
|
1735
|
+
/** Variable is of type {@link Vector3i}. */
|
|
1736
|
+
TYPE_VECTOR3I = 10,
|
|
1737
|
+
/** Variable is of type {@link Transform2D}. */
|
|
1738
|
+
TYPE_TRANSFORM2D = 11,
|
|
1739
|
+
/** Variable is of type {@link Vector4}. */
|
|
1740
|
+
TYPE_VECTOR4 = 12,
|
|
1741
|
+
/** Variable is of type {@link Vector4i}. */
|
|
1742
|
+
TYPE_VECTOR4I = 13,
|
|
1743
|
+
/** Variable is of type {@link Plane}. */
|
|
1744
|
+
TYPE_PLANE = 14,
|
|
1745
|
+
/** Variable is of type {@link Quaternion}. */
|
|
1746
|
+
TYPE_QUATERNION = 15,
|
|
1747
|
+
/** Variable is of type {@link AABB}. */
|
|
1748
|
+
TYPE_AABB = 16,
|
|
1749
|
+
/** Variable is of type {@link Basis}. */
|
|
1750
|
+
TYPE_BASIS = 17,
|
|
1751
|
+
/** Variable is of type {@link Transform3D}. */
|
|
1752
|
+
TYPE_TRANSFORM3D = 18,
|
|
1753
|
+
/** Variable is of type {@link Projection}. */
|
|
1754
|
+
TYPE_PROJECTION = 19,
|
|
1755
|
+
/** Variable is of type {@link Color}. */
|
|
1756
|
+
TYPE_COLOR = 20,
|
|
1757
|
+
/** Variable is of type {@link StringName}. */
|
|
1758
|
+
TYPE_STRING_NAME = 21,
|
|
1759
|
+
/** Variable is of type {@link NodePath}. */
|
|
1760
|
+
TYPE_NODE_PATH = 22,
|
|
1761
|
+
/** Variable is of type {@link RID}. */
|
|
1762
|
+
TYPE_RID = 23,
|
|
1763
|
+
/** Variable is of type {@link Object}. */
|
|
1764
|
+
TYPE_OBJECT = 24,
|
|
1765
|
+
/** Variable is of type {@link Callable}. */
|
|
1766
|
+
TYPE_CALLABLE = 25,
|
|
1767
|
+
/** Variable is of type {@link Signal}. */
|
|
1768
|
+
TYPE_SIGNAL = 26,
|
|
1769
|
+
/** Variable is of type {@link Dictionary}. */
|
|
1770
|
+
TYPE_DICTIONARY = 27,
|
|
1771
|
+
/** Variable is of type {@link Array}. */
|
|
1772
|
+
TYPE_ARRAY = 28,
|
|
1773
|
+
/** Variable is of type {@link PackedByteArray}. */
|
|
1774
|
+
TYPE_PACKED_BYTE_ARRAY = 29,
|
|
1775
|
+
/** Variable is of type {@link PackedInt32Array}. */
|
|
1776
|
+
TYPE_PACKED_INT32_ARRAY = 30,
|
|
1777
|
+
/** Variable is of type {@link PackedInt64Array}. */
|
|
1778
|
+
TYPE_PACKED_INT64_ARRAY = 31,
|
|
1779
|
+
/** Variable is of type {@link PackedFloat32Array}. */
|
|
1780
|
+
TYPE_PACKED_FLOAT32_ARRAY = 32,
|
|
1781
|
+
/** Variable is of type {@link PackedFloat64Array}. */
|
|
1782
|
+
TYPE_PACKED_FLOAT64_ARRAY = 33,
|
|
1783
|
+
/** Variable is of type {@link PackedStringArray}. */
|
|
1784
|
+
TYPE_PACKED_STRING_ARRAY = 34,
|
|
1785
|
+
/** Variable is of type {@link PackedVector2Array}. */
|
|
1786
|
+
TYPE_PACKED_VECTOR2_ARRAY = 35,
|
|
1787
|
+
/** Variable is of type {@link PackedVector3Array}. */
|
|
1788
|
+
TYPE_PACKED_VECTOR3_ARRAY = 36,
|
|
1789
|
+
/** Variable is of type {@link PackedColorArray}. */
|
|
1790
|
+
TYPE_PACKED_COLOR_ARRAY = 37,
|
|
1791
|
+
/** Variable is of type {@link PackedVector4Array}. */
|
|
1792
|
+
TYPE_PACKED_VECTOR4_ARRAY = 38,
|
|
1793
|
+
/** Represents the size of the {@link Variant.Type} enum. */
|
|
1794
|
+
TYPE_MAX = 39,
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
declare const enum Variant_Operator {
|
|
1798
|
+
/** Equality operator (`==`). */
|
|
1799
|
+
OP_EQUAL = 0,
|
|
1800
|
+
/** Inequality operator (`!=`). */
|
|
1801
|
+
OP_NOT_EQUAL = 1,
|
|
1802
|
+
/** Less than operator (`<`). */
|
|
1803
|
+
OP_LESS = 2,
|
|
1804
|
+
/** Less than or equal operator (`<=`). */
|
|
1805
|
+
OP_LESS_EQUAL = 3,
|
|
1806
|
+
/** Greater than operator (`>`). */
|
|
1807
|
+
OP_GREATER = 4,
|
|
1808
|
+
/** Greater than or equal operator (`>=`). */
|
|
1809
|
+
OP_GREATER_EQUAL = 5,
|
|
1810
|
+
/** Addition operator (`+`). */
|
|
1811
|
+
OP_ADD = 6,
|
|
1812
|
+
/** Subtraction operator (`-`). */
|
|
1813
|
+
OP_SUBTRACT = 7,
|
|
1814
|
+
/** Multiplication operator (`*`). */
|
|
1815
|
+
OP_MULTIPLY = 8,
|
|
1816
|
+
/** Division operator (`/`). */
|
|
1817
|
+
OP_DIVIDE = 9,
|
|
1818
|
+
/** Unary negation operator (`-`). */
|
|
1819
|
+
OP_NEGATE = 10,
|
|
1820
|
+
/** Unary plus operator (`+`). */
|
|
1821
|
+
OP_POSITIVE = 11,
|
|
1822
|
+
/** Remainder/modulo operator (`%`). */
|
|
1823
|
+
OP_MODULE = 12,
|
|
1824
|
+
/** Power operator (`**`). */
|
|
1825
|
+
OP_POWER = 13,
|
|
1826
|
+
/** Left shift operator (`<<`). */
|
|
1827
|
+
OP_SHIFT_LEFT = 14,
|
|
1828
|
+
/** Right shift operator (`>>`). */
|
|
1829
|
+
OP_SHIFT_RIGHT = 15,
|
|
1830
|
+
/** Bitwise AND operator (`&`). */
|
|
1831
|
+
OP_BIT_AND = 16,
|
|
1832
|
+
/** Bitwise OR operator (`|`). */
|
|
1833
|
+
OP_BIT_OR = 17,
|
|
1834
|
+
/** Bitwise XOR operator (`^`). */
|
|
1835
|
+
OP_BIT_XOR = 18,
|
|
1836
|
+
/** Bitwise NOT operator (`~`). */
|
|
1837
|
+
OP_BIT_NEGATE = 19,
|
|
1838
|
+
/** Logical AND operator (`and` or `&&`). */
|
|
1839
|
+
OP_AND = 20,
|
|
1840
|
+
/** Logical OR operator (`or` or `||`). */
|
|
1841
|
+
OP_OR = 21,
|
|
1842
|
+
/** Logical XOR operator (not implemented in GDScript). */
|
|
1843
|
+
OP_XOR = 22,
|
|
1844
|
+
/** Logical NOT operator (`not` or `!`). */
|
|
1845
|
+
OP_NOT = 23,
|
|
1846
|
+
/** Logical IN operator (`in`). */
|
|
1847
|
+
OP_IN = 24,
|
|
1848
|
+
/** Represents the size of the {@link Variant.Operator} enum. */
|
|
1849
|
+
OP_MAX = 25,
|
|
1850
|
+
}
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
/** Maximum value of an 8-bit unsigned integer. */
|
|
1854
|
+
declare const UINT8_MAX: int;
|
|
1855
|
+
/** Maximum value of a 16-bit unsigned integer. */
|
|
1856
|
+
declare const UINT16_MAX: int;
|
|
1857
|
+
/** Maximum value of a 32-bit unsigned integer. */
|
|
1858
|
+
declare const UINT32_MAX: int;
|
|
1859
|
+
/** Minimum value of an 8-bit signed integer. */
|
|
1860
|
+
declare const INT8_MIN: int;
|
|
1861
|
+
/** Maximum value of an 8-bit signed integer. */
|
|
1862
|
+
declare const INT8_MAX: int;
|
|
1863
|
+
/** Minimum value of a 16-bit signed integer. */
|
|
1864
|
+
declare const INT16_MIN: int;
|
|
1865
|
+
/** Maximum value of a 16-bit signed integer. */
|
|
1866
|
+
declare const INT16_MAX: int;
|
|
1867
|
+
/** Minimum value of a 32-bit signed integer. */
|
|
1868
|
+
declare const INT32_MIN: int;
|
|
1869
|
+
/** Maximum value of a 32-bit signed integer. */
|
|
1870
|
+
declare const INT32_MAX: int;
|
|
1871
|
+
/** Minimum value of a 64-bit signed integer. */
|
|
1872
|
+
declare const INT64_MIN: int;
|
|
1873
|
+
/** Maximum value of a 64-bit signed integer. */
|
|
1874
|
+
declare const INT64_MAX: int;
|
|
1875
|
+
// @GDScript — built-in constants, functions, and annotations
|
|
1876
|
+
|
|
1877
|
+
/**
|
|
1878
|
+
* Constant that represents how many times the diameter of a circle fits around its perimeter. This is equivalent to `TAU / 2`, or 180 degrees in rotations.
|
|
1879
|
+
*/
|
|
1880
|
+
declare const PI: float;
|
|
1881
|
+
/**
|
|
1882
|
+
* The circle constant, the circumference of the unit circle in radians. This is equivalent to `PI * 2`, or 360 degrees in rotations.
|
|
1883
|
+
*/
|
|
1884
|
+
declare const TAU: float;
|
|
1885
|
+
/**
|
|
1886
|
+
* Positive floating-point infinity. This is the result of floating-point division when the divisor is `0.0`. For negative infinity, use `-INF`. Dividing by `-0.0` will result in negative infinity if the numerator is positive, so dividing by `0.0` is not the same as dividing by `-0.0` (despite `0.0 == -0.0` returning `true`).
|
|
1887
|
+
* **Warning:** Numeric infinity is only a concept with floating-point numbers, and has no equivalent for integers. Dividing an integer number by `0` will not result in {@link INF} and will result in a run-time error instead.
|
|
1888
|
+
*/
|
|
1889
|
+
declare const INF: float;
|
|
1890
|
+
/**
|
|
1891
|
+
* "Not a Number", an invalid floating-point value. It is returned by some invalid operations, such as dividing floating-point `0.0` by `0.0`.
|
|
1892
|
+
* {@link NAN} has special properties, including that `!=` always returns `true`, while other comparison operators always return `false`. This is true even when comparing with itself (`NAN == NAN` returns `false` and `NAN != NAN` returns `true`). Due to this, you must use {@link @GlobalScope.is_nan} to check whether a number is equal to {@link NAN}.
|
|
1893
|
+
* **Warning:** "Not a Number" is only a concept with floating-point numbers, and has no equivalent for integers. Dividing an integer `0` by `0` will not result in {@link NAN} and will result in a run-time error instead.
|
|
1894
|
+
*/
|
|
1895
|
+
declare const NAN: float;
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* Returns a {@link Color} constructed from red (`r8`), green (`g8`), blue (`b8`), and optionally alpha (`a8`) integer channels, each divided by `255.0` for their final value. Using {@link Color8} instead of the standard {@link Color} constructor is useful when you need to match exact color values in an {@link Image}.
|
|
1899
|
+
* **Note:** Due to the lower precision of {@link Color8} compared to the standard {@link Color} constructor, a color created with {@link Color8} will generally not be equal to the same color created with the standard {@link Color} constructor. Use {@link Color.is_equal_approx} for comparisons to avoid issues with floating-point precision error.
|
|
1900
|
+
*/
|
|
1901
|
+
declare function Color8(r8: int, g8: int, b8: int, a8?: int): Color;
|
|
1902
|
+
/**
|
|
1903
|
+
* Asserts that the `condition` is `true`. If the `condition` is `false`, an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of {@link @GlobalScope.push_error} for reporting errors to project developers or add-on users.
|
|
1904
|
+
* An optional `message` can be shown in addition to the generic "Assertion failed" message. You can use this to provide additional details about why the assertion failed.
|
|
1905
|
+
* **Warning:** For performance reasons, the code inside {@link assert} is only executed in debug builds or when running the project from the editor. Don't include code that has side effects in an {@link assert} call. Otherwise, the project will behave differently when exported in release mode.
|
|
1906
|
+
* **Note:** {@link assert} is a keyword, not a function. So you cannot access it as a {@link Callable} or use it inside expressions.
|
|
1907
|
+
*/
|
|
1908
|
+
declare function assert(condition: boolean, message?: string): void;
|
|
1909
|
+
/**
|
|
1910
|
+
* Returns a single character (as a {@link String} of length 1) of the given Unicode code point `code`.
|
|
1911
|
+
* This is the inverse of {@link ord}. See also {@link String.chr} and {@link String.unicode_at}.
|
|
1912
|
+
*/
|
|
1913
|
+
declare function char(code: int): string;
|
|
1914
|
+
/**
|
|
1915
|
+
* Converts `what` to `type` in the best way possible. The `type` uses the {@link Variant.Type} values.
|
|
1916
|
+
*/
|
|
1917
|
+
declare function convert(what: unknown, type_: int): unknown;
|
|
1918
|
+
/**
|
|
1919
|
+
* Converts a `dictionary` (created with {@link inst_to_dict}) back to an Object instance. Can be useful for deserializing.
|
|
1920
|
+
*/
|
|
1921
|
+
declare function dict_to_inst(dictionary: Dictionary): GodotObject;
|
|
1922
|
+
/**
|
|
1923
|
+
* Returns an array of dictionaries representing the current call stack.
|
|
1924
|
+
* Starting from `_ready()`, `bar()` would print:
|
|
1925
|
+
* [codeblock lang=text]
|
|
1926
|
+
* [{function:bar, line:12, source:res://script.gd}, {function:foo, line:9, source:res://script.gd}, {function:_ready, line:6, source:res://script.gd}]
|
|
1927
|
+
* [/codeblock]
|
|
1928
|
+
* See also {@link print_debug}, {@link print_stack}, and {@link Engine.capture_script_backtraces}.
|
|
1929
|
+
* **Note:** By default, backtraces are only available in editor builds and debug builds. To enable them for release builds as well, you need to enable {@link ProjectSettings.debug/settings/gdscript/always_track_call_stacks}.
|
|
1930
|
+
*/
|
|
1931
|
+
declare function get_stack(): Array<unknown>;
|
|
1932
|
+
/**
|
|
1933
|
+
* Returns the passed `instance` converted to a {@link Dictionary}. Can be useful for serializing.
|
|
1934
|
+
* Prints out:
|
|
1935
|
+
* [codeblock lang=text]
|
|
1936
|
+
* [@subpath, @path, foo]
|
|
1937
|
+
* [, res://test.gd, bar]
|
|
1938
|
+
* [/codeblock]
|
|
1939
|
+
* **Note:** This function can only be used to serialize objects with an attached {@link GDScript} stored in a separate file. Objects without an attached script, with a script written in another language, or with a built-in script are not supported.
|
|
1940
|
+
* **Note:** This function is not recursive, which means that nested objects will not be represented as dictionaries. Also, properties passed by reference ({@link Object}, {@link Dictionary}, {@link Array}, and packed arrays) are copied by reference, not duplicated.
|
|
1941
|
+
*/
|
|
1942
|
+
declare function inst_to_dict(instance: GodotObject): Dictionary;
|
|
1943
|
+
/**
|
|
1944
|
+
* Returns `true` if `value` is an instance of `type`. The `type` value must be one of the following:
|
|
1945
|
+
* - A constant from the {@link Variant.Type} enumeration, for example {@link TYPE_INT}.
|
|
1946
|
+
* - An {@link Object}-derived class which exists in {@link ClassDB}, for example {@link Node}.
|
|
1947
|
+
* - A {@link Script} (you can use any class, including inner one).
|
|
1948
|
+
* Unlike the right operand of the `is` operator, `type` can be a non-constant value. The `is` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need to check the type dynamically.
|
|
1949
|
+
* **Examples:**
|
|
1950
|
+
* **Note:** If `value` and/or `type` are freed objects (see {@link @GlobalScope.is_instance_valid}), or `type` is not one of the above options, this method will raise a runtime error.
|
|
1951
|
+
* See also {@link @GlobalScope.typeof}, {@link type_exists}, {@link Array.is_same_typed} (and other {@link Array} methods).
|
|
1952
|
+
*/
|
|
1953
|
+
declare function is_instance_of(value: unknown, type_: unknown): boolean;
|
|
1954
|
+
/**
|
|
1955
|
+
* Returns the length of the given Variant `var`. The length can be the character count of a {@link String} or {@link StringName}, the element count of any array type, or the size of a {@link Dictionary}. For every other Variant type, a run-time error is generated and execution is stopped.
|
|
1956
|
+
*/
|
|
1957
|
+
declare function len(var_: unknown): int;
|
|
1958
|
+
/**
|
|
1959
|
+
* Returns a {@link Resource} from the filesystem located at the absolute `path`. Unless it's already referenced elsewhere (such as in another script or in the scene), the resource is loaded from disk on function call, which might cause a slight delay, especially when loading large scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use {@link preload}. This method is equivalent of using {@link ResourceLoader.load} with {@link ResourceLoader.CACHE_MODE_REUSE}.
|
|
1960
|
+
* **Note:** Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing "Copy Path", or by dragging the file from the FileSystem dock into the current script.
|
|
1961
|
+
* **Important:** Relative paths are *not* relative to the script calling this method, instead it is prefixed with `"res://"`. Loading from relative paths might not work as expected.
|
|
1962
|
+
* This function is a simplified version of {@link ResourceLoader.load}, which can be used for more advanced scenarios.
|
|
1963
|
+
* **Note:** Files have to be imported into the engine first to load them using this function. If you want to load {@link Image}s at run-time, you may use {@link Image.load}. If you want to import audio files, you can use the snippet described in {@link AudioStreamMP3.data}.
|
|
1964
|
+
* **Note:** If {@link ProjectSettings.editor/export/convert_text_resources_to_binary} is `true`, {@link @GDScript.load} will not be able to read converted files in an exported project. If you rely on run-time loading of files present within the PCK, set {@link ProjectSettings.editor/export/convert_text_resources_to_binary} to `false`.
|
|
1965
|
+
*/
|
|
1966
|
+
declare function load<P extends keyof GodotResources>(path: P): GodotResources[P];
|
|
1967
|
+
declare function load<T extends Resource = Resource>(path: string): T;
|
|
1968
|
+
/**
|
|
1969
|
+
* Returns an integer representing the Unicode code point of the given character `char`, which should be a string of length 1.
|
|
1970
|
+
* This is the inverse of {@link char}. See also {@link String.chr} and {@link String.unicode_at}.
|
|
1971
|
+
*/
|
|
1972
|
+
declare function ord(char: string): int;
|
|
1973
|
+
/**
|
|
1974
|
+
* Returns a {@link Resource} from the filesystem located at `path`. During run-time, the resource is loaded when the script is being parsed. This function effectively acts as a reference to that resource. Note that this function requires `path` to be a constant {@link String}. If you want to load a resource from a dynamic/variable path, use {@link load}.
|
|
1975
|
+
* **Note:** Resource paths can be obtained by right-clicking on a resource in the Assets Panel and choosing "Copy Path", or by dragging the file from the FileSystem dock into the current script.
|
|
1976
|
+
* **Note:** {@link preload} is a keyword, not a function. So you cannot access it as a {@link Callable}.
|
|
1977
|
+
*/
|
|
1978
|
+
declare function preload<P extends keyof GodotResources>(path: P): GodotResources[P];
|
|
1979
|
+
declare function preload<T extends Resource = Resource>(path: string): T;
|
|
1980
|
+
/**
|
|
1981
|
+
* Like {@link @GlobalScope.print}, but includes the current stack frame when running with the debugger turned on.
|
|
1982
|
+
* The output in the console may look like the following:
|
|
1983
|
+
* [codeblock lang=text]
|
|
1984
|
+
* Test print
|
|
1985
|
+
* At: res://test.gd:15:_process()
|
|
1986
|
+
* [/codeblock]
|
|
1987
|
+
* See also {@link print_stack}, {@link get_stack}, and {@link Engine.capture_script_backtraces}.
|
|
1988
|
+
* **Note:** By default, backtraces are only available in editor builds and debug builds. To enable them for release builds as well, you need to enable {@link ProjectSettings.debug/settings/gdscript/always_track_call_stacks}.
|
|
1989
|
+
*/
|
|
1990
|
+
declare function print_debug(...args: any[]): void;
|
|
1991
|
+
/**
|
|
1992
|
+
* Prints a stack trace at the current code location.
|
|
1993
|
+
* The output in the console may look like the following:
|
|
1994
|
+
* [codeblock lang=text]
|
|
1995
|
+
* Frame 0 - res://test.gd:16 in function '_process'
|
|
1996
|
+
* [/codeblock]
|
|
1997
|
+
* See also {@link print_debug}, {@link get_stack}, and {@link Engine.capture_script_backtraces}.
|
|
1998
|
+
* **Note:** By default, backtraces are only available in editor builds and debug builds. To enable them for release builds as well, you need to enable {@link ProjectSettings.debug/settings/gdscript/always_track_call_stacks}.
|
|
1999
|
+
*/
|
|
2000
|
+
declare function print_stack(): void;
|
|
2001
|
+
/**
|
|
2002
|
+
* Returns an array with the given range. {@link range} can be called in three ways:
|
|
2003
|
+
* `range(n: int)`: Starts from 0, increases by steps of 1, and stops *before* `n`. The argument `n` is **exclusive**.
|
|
2004
|
+
* `range(b: int, n: int)`: Starts from `b`, increases by steps of 1, and stops *before* `n`. The arguments `b` and `n` are **inclusive** and **exclusive**, respectively.
|
|
2005
|
+
* `range(b: int, n: int, s: int)`: Starts from `b`, increases/decreases by steps of `s`, and stops *before* `n`. The arguments `b` and `n` are **inclusive** and **exclusive**, respectively. The argument `s` **can** be negative, but not `0`. If `s` is `0`, an error message is printed.
|
|
2006
|
+
* {@link range} converts all arguments to [int] before processing.
|
|
2007
|
+
* **Note:** Returns an empty array if no value meets the value constraint (e.g. `range(2, 5, -1)` or `range(5, 5, 1)`).
|
|
2008
|
+
* **Examples:**
|
|
2009
|
+
* To iterate over an {@link Array} backwards, use:
|
|
2010
|
+
* Output:
|
|
2011
|
+
* [codeblock lang=text]
|
|
2012
|
+
* 9
|
|
2013
|
+
* 6
|
|
2014
|
+
* 3
|
|
2015
|
+
* [/codeblock]
|
|
2016
|
+
* To iterate over [float], convert them in the loop.
|
|
2017
|
+
* Output:
|
|
2018
|
+
* [codeblock lang=text]
|
|
2019
|
+
* 0.3
|
|
2020
|
+
* 0.2
|
|
2021
|
+
* 0.1
|
|
2022
|
+
* [/codeblock]
|
|
2023
|
+
*/
|
|
2024
|
+
declare function range(end: int): Array<int>;
|
|
2025
|
+
declare function range(begin: int, end: int): Array<int>;
|
|
2026
|
+
declare function range(begin: int, end: int, step: int): Array<int>;
|
|
2027
|
+
/**
|
|
2028
|
+
* Returns `true` if the given {@link Object}-derived class exists in {@link ClassDB}. Note that {@link Variant} data types are not registered in {@link ClassDB}.
|
|
2029
|
+
*/
|
|
2030
|
+
declare function type_exists(type_: string): boolean;
|
|
2031
|
+
|
|
2032
|
+
// GDScript annotations as TypeScript decorators
|
|
2033
|
+
/**
|
|
2034
|
+
* Marks a class or a method as abstract.
|
|
2035
|
+
* An abstract class is a class that cannot be instantiated directly. Instead, it is meant to be inherited by other classes. Attempting to instantiate an abstract class will result in an error.
|
|
2036
|
+
* An abstract method is a method that has no implementation. Therefore, a newline or a semicolon is expected after the function header. This defines a contract that inheriting classes must conform to, because the method signature must be compatible when overriding.
|
|
2037
|
+
* Inheriting classes must either provide implementations for all abstract methods, or the inheriting class must be marked as abstract. If a class has at least one abstract method (either its own or an unimplemented inherited one), then it must also be marked as abstract. However, the reverse is not true: an abstract class is allowed to have no abstract methods.
|
|
2038
|
+
*/
|
|
2039
|
+
declare function abstract(target: any, context: any): void;
|
|
2040
|
+
/**
|
|
2041
|
+
* Mark the following property as exported (editable in the Inspector dock and saved to disk). To control the type of the exported property, use the type hint notation.
|
|
2042
|
+
* **Note:** Custom resources and nodes should be registered as global classes using `class_name`, since the Inspector currently only supports global classes. Otherwise, a less specific type will be exported instead.
|
|
2043
|
+
* **Note:** Node export is only supported in {@link Node}-derived classes and has a number of other limitations.
|
|
2044
|
+
*/
|
|
2045
|
+
declare function exports(target: any, context: any): void;
|
|
2046
|
+
/**
|
|
2047
|
+
* Define a new category for the following exported properties. This helps to organize properties in the Inspector dock.
|
|
2048
|
+
* See also {@link PROPERTY_USAGE_CATEGORY}.
|
|
2049
|
+
* **Note:** Categories in the Inspector dock's list usually divide properties coming from different classes (Node, Node2D, Sprite, etc.). For better clarity, it's recommended to use and , instead.
|
|
2050
|
+
*/
|
|
2051
|
+
declare function export_category(name: string): (target: any, context: any) => void;
|
|
2052
|
+
/**
|
|
2053
|
+
* Export a {@link Color}, {@link Array}[lb]{@link Color}[rb], or {@link PackedColorArray} property without allowing its transparency ({@link Color.a}) to be edited.
|
|
2054
|
+
* See also {@link PROPERTY_HINT_COLOR_NO_ALPHA}.
|
|
2055
|
+
*/
|
|
2056
|
+
declare function export_color_no_alpha(target: any, context: any): void;
|
|
2057
|
+
/**
|
|
2058
|
+
* Allows you to set a custom hint, hint string, and usage flags for the exported property. Note that there's no validation done in GDScript, it will just pass the parameters to the editor.
|
|
2059
|
+
* **Note:** Regardless of the `usage` value, the {@link PROPERTY_USAGE_SCRIPT_VARIABLE} flag is always added, as with any explicitly declared script variable.
|
|
2060
|
+
*/
|
|
2061
|
+
declare function export_custom(hint: int, hint_string: string, usage: int): (target: any, context: any) => void;
|
|
2062
|
+
/**
|
|
2063
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], or {@link PackedStringArray} property as a path to a directory. The path will be limited to the project folder and its subfolders. See to allow picking from the entire filesystem.
|
|
2064
|
+
* See also {@link PROPERTY_HINT_DIR}.
|
|
2065
|
+
*/
|
|
2066
|
+
declare function export_dir(target: any, context: any): void;
|
|
2067
|
+
/**
|
|
2068
|
+
* Export an [int], {@link String}, {@link Array}[lb][int][rb], {@link Array}[lb]{@link String}[rb], {@link PackedByteArray}, {@link PackedInt32Array}, {@link PackedInt64Array}, or {@link PackedStringArray} property as an enumerated list of options (or an array of options). If the property is an [int], then the index of the value is stored, in the same order the values are provided. You can add explicit values using a colon. If the property is a {@link String}, then the value is stored.
|
|
2069
|
+
* See also {@link PROPERTY_HINT_ENUM}.
|
|
2070
|
+
* If you want to set an initial value, you must specify it explicitly:
|
|
2071
|
+
* If you want to use named GDScript enums, then use instead:
|
|
2072
|
+
*/
|
|
2073
|
+
declare function export_enum(names: string, ...args: any[]): (target: any, context: any) => void;
|
|
2074
|
+
/**
|
|
2075
|
+
* Export a floating-point property with an easing editor widget. Additional hints can be provided to adjust the behavior of the widget. `"attenuation"` flips the curve, which makes it more intuitive for editing attenuation properties. `"positive_only"` limits values to only be greater than or equal to zero.
|
|
2076
|
+
* See also {@link PROPERTY_HINT_EXP_EASING}.
|
|
2077
|
+
*/
|
|
2078
|
+
declare function export_exp_easing(hints?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2079
|
+
/**
|
|
2080
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], or {@link PackedStringArray} property as a path to a file. The path will be limited to the project folder and its subfolders. See to allow picking from the entire filesystem.
|
|
2081
|
+
* If `filter` is provided, only matching files will be available for picking.
|
|
2082
|
+
* See also {@link PROPERTY_HINT_FILE}.
|
|
2083
|
+
* **Note:** The file will be stored and referenced as UID, if available. This ensures that the reference is valid even when the file is moved. You can use {@link ResourceUID} methods to convert it to path.
|
|
2084
|
+
*/
|
|
2085
|
+
declare function export_file(filter?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2086
|
+
/**
|
|
2087
|
+
* Same as , except the file will be stored as a raw path. This means that it may become invalid when the file is moved. If you are exporting a {@link Resource} path, consider using instead.
|
|
2088
|
+
*/
|
|
2089
|
+
declare function export_file_path(filter?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2090
|
+
/**
|
|
2091
|
+
* Export an integer property as a bit flag field. This allows to store several "checked" or `true` values with one property, and comfortably select them from the Inspector dock.
|
|
2092
|
+
* See also {@link PROPERTY_HINT_FLAGS}.
|
|
2093
|
+
* You can add explicit values using a colon:
|
|
2094
|
+
* You can also combine several flags:
|
|
2095
|
+
* **Note:** A flag value must be at least `1` and at most `2 ** 32 - 1`.
|
|
2096
|
+
* **Note:** Unlike , the previous explicit value is not taken into account. In the following example, A is 16, B is 2, C is 4.
|
|
2097
|
+
* You can also use the annotation on {@link Array}[lb][int][rb], {@link PackedByteArray}, {@link PackedInt32Array}, and {@link PackedInt64Array}
|
|
2098
|
+
*/
|
|
2099
|
+
declare function export_flags(names: string, ...args: any[]): (target: any, context: any) => void;
|
|
2100
|
+
/**
|
|
2101
|
+
* Export an integer property as a bit flag field for 2D navigation layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/2d_navigation/layer_1}.
|
|
2102
|
+
* See also {@link PROPERTY_HINT_LAYERS_2D_NAVIGATION}.
|
|
2103
|
+
*/
|
|
2104
|
+
declare function export_flags_2d_navigation(target: any, context: any): void;
|
|
2105
|
+
/**
|
|
2106
|
+
* Export an integer property as a bit flag field for 2D physics layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/2d_physics/layer_1}.
|
|
2107
|
+
* See also {@link PROPERTY_HINT_LAYERS_2D_PHYSICS}.
|
|
2108
|
+
*/
|
|
2109
|
+
declare function export_flags_2d_physics(target: any, context: any): void;
|
|
2110
|
+
/**
|
|
2111
|
+
* Export an integer property as a bit flag field for 2D render layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/2d_render/layer_1}.
|
|
2112
|
+
* See also {@link PROPERTY_HINT_LAYERS_2D_RENDER}.
|
|
2113
|
+
*/
|
|
2114
|
+
declare function export_flags_2d_render(target: any, context: any): void;
|
|
2115
|
+
/**
|
|
2116
|
+
* Export an integer property as a bit flag field for 3D navigation layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/3d_navigation/layer_1}.
|
|
2117
|
+
* See also {@link PROPERTY_HINT_LAYERS_3D_NAVIGATION}.
|
|
2118
|
+
*/
|
|
2119
|
+
declare function export_flags_3d_navigation(target: any, context: any): void;
|
|
2120
|
+
/**
|
|
2121
|
+
* Export an integer property as a bit flag field for 3D physics layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/3d_physics/layer_1}.
|
|
2122
|
+
* See also {@link PROPERTY_HINT_LAYERS_3D_PHYSICS}.
|
|
2123
|
+
*/
|
|
2124
|
+
declare function export_flags_3d_physics(target: any, context: any): void;
|
|
2125
|
+
/**
|
|
2126
|
+
* Export an integer property as a bit flag field for 3D render layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/3d_render/layer_1}.
|
|
2127
|
+
* See also {@link PROPERTY_HINT_LAYERS_3D_RENDER}.
|
|
2128
|
+
*/
|
|
2129
|
+
declare function export_flags_3d_render(target: any, context: any): void;
|
|
2130
|
+
/**
|
|
2131
|
+
* Export an integer property as a bit flag field for navigation avoidance layers. The widget in the Inspector dock will use the layer names defined in {@link ProjectSettings.layer_names/avoidance/layer_1}.
|
|
2132
|
+
* See also {@link PROPERTY_HINT_LAYERS_AVOIDANCE}.
|
|
2133
|
+
*/
|
|
2134
|
+
declare function export_flags_avoidance(target: any, context: any): void;
|
|
2135
|
+
/**
|
|
2136
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], or {@link PackedStringArray} property as an absolute path to a directory. The path can be picked from the entire filesystem. See to limit it to the project folder and its subfolders.
|
|
2137
|
+
* See also {@link PROPERTY_HINT_GLOBAL_DIR}.
|
|
2138
|
+
*/
|
|
2139
|
+
declare function export_global_dir(target: any, context: any): void;
|
|
2140
|
+
/**
|
|
2141
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], or {@link PackedStringArray} property as an absolute path to a file. The path can be picked from the entire filesystem. See to limit it to the project folder and its subfolders.
|
|
2142
|
+
* If `filter` is provided, only matching files will be available for picking.
|
|
2143
|
+
* See also {@link PROPERTY_HINT_GLOBAL_FILE}.
|
|
2144
|
+
*/
|
|
2145
|
+
declare function export_global_file(filter?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2146
|
+
/**
|
|
2147
|
+
* Define a new group for the following exported properties. This helps to organize properties in the Inspector dock. Groups can be added with an optional `prefix`, which would make group to only consider properties that have this prefix. The grouping will break on the first property that doesn't have a prefix. The prefix is also removed from the property's name in the Inspector dock.
|
|
2148
|
+
* If no `prefix` is provided, then every following property will be added to the group. The group ends when then next group or category is defined. You can also force end a group by using this annotation with empty strings for parameters, `@export_group("", "")`.
|
|
2149
|
+
* Groups cannot be nested, use to add subgroups within groups.
|
|
2150
|
+
* See also {@link PROPERTY_USAGE_GROUP}.
|
|
2151
|
+
*/
|
|
2152
|
+
declare function export_group(name: string, prefix?: string): (target: any, context: any) => void;
|
|
2153
|
+
/**
|
|
2154
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], {@link PackedStringArray}, {@link Dictionary} or {@link Array}[lb]{@link Dictionary}[rb] property with a large {@link TextEdit} widget instead of a {@link LineEdit}. This adds support for multiline content and makes it easier to edit large amount of text stored in the property.
|
|
2155
|
+
* See also {@link PROPERTY_HINT_MULTILINE_TEXT}.
|
|
2156
|
+
*/
|
|
2157
|
+
declare function export_multiline(hint?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2158
|
+
/**
|
|
2159
|
+
* Export a {@link NodePath} or {@link Array}[lb]{@link NodePath}[rb] property with a filter for allowed node types.
|
|
2160
|
+
* See also {@link PROPERTY_HINT_NODE_PATH_VALID_TYPES}.
|
|
2161
|
+
* **Note:** The type must be a native class or a globally registered script (using the `class_name` keyword) that inherits {@link Node}.
|
|
2162
|
+
*/
|
|
2163
|
+
declare function export_node_path(type_?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2164
|
+
/**
|
|
2165
|
+
* Export a {@link String}, {@link Array}[lb]{@link String}[rb], or {@link PackedStringArray} property with a placeholder text displayed in the editor widget when no value is present.
|
|
2166
|
+
* See also {@link PROPERTY_HINT_PLACEHOLDER_TEXT}.
|
|
2167
|
+
*/
|
|
2168
|
+
declare function export_placeholder(placeholder: string): (target: any, context: any) => void;
|
|
2169
|
+
/**
|
|
2170
|
+
* Export an [int], [float], {@link Array}[lb][int][rb], {@link Array}[lb][float][rb], {@link PackedByteArray}, {@link PackedInt32Array}, {@link PackedInt64Array}, {@link PackedFloat32Array}, or {@link PackedFloat64Array} property as a range value. The range must be defined by `min` and `max`, as well as an optional `step` and a variety of extra hints. The `step` defaults to `1` for integer properties. For floating-point numbers this value depends on your {@link EditorSettings.interface/inspector/default_float_step} setting.
|
|
2171
|
+
* If hints `"or_greater"` and `"or_less"` are provided, the editor widget will not cap the value at range boundaries. The `"exp"` hint will make the edited values on range to change exponentially. The `"prefer_slider"` hint will make integer values use the slider instead of arrows for editing, while `"hide_control"` will hide the element controlling the value of the editor widget.
|
|
2172
|
+
* Hints also allow to indicate the units for the edited value. Using `"radians_as_degrees"` you can specify that the actual value is in radians, but should be displayed in degrees in the Inspector dock (the range values are also in degrees). `"degrees"` allows to add a degree sign as a unit suffix (the value is unchanged). Finally, a custom suffix can be provided using `"suffix:unit"`, where "unit" can be any string.
|
|
2173
|
+
* See also {@link PROPERTY_HINT_RANGE}.
|
|
2174
|
+
*/
|
|
2175
|
+
declare function export_range(min: float, max: float, step?: float, extra_hints?: string, ...args: any[]): (target: any, context: any) => void;
|
|
2176
|
+
/**
|
|
2177
|
+
* Export a property with {@link PROPERTY_USAGE_STORAGE} flag. The property is not displayed in the editor, but it is serialized and stored in the scene or resource file. This can be useful for scripts. Also the property value is copied when {@link Resource.duplicate} or {@link Node.duplicate} is called, unlike non-exported variables.
|
|
2178
|
+
*/
|
|
2179
|
+
declare function export_storage(target: any, context: any): void;
|
|
2180
|
+
/**
|
|
2181
|
+
* Define a new subgroup for the following exported properties. This helps to organize properties in the Inspector dock. Subgroups work exactly like groups, except they need a parent group to exist. See .
|
|
2182
|
+
* See also {@link PROPERTY_USAGE_SUBGROUP}.
|
|
2183
|
+
* **Note:** Subgroups cannot be nested, but you can use the slash separator (`/`) to achieve the desired effect:
|
|
2184
|
+
*/
|
|
2185
|
+
declare function export_subgroup(name: string, prefix?: string): (target: any, context: any) => void;
|
|
2186
|
+
/**
|
|
2187
|
+
* Export a {@link Callable} property as a clickable button with the label `text`. When the button is pressed, the callable is called.
|
|
2188
|
+
* If `icon` is specified, it is used to fetch an icon for the button via {@link Control.get_theme_icon}, from the `"EditorIcons"` theme type. If `icon` is omitted, the default `"Callable"` icon is used instead.
|
|
2189
|
+
* Consider using the {@link EditorUndoRedoManager} to allow the action to be reverted safely.
|
|
2190
|
+
* See also {@link PROPERTY_HINT_TOOL_BUTTON}.
|
|
2191
|
+
* **Note:** The property is exported without the {@link PROPERTY_USAGE_STORAGE} flag because a {@link Callable} cannot be properly serialized and stored in a file.
|
|
2192
|
+
* **Note:** In an exported project neither {@link EditorInterface} nor {@link EditorUndoRedoManager} exist, which may cause some scripts to break. To prevent this, you can use {@link Engine.get_singleton} and omit the static type from the variable declaration:
|
|
2193
|
+
* **Note:** Avoid storing lambda callables in member variables of {@link RefCounted}-based classes (e.g. resources), as this can lead to memory leaks. Use only method callables and optionally {@link Callable.bind} or {@link Callable.unbind}.
|
|
2194
|
+
*/
|
|
2195
|
+
declare function export_tool_button(text: string, icon?: string): (target: any, context: any) => void;
|
|
2196
|
+
/**
|
|
2197
|
+
* Add a custom icon to the current script. The icon specified at `icon_path` is displayed in the Scene dock for every node of that class, as well as in various editor dialogs.
|
|
2198
|
+
* **Note:** Only the script can have a custom icon. Inner classes are not supported.
|
|
2199
|
+
* **Note:** As annotations describe their subject, the annotation must be placed before the class definition and inheritance.
|
|
2200
|
+
* **Note:** Unlike most other annotations, the argument of the annotation must be a string literal (constant expressions are not supported).
|
|
2201
|
+
*/
|
|
2202
|
+
declare function icon(icon_path: string): (target: any, context: any) => void;
|
|
2203
|
+
/**
|
|
2204
|
+
* Mark the following property as assigned when the {@link Node} is ready. Values for these properties are not assigned immediately when the node is initialized ({@link Object._init}), and instead are computed and stored right before {@link Node._ready}.
|
|
2205
|
+
*/
|
|
2206
|
+
declare function onready(target: any, context: any): void;
|
|
2207
|
+
/**
|
|
2208
|
+
* Mark the following method for remote procedure calls. See High-level multiplayer ($DOCS_URL/tutorials/networking/high_level_multiplayer.html).
|
|
2209
|
+
* If `mode` is set as `"any_peer"`, allows any peer to call this RPC function. Otherwise, only the authority peer is allowed to call it and `mode` should be kept as `"authority"`. When configuring functions as RPCs with {@link Node.rpc_config}, each of these modes respectively corresponds to the {@link MultiplayerAPI.RPC_MODE_AUTHORITY} and {@link MultiplayerAPI.RPC_MODE_ANY_PEER} RPC modes. See {@link MultiplayerAPI.RPCMode}. If a peer that is not the authority tries to call a function that is only allowed for the authority, the function will not be executed. If the error can be detected locally (when the RPC configuration is consistent between the local and the remote peer), an error message will be displayed on the sender peer. Otherwise, the remote peer will detect the error and print an error there.
|
|
2210
|
+
* If `sync` is set as `"call_remote"`, the function will only be executed on the remote peer, but not locally. To run this function locally too, set `sync` to `"call_local"`. When configuring functions as RPCs with {@link Node.rpc_config}, this is equivalent to setting `call_local` to `true`.
|
|
2211
|
+
* The `transfer_mode` accepted values are `"unreliable"`, `"unreliable_ordered"`, or `"reliable"`. It sets the transfer mode of the underlying {@link MultiplayerPeer}. See {@link MultiplayerPeer.transfer_mode}.
|
|
2212
|
+
* The `transfer_channel` defines the channel of the underlying {@link MultiplayerPeer}. See {@link MultiplayerPeer.transfer_channel}.
|
|
2213
|
+
* The order of `mode`, `sync` and `transfer_mode` does not matter, but values related to the same argument must not be used more than once. `transfer_channel` always has to be the 4th argument (you must specify 3 preceding arguments).
|
|
2214
|
+
* **Note:** Methods annotated with cannot receive objects which define required parameters in {@link Object._init}. See {@link Object._init} for more details.
|
|
2215
|
+
*/
|
|
2216
|
+
declare function rpc(mode?: string, sync?: string, transfer_mode?: string, transfer_channel?: int): (target: any, context: any) => void;
|
|
2217
|
+
/**
|
|
2218
|
+
* Make a script with static variables to not persist after all references are lost. If the script is loaded again the static variables will revert to their default values.
|
|
2219
|
+
* **Note:** As annotations describe their subject, the annotation must be placed before the class definition and inheritance.
|
|
2220
|
+
* **Warning:** Currently, due to a bug, scripts are never freed, even if annotation is used.
|
|
2221
|
+
*/
|
|
2222
|
+
declare function static_unload(target: any, context: any): void;
|
|
2223
|
+
/**
|
|
2224
|
+
* Mark the current script as a tool script, allowing it to be loaded and executed by the editor. See Running code in the editor ($DOCS_URL/tutorials/plugins/running_code_in_the_editor.html).
|
|
2225
|
+
* **Note:** As annotations describe their subject, the annotation must be placed before the class definition and inheritance.
|
|
2226
|
+
*/
|
|
2227
|
+
declare function tool(target: any, context: any): void;
|
|
2228
|
+
/**
|
|
2229
|
+
* Mark the following statement to ignore the specified `warning`. See GDScript warning system ($DOCS_URL/tutorials/scripting/gdscript/warning_system.html).
|
|
2230
|
+
* See also and .
|
|
2231
|
+
*/
|
|
2232
|
+
declare function warning_ignore(warning: string, ...args: any[]): (target: any, context: any) => void;
|
|
2233
|
+
/**
|
|
2234
|
+
* Stops ignoring the listed warning types after . Ignoring the specified warning types will be reset to Project Settings. This annotation can be omitted to ignore the warning types until the end of the file.
|
|
2235
|
+
* **Note:** Unlike most other annotations, arguments of the annotation must be string literals (constant expressions are not supported).
|
|
2236
|
+
*/
|
|
2237
|
+
declare function warning_ignore_restore(warning: string, ...args: any[]): (target: any, context: any) => void;
|
|
2238
|
+
/**
|
|
2239
|
+
* Starts ignoring the listed warning types until the end of the file or the annotation with the given warning type.
|
|
2240
|
+
* **Note:** To suppress a single warning, use instead.
|
|
2241
|
+
* **Note:** Unlike most other annotations, arguments of the annotation must be string literals (constant expressions are not supported).
|
|
2242
|
+
*/
|
|
2243
|
+
declare function warning_ignore_start(warning: string, ...args: any[]): (target: any, context: any) => void;
|