Skip to Content
defold-typescript
Get startedGuidesAPILibraries

API reference (defold-1.13.0)

b2d

Box2D documentation

b2d.body

Box2D b2Body documentation

b2d.chain

Box2D b2Chain documentation

b2d.fixture

Box2D b2Fixture documentation

b2d.joint

Box2D b2Joint documentation

b2d.shape

Box2D b2Shape documentation

b2d.world

Box2D b2World documentation

buffer

Buffer API documentation

camera

Camera API documentation

collectionfactory

Collection factory API documentation

collectionproxy

Collection proxy API documentation

compute

Compute API documentation

crash

Crash API documentation

factory

Factory API documentation

font

Font API documentation

globals

Prefixless global symbols available to every Defold script.

go

Game object API documentation

graphics

Graphics API documentation

gui

GUI API documentation

html5

HTML5 API documentation

http

HTTP API documentation

image

Image API documentation

json

JSON API documentation

label

Label API documentation

liveupdate

LiveUpdate API documentation

material

Material API documentation

model

Model API documentation

msg

Messaging API documentation

particlefx

Particle effects API documentation

physics

Collision object physics API documentation

profiler

Profiler API documentation

render

Rendering API documentation

resource

Resource API documentation

socket

LuaSocket API documentation

sound

Sound API documentation

sprite

Sprite API documentation

sys

System API documentation

tilemap

Tilemap API documentation

timer

Timer API documentation

types

Types API documentation

vmath

Vector math API documentation

window

Window API documentation

zlib

Zlib compression API 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.

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