API
Every namespace across the tracked Defold versions, unified into one surface. Each symbol is annotated with the versions it is available in.Tracked releases: 1.14.1, 1.14.0, 1.13.2, 1.13.1, 1.13.0, 1.12.4. A symbol carrying no availability note exists in all of them, and may be older still — Defold 1.12.4 is the oldest release this reference covers.71 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.
ConstantArray
An array constant read back from a constant buffer: the engine's 1-based proxy over the constant's slots, not a Lua table.
Hash
An opaque, branded handle to a *hashed name*: hold it and pass it back to the engine API, but never inspect or construct it.
Matrix4
A 4x4 transformation matrix.
NonTable
The phantom brand of a value Lua does not hold as a plain table: engine userdata (vectors, matrices, hashes, URLs, handles), Lua file handles and functions.
Opaque
A 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.
PlainTable
Any value Lua holds as a plain table: an object literal, a value typed by an interface or a type alias, a `LuaMap`, a `LuaTable` or an array.
Quaternion
A rotation quaternion with `x`, `y`, `z`, and `w` components.
Url
A message-passing address with `socket`, `path`, and `fragment` components.
Vector
A numeric vector of any size, accessed by index for reads and writes; `v.length()` is its component count.
Vector3
A three-component vector with `x`, `y`, and `z` components.
Vector4
A four-component vector with `x`, `y`, `z`, and `w` components.
Lua Standard
Pure-Lua and LuaJIT surfaces (base, bit, …). Types are provided by the lua-types dependency and are not re-emitted by @defold-typescript/types.
base
Lua base standard library
bit
Bitwise operations API documentation
coroutine
Lua coroutine standard library
debug
Lua debug standard library
io
Lua io standard library
math
Lua math standard library
os
Lua os standard library
package
Lua package standard library
string
Lua string standard library
table
Lua table standard library
Defold
Namespaces emitted by @defold-typescript/types from the pinned Defold reference documentation.
b2d2 new1 changed
Box2D documentation
b2d.body32 new1 changed
Box2D b2Body documentation
b2d.chain13 new
Box2D b2Chain documentation
b2d.fixture16 new
Box2D b2Fixture documentation
b2d.joint115 new
Box2D b2Joint documentation
b2d.shape30 new
Box2D b2Shape documentation
b2d.world31 new
Box2D b2World documentation
buffer
Buffer API documentation
bullet3d5 new
Bullet 3D documentation
bullet3d.collision_object58 new
Bullet collision object API
bullet3d.constraint67 new
Bullet constraint API
bullet3d.rigid_body49 new
Bullet rigid body API
bullet3d.shape13 new
Bullet collision shape API
bullet3d.world16 new
Bullet dynamics world API
camera9 new
Camera API documentation
collectionfactory
Collection factory API documentation
collectionproxy1 new
Collection proxy API documentation
compute6 new
Compute API documentation
crash
Crash API documentation
factory
Factory API documentation
font1 new
Font API documentation
go3 changed
Game object API documentation
graphics47 new
Graphics API documentation
gui1 new3 changed
GUI API documentation
html5
HTML5 API documentation
http
HTTP API documentation
image2 changed
Image API documentation
json2 changed
JSON API documentation
label2 new2 deprecated
Label API documentation
liveupdate1 new2 changed
LiveUpdate API documentation
material26 new
Material API documentation
model2 new1 changed1 deprecated
Model API documentation
msg
Messaging API documentation
particlefx
Particle effects API documentation
physics1 new
Collision object physics API documentation
profiler
Profiler API documentation
recorder5 new
Video recording
render5 new1 changed
Rendering API documentation
resource
Resource API documentation
socket24 changed
LuaSocket API documentation
sound2 changed
Sound API documentation
sprite1 deprecated
Sprite API documentation
sys2 changed
System API documentation
tilemap1 deprecated
Tilemap API documentation
timer
Timer API documentation
types
Types API documentation
vmath
Vector math API documentation
window2 new1 changed1 deprecated
Window API documentation
zlib
Zlib compression API documentation