defold

Welcome to hxdefold API documentation!

..
support
types
B2Body

B2BodyType
B2World
B2d
Buffer
BufferStreamDeclaration
BufferStreamType

Camera
CameraMessageSetCamera
CameraMessages
CameraOrthoMode
CameraProperties

CollectionFactory
CollectionFactoryStatus
CollectionProxy
  • Messages for controlling and interacting with collection proxies which are used to dynamically load collections into the runtime.

See CollectionProxyMessages for related messages.

CollectionProxyMessageSetTimeStep
CollectionProxyMessages
CollectionProxyResult
CollectionProxySetCollectionResult
Crash
CrashHandle
CrashSysField
CreateTextureAsyncResult
CreateTextureRequestId
ErrorHandlerCallback

Factory
FactoryStatus
Font
FontRequestId

The ID for a font async request (add/remove glyphs).

GetSysInfoOptions

Go
  • Functions, core hooks, messages and constants for manipulation of game objects. The "go" namespace is accessible from game object script files.

See GoProperties for related properties. See GoMessages for related messages.

GoAnimatedProperty
GoEasing
GoMessageSetParent
GoMessages
GoPlayback
GoProperties
GoProperty
Graphics
  • Graphics functions and constants.

Note: Graphics-related constants are exposed here. Existing constants under the render and resource modules may still be present but are deprecated in favor of using this module.

GraphicsBlendFactor

GraphicsBufferType

GraphicsCompareFunc

GraphicsFaceType

GraphicsState

GraphicsStencilOp

GraphicsTextureFilter

GraphicsTextureFormat
GraphicsTextureType

GraphicsTextureWrap

Gui
  • GUI core hooks, functions, messages, properties and constants for creation and manipulation of GUI nodes. The "gui" namespace is accessible only from gui scripts.

See GuiMessages for related messages.

GuiAdjustMode
  • Enumeration of possible adjust modes of a gui node.

Adjust mode defines how the node will adjust itself to a screen resolution which differs from the project settings.

GuiAnchor

GuiAnimateProperty

GuiBlendMode
  • Enumeration of possible blend modes of a gui node.

Blend mode defines how the node will be blended with the background.

GuiClippingMode
GuiEasing

GuiKeyboardType

GuiMessageLayoutChanged
GuiMessages
GuiNewTextureResult
GuiNewTextureResultCode

GuiNode
GuiNodeProperties
GuiNodeType
GuiNodeTypeResult
GuiPieBounds
GuiPivot
GuiPlayFlipbookProperties
GuiPlaySpineProperties
GuiPlayback
GuiSizeMode
Html5
  • HTML5 platform specific functions.

(The following functions are only available on HTML5 builds, the Html5 methods will not be available on other platforms.)

Http
HttpOptions
HttpResponse
Image
ImageLoadOptions

ImageLoadResult
ImageType
Json
JsonEncodingOptions

Label
  • Functions to manipulate a label component.

See LabelProperties for related properties.

LabelProperties
LabelTextMetrics
LiveUpdate
LiveUpdateManifestReference
LiveUpdateStatus

LiveUpdateStoreArchiveOptions
LoadBufferAsyncCallback

Parameters:

LoadBufferStatus

Model
  • Functions and messages for interacting with model components.

See ModelProperties for related properties. See ModelMessages for related messages.

ModelAabb
ModelMessageModelAnimationDone
ModelMessages
ModelPlayAnimProperties
ModelProperties
Msg
ParticleFxStopOptions
Particlefx
ParticlefxEmitterState

Physics
  • Functions and messages for collision object physics interaction with other objects (collisions and ray-casting) and control of physical behaviors.

See PhysicsProperties for related properties. See PhysicsMessages for related messages.

PhysicsFixedJoint
PhysicsHingeJoint
PhysicsJointType
PhysicsMessageApplyForce
PhysicsMessageCollisionResponse
PhysicsMessageContactPointResponse
PhysicsMessageRayCastMissed
PhysicsMessageRayCastResponse
PhysicsMessageTriggerResponse
PhysicsMessageVelocityResponse
PhysicsMessages
PhysicsProperties
PhysicsRaycastOptions
PhysicsSliderJoint
PhysicsSpringJoint
Profiler
  • Functions for getting profiling data in runtime. More detailed profiling and debugging information available in the manuals.

ProfilerMode
ProfilerViewMode
ProfilerViewRecordedFrame
Render
  • Rendering functions, messages and constants. The "render" namespace is accessible only from render scripts.

See RenderMessages for related messages.

RenderBlendFactor
RenderBufferType
RenderClearBuffers
RenderCompareFunc
RenderComputeOptions
RenderConstantBuffer
  • Rendering constant buffer.

The buffer's constant elements can be indexed like an ordinary Lua table, but you can't iterate over them with pairs() or ipairs().

RenderContextEvent
RenderCullFaceType
RenderDebugDrawOptions
RenderDrawFrustumPlanes
RenderDrawOptions

RenderFilter
RenderFormat
RenderMessageClearColor
RenderMessageDrawDebugText
RenderMessageDrawLine
RenderMessageDrawText
RenderMessageResize
RenderMessageSetViewProjection
RenderMessageUseFixedFitProjection
RenderMessageUseFixedProjection
RenderMessageUseStretchProjection
RenderMessageWindowResized
RenderMessages
RenderPredicate
RenderSortOrder
RenderState
RenderStencilOp
RenderTarget
RenderTargetFlags
RenderTargetParameters
RenderWrap
Resource
ResourceAtlasAnimationInfo
ResourceAtlasGeometriesInfo
ResourceAtlasInfo
ResourceCreateBufferOptions
ResourceCreateSoundDataOptions
ResourceCreateTextureInfo
ResourceGetTextMetricsOptions
ResourceRenderTargetAttachmentInfo
ResourceRenderTargetBufferType
ResourceRenderTargetInfo
ResourceSetBufferOptions
ResourceSetTextureInfo
ResourceTextMetrics
ResourceTextureCompressionType

ResourceTextureFormat

Note that the device running your game might not support all of these features, and the constants will only be exposed if it does.

ResourceTextureInfo
ResourceTextureType
SetCameraOptions
SetRenderTargetOptions
SetTimeStepMode

Sound
  • Functions and messages for controlling sound components and mixer groups.

See SoundMessages for related messages.

SoundLeftRight
SoundMessagePlaySound
SoundMessageSetGain
SoundMessageSoundDone
SoundMessageSoundStopped
SoundMessages
SoundPlayOptions
SoundProperties
SoundStopOptions
Sprite
  • Functions, messages and properties used to manipulate sprite components.

See SpriteProperties for related properties. See SpriteMessages for related messages.

SpriteMessageAnimationDone
SpriteMessagePlayAnimation
SpriteMessages
SpritePlayFlipbookProperties
SpriteProperties
Sys
  • Functions and messages for using system resources, controlling the engine, error handling and debugging.

See SysMessages for standard system messages.

SysApplicationInfo
SysConnectivity
SysEngineInfo
SysIfaddr
SysMessageExit
SysMessageReboot
SysMessageSetUpdateFrequency
SysMessageSetVsync
SysMessageStartRecord
SysMessages
SysResource
SysSysInfo
Tilemap
TilemapBounds
TilemapTileInfo
Timer
TimerHandle

TimerInfo
Types
Vmath
  • Functions for mathematical operations on vectors, matrices and quaternions.

VmathEulerAngles
Window
WindowDimmingMode
WindowEvent
WindowEventData
WindowSize
Zlib