defold

Welcome to hxdefold API documentation!

..
support
types
Buffer	Functions for manipulating buffers and streams.
BufferStream	A buffer stream handle returned by `Buffer.get_stream`.
BufferStreamDeclaration	Structure for buffer stream declaration used in `Buffer.create`.
BufferStreamType
Camera	Messages to control camera components and camera focus.
CameraMessageSetCamera	Data for the `CameraMessages.set_camera` message.
CameraMessages	Messages related to the `Camera` module.
Collectionfactory	Functions for controlling collection factory components which are used to dynamically spawn collections into the runtime.
CollectionfactoryStatus	Possible values for the `Collectionfactory.get_status` return value.
Collectionproxy	Messages for controlling and interacting with collection proxies which are used to dynamically load collections into the runtime.
CollectionproxyMessageSetTimeStep	Data for the `CollectionproxyMessages.set_time_step` message.
CollectionproxyMessages	Messages related to the `Collectionproxy` module.
Crash	Native crash logging functions.
CrashHandle	Crash dump handle (integer).
CrashSysField	Crash report system fields.
Facebook	Functions for interacting with Facebook APIs.
FacebookApprequestActionType
FacebookApprequestFilter
FacebookAudience	Facebook audience permissions used by `Facebook.login_with_publish_permissions`.
FacebookDialogParamAppinvite
FacebookDialogParamApprequests
FacebookDialogParamFeed
FacebookDialogResultAppinvite
FacebookDialogResultApprequests
FacebookDialogResultFeed
FacebookDialogType
FacebookEvent	Prefefined events for `Facebook.post_event`.
FacebookLoginData	Data for the `Facebook.login_with_publish_permissions` and `Facebook.login_with_read_permissions` callback argument.
FacebookLoginState	State of the facebook login, used in `FacebookLoginData`.
FacebookParam	Prefefined params for `Facebook.post_event`.
Factory	Functions for controlling factory components which are used to dynamically spawn game objects into the runtime.
FactoryStatus	Possible return values for `Factory.get_Status`.
Go	Functions, core hooks, messages and constants for manipulation of game objects. The "go" namespace is accessible from game object script files.
GoAnimatedProperty	Possible types of game object property suitable for animation.
GoEasing	Game object easing constants.
GoMessageSetParent	Data for the `GoMessages.set_parent` message.
GoMessages	Messages related to the `Go` module.
GoPlayback	Game object playback constants.
GoProperties	Properties related to the `Go` module.
GoProperty	Possible types of a game object property.
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.
GuiAdjustMode	Enumeration of possible adjust modes of a gui node.
GuiBlendMode	Enumeration of possible blend modes of a gui node.
GuiClippingMode	Possible clipping modes. Clipping mode defines how the node will clipping it's children nodes
GuiEasing
GuiKeyboardType
GuiMessageLayoutChanged	Data for the `GuiMessages.layout_changed` message.
GuiMessages	Messages related to the `Gui` module.
GuiNode	An instance of a GUI node.
GuiPieBounds	Possible pie bounds.
GuiPivot	Possible node pivots.
GuiPlayFlipbookProperties	Data for the `play_properties` argument of `Gui.play_flipbook` method.
GuiPlaySpineProperties	Data for the `play_properties` argument of `Gui.play_spine_anim` method.
GuiPlayback	Possible GUI playback modes.
GuiSizeMode	Possible node size modes.
GuiTextMetrics
GuiXAnchor
GuiYAnchor
Html5	HTML5 platform specific functions.
Http	Functions for performing HTTP and HTTPS requests.
HttpOptions	Type for the `options` argument of `Http.request` method.
HttpResponse	Type for the `response` argument for the http request callback.
Iac	Functions and constants for doing inter-app communication on iOS and Android.
IacType	Possible IAC types.
Iap	Functions and constants for interacting with Apple's In-app purchases and Google's In-app billing.
IapBuyOptions	Options for the `Iap.buy` method.
IapError	Error type returned by `Iap` function callbacks.
IapErrorReason	Error reasons returned by `Iap` function callbacks.
IapProduct	IAP product information returned by `Iap.list`.
IapProviderId	Possible provider ids returned by `Iap.get_provider_id`.
IapTransaction	Transaction object used `Iap` methods.
IapTransactionState	Possible transaction states enumeration (used by `IapTransaction.state` field).
Image	Functions for creating image objects.
ImageLoadResult	Return type of the `Image.load` method.
ImageType	Image type, used in `ImageLoadResult.type`.
Json	Manipulation of JSON data strings.
Label	Functions to manipulate a label component.
LabelProperties	Properties related to the `Label` module.
LabelTextMetrics	Return structure for `Label.get_text_metrics`.
Model	Functions and messages for interacting with model components.
ModelMessageModelAnimationDone	Data for the `ModelMessages.model_animation_done` message.
ModelMessages	Messages related to the `Model` module.
ModelPlayAnimProperties	Data for the `play_properties` argument of the `Model.play_anim` method.
ModelProperties	Properties related to the `Model` module.
Msg	Functions for passing messages and constructing URL objects.
Particlefx	Functions for controlling particle effect component playback and shader constants.
ParticlefxEmitterState
Physics	Functions and messages for collision object physics interaction with other objects (collisions and ray-casting) and control of physical behaviors.
PhysicsFixedJoint	Physics fixed joint type.
PhysicsHingeJoint	Physics hinge joint type.
PhysicsJointType	Types of physics joint available.
PhysicsMessageApplyForce	Data for the `PhysicsMessages.apply_force` message.
PhysicsMessageCollisionResponse	Data for the `PhysicsMessages.collision_response` message.
PhysicsMessageContactPointResponse	Data for the `PhysicsMessages.contact_point_response` message.
PhysicsMessageRayCastMissed	Data for the `PhysicsMessages.ray_cast_missed` message.
PhysicsMessageRayCastResponse	Data for the `PhysicsMessages.ray_cast_response` message.
PhysicsMessageTriggerResponse	Data for the `PhysicsMessages.trigger_response` message.
PhysicsMessageVelocityResponse	Data for the `PhysicsMessages.velocity_response` message.
PhysicsMessages	Messages related to the `Physics` module.
PhysicsProperties	Properties related to the `Physics` module.
PhysicsSliderJoint	Physics slider joint type.
PhysicsSpringJoint	Physics spring joint type.
Profiler	Functions for getting profiling data in runtime. More detailed profiling and debugging information available in the manuals.
ProfilerMode	Possible values for `Profiler.set_ui_mode`.
ProfilerViewMode	Possible values for `Profiler.set_ui_view_mode`.
ProfilerViewRecordedFrame	Data for `Profiler.view_recorded_frame`.
Push	Functions and constants for interacting with local, as well as Apple's and Google's push notification services.
PushData	Push notification data returned by `Push.get_all_scheduled` and `Push.get_scheduled` methods.
PushNotificationSettings	Platform specific data used as `notification_settings` argument of the `Push.schedule` method.
PushNotificationType	Possible values for elements of `notifications` argument of `Push.register` method (iOS only).
PushOrigin	Push origin passed to the `Push.set_listener` callback.
PushPriority	Push priority used in `PushNotificationSettings.priority` field (Android only).
PushScheduleResult	A type for returning multiple values from the `Push.schedule` method.
Render	Rendering functions, messages and constants. The "render" namespace is accessible only from render scripts.
RenderBlendFactor	Render blend functions enumeration (see `Render.set_blend_func`).
RenderBufferType	Render buffer types.
RenderClearBuffers	Table type for the `Render.clear` argument.
RenderCompareFunc	Compare functions enumeration (used in `Render.set_depth_func` and `Render.set_stencil_func`).
RenderConstantBuffer	Rendering constant buffer.
RenderCullFaceType	Rendering cull face type enumeration (see `Render.set_cull_face`).
RenderFilter	Type of the `RenderTargetParameters.min_filter` (and `mag_filter`) field.
RenderFormat	Type of the `RenderTargetParameters.format` field.
RenderMessageClearColor	Data for the `RenderMessages.clear_color` message.
RenderMessageDrawDebugText	Data for the `RenderMessages.draw_debug_text` message.
RenderMessageDrawLine	Data for the `RenderMessages.draw_line` message.
RenderMessageDrawText	Data for the `RenderMessages.draw_text` message.
RenderMessageResize	Data for the `RenderMessages.resize` message.
RenderMessageSetViewProjection	Data for the `RenderMessages.set_view_projection` message.
RenderMessageWindowResized	Data for the `RenderMessages.window_resized` message.
RenderMessages	Messages related to the `Render` module.
RenderPredicate	Render predicate used in `Render.draw` and created by `Render.predicate`.
RenderState	Rendering states enumeration.
RenderStencilOp	Stencil operations enumeration (see `Render.set_stencil_func`).
RenderTarget	Rendering target.
RenderTargetParameters	Type of the `parameters` argument of the `Render.render_target` method.
RenderWrap	Type of the `RenderTargetParameters.u_wrap` (and `v_wrap`) field.
Resource	Functions and constants to access resources.
ResourceLiveUpdateStatus
ResourceManifestReference	Resource manifest reference used by the `Resource` module.
ResourceTextureFormat	Resource format used in `ResourceTextureInfo.format` field.
ResourceTextureInfo	Texture info used by the `Resource.set_texture` method.
ResourceTextureType	Resource type used in `ResourceTextureInfo.type` field.
SetRenderTargetOptions	Options for the `Render.set_render_target`.
Sound	Functions and messages for controlling sound components and mixer groups.
SoundLeftRight	A type for returning multiple values from the sound component API.
SoundMessagePlaySound	Data for the `SoundMessages.play_sound` message and `Sound.play` method.
SoundMessageSetGain	Data for the `SoundMessages.set_gain` message.
SoundMessageSoundDone	Data for the `SoundMessages.sound_done` message.
SoundMessages	Messages related to the `Sound` module.
Spine	Functions and messages for interacting with the 'Spine' 2D bone animation system.
SpineMessageSpineEvent	Data for the `SpineMessages.SpineEvent` message.
SpineMessages	Messages related to spine components.
SpineProperties	Properties related to the `Spine` module.
Sprite	Functions, messages and properties used to manipulate sprite components.
SpriteMessageAnimationDone	Data for the `SpriteMessages.animation_done` message.
SpriteMessagePlayAnimation	Data for the `SpriteMessages.play_animation` message.
SpriteMessages	Messages related to the `Sprite` module.
SpritePlayFlipbookProperties	Data for the `play_properties` argument of `Sprite.play_flipbook` method.
SpriteProperties	Properties related to the `Sprite` module.
Sys	Functions and messages for using system resources, controlling the engine, error handling and debugging.
SysApplicationInfo	Return value of `Sys.get_application_info`.
SysConnectivity	Return value of `Sys.get_connectivity`.
SysEngineInfo	Return value for `Sys.get_engine_info`.
SysIfaddr	Return value for `Sys.get_ifaddrs`.
SysMessageExit	Data for the `SysMessages.exit` message.
SysMessageReboot	Data for the `SysMessages.reboot` message.
SysMessageSetUpdateFrequency	Data for the `SysMessages.set_update_frequency` message.
SysMessageSetVsync	Data for the `SysMessages.set_vsync` message.
SysMessageStartRecord	Data for the `SysMessages.start_record` message.
SysMessages	Messages handled by the system (send to the `@system:` socket).
SysResource	The returned value of `Sys.load_resource()`.
SysSysInfo	Return value for `Sys.get_sys_info`.
Tilemap	Functions and messages used to manipulate tile map components.
TilemapBounds	Return value of `Tilemap.get_bounds` method.
Timer	Timers allow you to set a delay and a callback to be called when the timer completes. The timers created with this API are updated with the collection timer where they are created. If you pause or speed up the collection (using `set_time_step`) it will also affect the new timer.
TimerHandle
Vmath	Functions for mathematical operations on vectors, matrices and quaternions.
Webview	Functions for creating and controlling webviews to show HTML pages or evaluate JavaScript. These API:s only exist on mobile platforms.
WebviewCallbackData	Data passed to the `Webview.create` callback.
WebviewCallbackType	Type passed to the `Webview.create` callback.
WebviewId	The identifier of a webview.
WebviewOpenOptions	Data for the `options` argument of `Webview.open`.
WebviewRequestId	The identifier of a request to a webview.
Window	Functions and constants to access the window, window event listeners and screen dimming.
WindowDimmingMode	Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
WindowEvent	Window events, used in `Window.set_listener` callbacks.
WindowEventData	Window event data, used in `Window.set_listener` callbacks.
WindowSize	Window size data, returned from `Window.get_size()`.
Zlib	Functions for compression and decompression of string buffers.