Defold API Reference

These are per-namespace API reference files generated for LLM usage.

C++ APIs

• dmDDF (Ddf) - DDF (Defold Data Format) API documentation
• dmAndroid (Android) - Android utility functions
• Array - Templatized array with bounds checking
• dmBuffer (Buffer) - Buffer API for data buffers as the main way to communicate between systems
• dmConditionVariable (Condition Variable) - API for platform independent mutex synchronization primitive
• dmConfigFile (ConfigFile) - Configuration file access functions
• dmConnectionPool (Connection Pool) - Connection pool
• dmCrypt (Crypt) - Various hash and encode/decode functions
• dmDoubleLinkedList (Double linked list structs and functions) - Double linked list structs and functions
• dmEndian (Endian) - C++ overloads for endian conversion functions
• dmFileDescriptor (FileDescriptor) - File Descriptor functions
• Hashtable - Hash table
• dmHttpClient (Http Client) - Http client functions
• dmImage (Image) - Image API functions
• dmIntersection (Intersection structs and functions) - Intersection math structs and functions
• Log - Logging functions
• dmMath (Math) - Math functions
• dmMemory (Memory) - Memory allocation functions
• dmMessage (Message) - Api for sending messages
• dmMutex (Mutex) - API for platform independent mutex synchronization primitive
• ObjectPool - Object Pool API documentation
• dmProfile (Profile) - Profiling macros
• SharedLibrary (Shared Library) - Utility functions for shared library export/import
• dmSocket (Socket) - Socket functions
• dmSpinlock (Spinlock) - API for platform independent spinlock synchronization primitive
• dmSSLSocket (SSLSocket) - Secure socket functions
• dmStaticAssert (Static Assert) - cpp void test() { DM_STATIC_ASSERT(sizeof(int) == 4, Invalid_int_size); }
• dmSys (Sys) - Sys allocation functions
• dmThread (Thread) - Thread functions
• dmTime (Time) - Time functions
• dmTransform (Transform) - Api for transforms with rotation, scale and translation
• dmTrigLookup (TrigLookup) - Api for trigonometrics using lookup tables
• dmURI (URI) - URI functions
• dmUtf8 (Utf8) - Utf8 API documentation
• dmVMath (Vector Math) - Vector Math functions
• dmWebServer (WebServer) - Simple high-level single-threaded Web server based on dmHttpServer The web-server has a handler concept similar to servlets in Java
• dmEngine (Engine) - SDK Engine extension API documentation
• engine (Engine runtime) - Engine runtime documentation
• dmExtension (Extension) - Functions for creating and controlling engine native extension libraries
• dmGameObject (Component) - Api for manipulating game object components (WIP)
• dmGameObject (Gameobject) - API for manipulating game objects
• dmGameObject (PropertyContainer) - API for game object property container
• dmGameObject (Script) - GameObject script API documentation
• dmGameSystem (Collection factory) - API for spawning collections from a collection factory component
• dmGameSystem (Factory) - API for spawning gameobject instances from a factory component
• dmGameSystem (GameSystem GUI Component) - Per-property registration functions for GUI component extensions
• dmGameSystem (Model) - API for interacting with model components
• dmGameSystem (GameSystem Gui) - Built-in scripting functions
• dmGameSystem (Property) - Property functions
• dmGameSystem (Component Render Constants) - Api for setting and updating component render constants
• dmGameSystem (Data Resource) - Helper types and accessors for the data resource type (`
• dmGameSystem (Font Resource) - Font resource functions
• dmGameSystem (Light Resource) - Helper types and accessors for the light resource type (`
• dmScript (Script) - Built-in scripting functions
• dmGraphics (Graphics) - Graphics API
• dmGraphics (Graphics) - Platform specific native graphics functions
• dmGraphics (Graphics OpenGL) - Graphics OpenGL API
• dmGraphics (Graphics Vulkan) - Graphics Vulkan API
• dmGui (Gui) - Defold GUI system
• dmHid (Hid) - Used to add input to the engine
• dmPhysics (Physics) - Physics related structs and functions
• dmRender (Render) - Api for render specific data
• dmResource (Resource) - Functions for managing resource and resource types
• dmResource (Resource) - Functions for managing resource types
• dmScript (Script) - Built-in scripting functions
• dmSound (Sound) - Functions for controlling the engine sound mixer from native extensions

Lua APIs

• b2d - Functions for interacting with Box2D
• b2d.body - Functions for interacting with Box2D bodies
• b2d.chain - Functions for Box2D v3 chains
• b2d.fixture - Functions for interacting with fixtures attached to Box2D bodies
• b2d.joint - Functions for interacting with native Box2D joints
• b2d.shape - Constants for functional shape tables used with `b2d
• b2d.world - Query and cast functions for the Defold-owned Box2D v2 world
• base (Base) - Documentation for the Lua base standard library
• bit (BitOp) - [Lua BitOp](http://bitop
• buffer (Buffer) - Functions for manipulating buffers and streams
• builtins (Built-ins) - Built-in scripting functions
• bullet3d - Native-style access to the Bullet 3D world and collision objects owned by Defold
• bullet3d.collision_object - Functions shared by rigid bodies and trigger ghost objects
• bullet3d.constraint - Creates and controls Bullet constraints between Defold rigid bodies
• bullet3d.rigid_body - Rigid body functions accept the collision object userdata returned by `bullet3d
• bullet3d.shape - Borrowed shape handles identify a one-based child slot on a Defold-owned collision object
• bullet3d.world - Read and tune the Bullet dynamics world owned by the current collection
• camera (Camera) - Messages to control camera components and camera focus
• collectionfactory (Collection factory) - Functions for controlling collection factory components which are used to dynamically spawn collections into the runtime
• collectionproxy (Collection proxy) - Messages for controlling and interacting with collection proxies which are used to dynamically load collections into the runtime
• compute (Compute) - Functions for interacting with compute programs
• coroutine (Coroutine) - Documentation for the Lua coroutine standard library
• crash (Crash) - Native crash logging functions and constants
• debug (Debug) - Documentation for the Lua debug standard library
• editor (Editor) - Editor scripting documentation
• factory (Factory) - Functions for controlling factory components which are used to dynamically spawn game objects into the runtime
• font (Font) - Functions, messages and properties used to manipulate font resources
• go (Game object) - Game object API documentation
• graphics (Graphics) - Graphics functions and constants
• gui (GUI) - GUI API documentation
• html5 (HTML5) - HTML5 platform specific functions
• http (HTTP) - Functions for performing HTTP and HTTPS requests
• image (Image) - Functions for creating image objects
• io (Io) - Documentation for the Lua io standard library
• json (JSON) - Manipulation of JSON data strings
• label (Label) - Label API documentation
• liveupdate (LiveUpdate) - Functions and constants to access resources
• material (Material) - Functions for interacting with materials
• math (Math) - Documentation for the Lua math standard library
• model (Model) - Model API documentation
• msg (Message) - Functions for passing messages and constructing URL objects
• os (Os) - Documentation for the Lua os standard library
• package (Package) - Documentation for the Lua package standard library
• particlefx (Particle effects) - Functions and properties for controlling particle effect component playback and shader constants
• physics (Collision object) - Collision object physics API documentation
• profiler (Profiler) - Functions for getting profiling data in runtime
• render (Render) - Rendering API documentation
• resource (Resource) - Functions and constants to access resources
• socket (LuaSocket) - [LuaSocket](https://github
• sound (Sound) - Functions and messages for controlling sound components and mixer groups
• sprite (Sprite) - Sprite API documentation
• string (String) - Documentation for the Lua string standard library
• sys (System) - Functions and messages for using system resources, controlling the engine, error handling and debugging
• table (Table) - Documentation for the Lua table standard library
• tilemap (Tilemap) - Functions and messages used to manipulate tile map components
• timer (Timer) - Timers allow you to set a delay and a callback to be called when the timer completes
• types (Types) - Functions for checking Defold userdata types
• vmath (Vector math) - Functions for mathematical operations on vectors, matrices and quaternions
• window (Window) - Functions and constants to access the window, window event listeners and screen dimming
• zlib (Zlib) - Functions for compression and decompression of string buffers

Extension APIs

• adinfo (extension-adinfo) - Provides functionality to get the advertising id and tracking status
• admob (extension-admob) - Functions and constants for interacting with [Google AdMob APIs](https://developers
• adpf (extension-adpf) - Functions and constants for interacting with the Android Device Performance Framework
• applovin (extension-applovin) - Functions and constants for AppLovin MAX SDK 13
• camera (extension-camera) - Provides functionality to capture images using the camera
• crazygames (extension-crazygames) - Functions and constants for interacting with the CrazyGames SDK APIs
• crypt (extension-crypt) - Functions and constants for interacting with various hash and encode/decode algorithms
• facebook (extension-facebook) - Functions and constants for interacting with Facebook APIs
• firebase (extension-firebase-analytics) - Functions and constants for interacting with Firebase
• firebase (extension-firebase-crashlytics) - Functions and constants for interacting with Firebase
• firebase (extension-firebase-remoteconfig) - Functions and constants for interacting with Firebase
• firebase (extension-firebase) - Functions and constants for interacting with Firebase
• fmod (extension-fmod) - FMOD Low Level API for audio playback and manipulation
• fontgen (extension-fontgen) - Functions to generate glyphs for fonts at runtime
• instantapp (extension-googleplayinstant) - Functions and constants for interacting with InstantApp APIs
• gpgs (extension-gpgs) - Functions and constants for interacting with Google Play Games Services (GPGS) APIs
• iac (extension-iac) - Functions and constants for doing inter-app communication
• iap (extension-iap) - Functions and constants for doing in-app purchases
• levelplay (extension-levelplay) - Functions and constants for Unity LevelPlay mediation on Android and iOS
• networkinfo (extension-network-info) - Functions to get information about the network configuration of the device
• odin (extension-odin) - Functions and constants for interacting with ODIN Voice
• pad (extension-pad) - Functionality to work with Play Asset Delivery and the AssetPackManager
• permissions (extension-permissions) - Functions and constants for interacting with permissions related APIs
• fusion (extension-photon-fusion) - Functions and constants for interacting with Photon Fusion
• realtime (extension-photon-realtime) - Functions and constants for interacting with Photon Realtime
• playables (extension-playables) - Functions for interacting with the YouTube Playables SDK
• poki_sdk (extension-poki-sdk) - Functions and constants for interacting with Poki SDK APIs
• push (extension-push) - Functions and constants for interacting with local, as well as Apple’’s and Google’’s push notification services
• review (extension-review) - Functions and constants for interacting with review APIs
• rive (extension-rive) - Rive animation helpers exposed to Lua scripts
• safearea (extension-safearea) - Defold native extension that will change the view/render of a game to fit into the safe area on iPhones and Android(API 28+) with notch
• siwa (extension-siwa) - Functions and constants for interacting Sign in with Apple
• gui (extension-spine) - Functions and constants for interacting with Spine models in GUI
• resource (extension-spine) - Functions for creating Spine resources dynamically
• spine (extension-spine) - Functions and constants for interacting with Spine models
• steam (extension-steam) - Functions and constants for interacting with Steamworks
• websocket (extension-websocket) - Functions and constants for using websockets
• webview (extension-webview) - Functions and constants for interacting with webview APIs
• shop (extension-xsolla) - Functions to use the Xsolla Shop Builder API
• zendesk (extension-zendesk) - Defold native extension to interact with the Zendesk SDK