API reference
Generated from the default Defold version's reference documentation. 58 namespaces documented.
Globals
Prefixless globals that Defold exposes to every script.
Global types
Core value types (Vector3, Quaternion, Hash, …) that Defold exposes as ambient globals. Hand-curated from @defold-typescript/types rather than generated from the Defold reference documentation.
- HashAn opaque, branded handle to a *hashed name*: hold it and pass it back to the engine API, but never inspect or construct it.
- Matrix4A 4x4 transformation matrix.
- OpaqueA nominal, branded handle to a value the engine owns and manages — a GUI node, a texture, a render target, a physics body, a socket, and so on: hold it and pass it back to the API, but never inspect or construct it.
- QuaternionA rotation quaternion with `x`, `y`, `z`, and `w` components.
- UrlA message-passing address with `socket`, `path`, and `fragment` components.
- VectorA read-only numeric vector accessed by index; `length` is its component count.
- Vector3A three-component vector with `x`, `y`, and `z` components.
- Vector4A four-component vector with `x`, `y`, `z`, and `w` components.
Lua standard library
Pure-Lua and LuaJIT surfaces (base, bit, …). Types are provided by the lua-types dependency and are not re-emitted by @defold-typescript/types.
- baseLua base standard library
- bitBitwise operations API documentation
- coroutineLua coroutine standard library
- debugLua debug standard library
- ioLua io standard library
- mathLua math standard library
- osLua os standard library
- packageLua package standard library
- stringLua string standard library
- tableLua table standard library
Defold engine
Namespaces emitted by @defold-typescript/types from the pinned Defold reference documentation.
- b2dBox2D documentation
- b2d.bodyBox2D b2Body documentation
- bufferBuffer API documentation
- cameraCamera API documentation
- collectionfactoryCollection factory API documentation
- collectionproxyCollection proxy API documentation
- crashCrash API documentation
- factoryFactory API documentation
- fontFont API documentation
- goGame object API documentation
- graphicsGraphics API documentation
- guiGUI API documentation
- html5HTML5 API documentation
- httpHTTP API documentation
- iacFunctions and constants for doing inter-app communication. Supported on iOS and Android. [icon:ios] [icon:android]
- iapFunctions and constants for doing in-app purchases. Supported on iOS, Android (Google Play and Amazon) and Facebook Canvas platforms. [icon:ios] [icon:googleplay] [icon:amazon] [icon:facebook]
- imageImage API documentation
- jsonJSON API documentation
- labelLabel API documentation
- liveupdateLiveUpdate API documentation
- modelModel API documentation
- msgMessaging API documentation
- particlefxParticle effects API documentation
- physicsCollision object physics API documentation
- profilerProfiler API documentation
- pushFunctions and constants for interacting with local, as well as Apple''s and Google''s push notification services. These API's only exist on mobile platforms. [icon:ios] [icon:android]
- renderRendering API documentation
- resourceResource API documentation
- socketLuaSocket API documentation
- soundSound API documentation
- spriteSprite API documentation
- sysSystem API documentation
- tilemapTilemap API documentation
- timerTimer API documentation
- typesTypes API documentation
- vmathVector math API documentation
- webviewFunctions and constants for interacting with webview APIs
- windowWindow API documentation
- zlibZlib compression API documentation