From d7702c0d50819fff4e8fccd0e5506c994267f9da Mon Sep 17 00:00:00 2001 From: d954mas Date: Thu, 10 Feb 2022 12:49:03 +0300 Subject: [PATCH] update to 1.2.192 --- DefoldDocs/api/collision_object.lua | 10 +- DefoldDocs/doc/camera_doc.json | 42 + DefoldDocs/doc/dmFileDescriptor_doc.json | 285 ++ DefoldDocs/doc/dmGameObject_doc.json | 3040 +++++++++++----------- DefoldDocs/doc/dmGraphics_doc.json | 1033 ++++---- DefoldDocs/doc/dmLog_doc.json | 147 ++ DefoldDocs/doc/dmScript_doc.json | 98 +- DefoldDocs/doc/dmStaticAssert_doc.json | 42 + DefoldDocs/doc/dmThread_doc.json | 2 +- DefoldDocs/doc/physics_doc.json | 10 +- DefoldDocs/doc/sys_doc.json | 2 +- 11 files changed, 2614 insertions(+), 2097 deletions(-) create mode 100644 DefoldDocs/doc/dmFileDescriptor_doc.json create mode 100644 DefoldDocs/doc/dmStaticAssert_doc.json diff --git a/DefoldDocs/api/collision_object.lua b/DefoldDocs/api/collision_object.lua index 9b4a358..022edd6 100644 --- a/DefoldDocs/api/collision_object.lua +++ b/DefoldDocs/api/collision_object.lua @@ -38,7 +38,7 @@ function physics.get_gravity() end ---Returns the group name of a collision object as a hash. ---@param url string|hash|url the collision object to return the group of. ----@return hash hash value of the group. function checkIsEnemy() local grp = physics.get_group("#collisionobject") assert( grp == hash("enemy") ) end +---@return hash hash value of the group. local function check_is_enemy() local group = physics.get_group("#collisionobject") return group == hash("enemy") end function physics.get_group(url) end ---Get a table for properties for a connected joint. The joint has to be created before @@ -69,7 +69,7 @@ function physics.get_joint_reaction_torque(collisionobject, joint_id) end ---object, false otherwise. ---@param url string|hash|url the collision object to check the mask of. ---@param group string the name of the group to check for. ----@return boolean boolean value of the maskbit. 'true' if present, 'false' otherwise. function checkCollideWithUser() -- to check if the collisionobject would collide with "user" group local hits_user = physics.get_maskbit("#collisionobject","user") return hits_user end +---@return boolean boolean value of the maskbit. 'true' if present, 'false' otherwise. local function is_invincible() -- check if the collisionobject would collide with the "bullet" group local invincible = physics.get_maskbit("#collisionobject", "bullet") return invincible end function physics.get_maskbit(url, group) end ---Ray casts are used to test for intersections against collision objects in the physics world. @@ -111,7 +111,7 @@ function physics.set_gravity(gravity) end ---string value. The group name should exist i.e. have been used in ---a collision object in the editor. ---@param url string|hash|url the collision object affected. ----@param group string the new group name to be assigned. function changeCollisionGroup() physics.set_group("#collisionobject", "enemy") end +---@param group string the new group name to be assigned. local function change_collision_group() physics.set_group("#collisionobject", "enemy") end function physics.set_group(url, group) end ---Flips the collision shapes horizontally for a collision object @@ -130,8 +130,8 @@ function physics.set_joint_properties(collisionobject, joint_id, properties) end ---Sets or clears the masking of a group (maskbit) in a collision object. ---@param url string|hash|url the collision object to change the mask of. ---@param group string the name of the group (maskbit) to modify in the mask. ----@param type bool boolean value of the new maskbit. 'true' to enable, 'false' to disable. function makeUserAlly() -- no longer collide with the "user" group physics.set_maskbit("#collisionobject","user",false) end -function physics.set_maskbit(url, group, type) end +---@param maskbit boolean boolean value of the new maskbit. 'true' to enable, 'false' to disable. local function make_invincible() -- no longer collide with the "bullet" group physics.set_maskbit("#collisionobject", "bullet", false) end +function physics.set_maskbit(url, group, maskbit) end ---Flips the collision shapes vertically for a collision object ---@param url string|hash|url the collision object that should flip its shapes diff --git a/DefoldDocs/doc/camera_doc.json b/DefoldDocs/doc/camera_doc.json index d63e474..0c87e65 100644 --- a/DefoldDocs/doc/camera_doc.json +++ b/DefoldDocs/doc/camera_doc.json @@ -79,6 +79,48 @@ "tparams": [], "type": "MESSAGE", "name": "release_camera_focus" + }, + { + "replaces": "", + "description": "Vertical field of view of the camera.\nThe type of the property is float.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "float camera fov", + "examples": "
function init(self)\n  local fov = go.get("#camera", "fov")\n  go.set("#sprite", "fov", fov + 0.1)\n  go.animate("#camera", "fov", go.PLAYBACK_ONCE_PINGPONG, 1.2, go.EASING_LINEAR, 1)\nend\n
", + "members": [], + "error": "", + "tparams": [], + "type": "PROPERTY", + "name": "fov" + }, + { + "replaces": "", + "description": "Camera frustum near plane.\nThe type of the property is float.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "float camera near_z", + "examples": "
function init(self)\n  local near_z = go.get("#camera", "near_z")\n  go.set("#sprite", "near_z", 10)\nend\n
", + "members": [], + "error": "", + "tparams": [], + "type": "PROPERTY", + "name": "near_z" + }, + { + "replaces": "", + "description": "Camera frustum far plane.\nThe type of the property is float.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "float camera far_z", + "examples": "
function init(self)\n  local far_z = go.get("#camera", "far_z")\n  go.set("#sprite", "far_z", 10)\nend\n
", + "members": [], + "error": "", + "tparams": [], + "type": "PROPERTY", + "name": "far_z" } ] } \ No newline at end of file diff --git a/DefoldDocs/doc/dmFileDescriptor_doc.json b/DefoldDocs/doc/dmFileDescriptor_doc.json new file mode 100644 index 0000000..dec0b5d --- /dev/null +++ b/DefoldDocs/doc/dmFileDescriptor_doc.json @@ -0,0 +1,285 @@ +{ + "info": { + "group": "DEFOLD SDK", + "description": "File Descriptor functions.", + "namespace": "dmFileDescriptor", + "brief": "SDK File Descriptor API documentation", + "file": "dmsdk/dlib/file_descriptor.h", + "path": "engine/dlib/src/dmsdk/dlib/file_descriptor.h", + "name": "FileDescriptor" + }, + "elements": [ + { + "replaces": "", + "description": "Poll events", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Poll events", + "examples": "", + "members": [ + { + "doc": "", + "type": "", + "name": "EVENT_READ" + }, + { + "doc": "", + "type": "", + "name": "EVENT_WRITE" + }, + { + "doc": "", + "type": "", + "name": "EVENT_ERROR" + } + ], + "error": "", + "tparams": [], + "type": "ENUM", + "name": "PollEvent" + }, + { + "replaces": "", + "description": "Poller", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Poller", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "STRUCT", + "name": "Poller" + }, + { + "replaces": "", + "description": "Set capacity of poller.", + "parameters": [ + { + "doc": "Poller", + "name": "poller", + "types": [ + "Poller*" + ] + }, + { + "doc": "Capacity", + "name": "capacity", + "types": [ + "uint32_T" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Set capacity of poller.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "PollerSetCapacity" + }, + { + "replaces": "", + "description": "Clear event from poller.", + "parameters": [ + { + "doc": "Poller", + "name": "poller", + "types": [ + "Poller*" + ] + }, + { + "doc": "Event to clear", + "name": "event", + "types": [ + "PollEvent" + ] + }, + { + "doc": "File descriptor to clear", + "name": "fd", + "types": [ + "int" + ] + } + ], + "returnvalues": [ + { + "doc": "", + "name": "", + "types": [ + "void" + ] + } + ], + "notes": [], + "brief": "Clear event from poller.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "PollerClearEvent" + }, + { + "replaces": "", + "description": "Set file descriptor event to poll for", + "parameters": [ + { + "doc": "Poller", + "name": "poller", + "types": [ + "Poller*" + ] + }, + { + "doc": "Event to set", + "name": "event", + "types": [ + "PollEvent" + ] + }, + { + "doc": "File descriptor to clear", + "name": "fd", + "types": [ + "int" + ] + } + ], + "returnvalues": [ + { + "doc": "", + "name": "", + "types": [ + "void" + ] + } + ], + "notes": [], + "brief": "Set file descriptor event to poll for", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "PollerSetEvent" + }, + { + "replaces": "", + "description": "Check if event exists for file descriptor", + "parameters": [ + { + "doc": "Poller", + "name": "poller", + "types": [ + "Poller*" + ] + }, + { + "doc": "Event to check", + "name": "event", + "types": [ + "PollEvent" + ] + }, + { + "doc": "File descriptor to clear", + "name": "fd", + "types": [ + "int" + ] + } + ], + "returnvalues": [ + { + "doc": "True if event exists.", + "name": "", + "types": [ + "bool" + ] + } + ], + "notes": [], + "brief": "Check if event exists for file descriptor", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "PollerHasEvent" + }, + { + "replaces": "", + "description": "Reset poller.", + "parameters": [ + { + "doc": "Poller", + "name": "spoller", + "types": [ + "Poller*" + ] + } + ], + "returnvalues": [ + { + "doc": "", + "name": "", + "types": [ + "void" + ] + } + ], + "notes": [], + "brief": "Reset poller.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "PollerReset" + }, + { + "replaces": "", + "description": "Wait for event", + "parameters": [ + { + "doc": "Poller", + "name": "poller", + "types": [ + "Poller*" + ] + }, + { + "doc": "Timeout. For blocking pass -1. (milliseconds)", + "name": "timeout", + "types": [ + "int" + ] + } + ], + "returnvalues": [ + { + "doc": "Non-negative value on success, 0 on timeout and\n-1 on error with errno set to indicate the error", + "name": "", + "types": [ + "Result" + ] + } + ], + "notes": [], + "brief": "Wait for event", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "Wait" + } + ] +} \ No newline at end of file diff --git a/DefoldDocs/doc/dmGameObject_doc.json b/DefoldDocs/doc/dmGameObject_doc.json index f7eddb0..f113ef6 100644 --- a/DefoldDocs/doc/dmGameObject_doc.json +++ b/DefoldDocs/doc/dmGameObject_doc.json @@ -1,1415 +1,1210 @@ { "info": { - "description": "<dmsdk/gameobject/script.h>", + "description": "<dmsdk/gameobject/component.h>\nApi for manipulating game object components (WIP)", "namespace": "dmGameObject", - "brief": "SDK GameObject script API documentation", + "brief": "SDK Component API documentation", "file": "", "path": "", - "name": "Script" + "name": "Component" }, "elements": [ { "replaces": "", - "description": "Callback when iterating over the properties for a component.", + "description": "Value for an invalid instance index, this must be the same as defined in gamesys_ddf.proto for Create#index.", "parameters": [], "returnvalues": [], "notes": [], - "brief": "Callback when iterating over the properties for a ...", + "brief": "Value for an invalid instance index, this must be ...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "" + "name": "INVALID_INSTANCE_POOL_INDEX" }, { "replaces": "", - "description": "Get the component type index. Used for with e.g. dmGameObject::GetWorld()/GetContext()", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - } - ], - "returnvalues": [ - { - "doc": "The type index.", - "name": "type_index", - "types": [ - "uint32_t" - ] - } - ], + "description": "Gameobject instance handle", + "parameters": [], + "returnvalues": [], "notes": [], - "brief": "Get the component type index. Used for with e.g. d...", + "brief": "Gameobject instance handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeGetTypeIndex" + "type": "TYPEDEF", + "name": "HInstance" }, { "replaces": "", - "description": "Set the new world callback. Called when a collection (i.e. a \"world\") is created.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentNewWorld" - ] - } - ], + "description": "Script handle", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the new world callback", + "brief": "Script handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetNewWorldFn" + "type": "TYPEDEF", + "name": "HScript" }, { "replaces": "", - "description": "Set the world destroy callback. Called when a collection (i.e. a \"world\") is destroyed.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentDeleteWorld" - ] - } - ], + "description": "Script instance handle", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the world destroy callback", + "brief": "Script instance handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetDeleteWorldFn" + "type": "TYPEDEF", + "name": "HScriptInstance" }, { "replaces": "", - "description": "Set the component create callback. Called when a component instance is created.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentCreate" - ] - } - ], + "description": "Collection register.", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component create callback", + "brief": "Collection register.", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetCreateFn" + "type": "TYPEDEF", + "name": "HRegister" }, { "replaces": "", - "description": "Set the component destroy callback. Called when a component instance is destroyed.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentDestroy" - ] - } - ], + "description": "Gameobject collection handle", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component destroy callback", + "brief": "Gameobject collection handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetDestroyFn" + "type": "TYPEDEF", + "name": "HCollection" }, { "replaces": "", - "description": "Set the component init callback. Called on each gameobject's components, during a gameobject's initialization.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentInit" - ] - } - ], + "description": "Gameobject prototype handle", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component init callback", + "brief": "Gameobject prototype handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetInitFn" + "type": "TYPEDEF", + "name": "HPrototype" }, { "replaces": "", - "description": "Set the component finalize callback. Called on each gameobject's components, during a gameobject's finalization.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentFinal" - ] - } - ], + "description": "Gameobject properties handle", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component finalize callback", + "brief": "Gameobject properties handle", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetFinalFn" + "type": "TYPEDEF", + "name": "HProperties" }, { "replaces": "", - "description": "Set the component add-to-update callback. Called for each component instal, when the game object is spawned.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentAddToUpdate" - ] - } - ], + "description": "Result enumeration.", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component add-to-update callback", + "brief": "result enumeration", "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetAddToUpdateFn" - }, - { - "replaces": "", - "description": "Set the component get callback. Called when the scripts want to retrieve the individual component user data given an url.", - "parameters": [ + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_OK" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentGet" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component get callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetGetFn" - }, - { - "replaces": "", - "description": "Set the component render callback. Called when it's time to render all component instances.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_OUT_OF_RESOURCES" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentsRender" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component render callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetRenderFn" - }, - { - "replaces": "", - "description": "Set the component update callback. Called when it's time to update all component instances.", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_ALREADY_REGISTERED" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_IDENTIFIER_IN_USE" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentsUpdate" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component update callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetUpdateFn" - }, - { - "replaces": "", - "description": "Set the component post update callback. Called for each collection after the update, before the render.", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_IDENTIFIER_ALREADY_SET" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_COMPONENT_NOT_FOUND" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentsPostUpdate" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component post update callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetPostUpdateFn" - }, - { - "replaces": "", - "description": "Set the component on-message callback. Called multiple times per frame, to flush messages.", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_MAXIMUM_HIEARCHICAL_DEPTH" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_INVALID_OPERATION" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentOnMessage" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component on-message callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetOnMessageFn" - }, - { - "replaces": "", - "description": "Set the component on-input callback. Called once per frame, before the Update function.", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_RESOURCE_TYPE_NOT_FOUND" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_BUFFER_OVERFLOW" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentOnInput" - ] + "doc": "", + "type": "", + "name": "dmGameObject::RESULT_UNKNOWN_ERROR" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component on-input callback", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetOnInputFn" + "type": "ENUM", + "name": "Result" }, { "replaces": "", - "description": "Set the component on-reload callback. Called when the resource of a component instance is reloaded.", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - }, - { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentOnReload" - ] - } - ], + "description": "Property types.", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set the component on-reload callback", + "brief": "property types", "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetOnReloadFn" - }, - { - "replaces": "", - "description": "Set the component set properties callback. Called when the component instance is being spwned.", - "parameters": [ + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_NUMBER" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentSetProperties" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component set properties callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetSetPropertiesFn" - }, - { - "replaces": "", - "description": "Set the component get property callback. Called when accessing a property via go.get()", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_HASH" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_URL" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentGetProperty" - ] - } - ], - "returnvalues": [], - "notes": [], - "brief": "set the component get property callback", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetGetPropertyFn" - }, - { - "replaces": "", - "description": "Set the component set property callback. Called when accessing a property via go.set()", - "parameters": [ + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_VECTOR3" + }, { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_VECTOR4" }, { - "doc": "callback", - "name": "fn", - "types": [ - "ComponentSetProperty" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_QUAT" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_BOOLEAN" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_TYPE_COUNT" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component set property callback", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetSetPropertyFn" + "type": "ENUM", + "name": "PropertyType" }, { "replaces": "", - "description": "Set the component type global context. Usually set when registering the component type.", - "parameters": [ + "description": "Property result.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "property result", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_OK" }, { - "doc": "component type global context", - "name": "context", - "types": [ - "void*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_NOT_FOUND" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_INVALID_FORMAT" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_TYPE" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_TYPE_MISMATCH" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_COMP_NOT_FOUND" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_INVALID_INSTANCE" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_BUFFER_OVERFLOW" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_VALUE" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_OPERATION" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_RESOURCE_NOT_FOUND" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_INVALID_INDEX" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::PROPERTY_RESULT_INVALID_KEY" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component type global context", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetContext" + "type": "ENUM", + "name": "PropertyResult" }, { "replaces": "", - "description": "get the component type global context", - "parameters": [ - { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] - } - ], - "returnvalues": [ - { - "doc": "component type global context", - "name": "context", - "types": [ - "void*" - ] - } - ], + "description": "Playback type enum", + "parameters": [], + "returnvalues": [], "notes": [], - "brief": "get the component type global context", + "brief": "Playback type enum", "examples": "", "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeGetContext" + "type": "ENUM", + "name": "Playback" }, { "replaces": "", - "description": "Set the component type transform dependency flag.\nIf this flag is set, it might trigger an dmGameObject::UpdateTransforms() (if there are dirty transforms)", - "parameters": [ + "description": "Create result enum.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Create result enum", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::CREATE_RESULT_OK" }, { - "doc": "transform dependency flag", - "name": "reads_transforms", - "types": [ - "bool" - ] + "doc": "", + "type": "", + "name": "dmGameObject::CREATE_RESULT_UNKNOWN_ERROR" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component type transform dependency flag", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetReadsTransforms" + "type": "ENUM", + "name": "CreateResult" }, { "replaces": "", - "description": "Set the component type prio order. Defines the update order of the component types.", - "parameters": [ + "description": "Update result enum.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Update result enum", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::UPDATE_RESULT_OK" }, { - "doc": "prio order", - "name": "prio", - "types": [ - "uint16_t" - ] + "doc": "", + "type": "", + "name": "dmGameObject::UPDATE_RESULT_UNKNOWN_ERROR" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component type prio order", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetPrio" + "type": "ENUM", + "name": "UpdateResult" }, { "replaces": "", - "description": "Set the component type need for a per component instance user data. Defaults to true.", - "parameters": [ + "description": "Type of property value", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Type of property value", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROP_VALUE_ARRAY" }, { - "doc": "does each component instance need user data", - "name": "has_user_data", - "types": [ - "bool" - ] + "doc": "", + "type": "", + "name": "dmGameObject::PROP_VALUE_HASHTABLE" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component type need for a per component instance user data", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetHasUserData" + "type": "ENUM", + "name": "PropertyValueType" }, { "replaces": "", - "description": "set the component child iterator function. Called during inspection", - "parameters": [ + "description": "Parameters variant that holds key or index for a propertys data structure.", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Property Options", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "The index of the property to set, only applicable if property is array.", + "type": "int32_t", + "name": "m_Index" }, { - "doc": "child iterator function", - "name": "fn", - "types": [ - "FIteratorChildren" - ] + "doc": "The key of the property to set, only applicable if property is hashtable.", + "type": "dmhash_t", + "name": "m_Key" + }, + { + "doc": "A flag if structure contain m_Key value (it can't contain both)", + "type": "uint8_t", + "name": "m_HasKey" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component child iterator function", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetChildIteratorFn" + "type": "STRUCT", + "name": "PropertyOptions" }, { "replaces": "", - "description": "set the component property iterator function. Called during inspection", - "parameters": [ + "description": "Property variant that holds the data for a variable", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "property variant", + "examples": "", + "members": [ { - "doc": "the type", - "name": "type", - "types": [ - "ComponentType*" - ] + "doc": "property type", + "type": "dmGameObject::PropertyType", + "name": "m_Type" }, { - "doc": "property iterator function", - "name": "fn", - "types": [ - "FIteratorProperties" - ] + "doc": "A floating point value (union)", + "type": "double", + "name": "m_Number" + }, + { + "doc": "A hash value (union)", + "type": "dmhash_t", + "name": "m_Hash" + }, + { + "doc": "An URL value (union)", + "type": "const uin8_t*", + "name": "m_Url" + }, + { + "doc": "A vector4 value (union)", + "type": "float", + "name": "m_V4" + }, + { + "doc": "A boolean value (union)", + "type": "bool", + "name": "m_Bool" } ], - "returnvalues": [], - "notes": [], - "brief": "set the component property iterator function", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "ComponentTypeSetPropertyIteratorFn" + "type": "STRUCT", + "name": "PropertyVar" }, { "replaces": "", - "description": "Context used when registering a new component type", + "description": "Description of a property.\nIf the property is externally mutable, m_ValuePtr points to the value and its length is m_ElementCount.\nm_Variant always reflects the value.", "parameters": [], "returnvalues": [], "notes": [], - "brief": "Context used when registering a new component type", + "brief": "Description of a property", "examples": "", "members": [ { - "doc": "The config file", - "type": "dmConfigFile::HConfig", - "name": "m_Config" + "doc": "For composite properties (float arrays), these ids name each element", + "type": "dmhash_t", + "name": "m_ElementIds" }, { - "doc": "The resource factory", - "type": "dmResource::HFactory", - "name": "m_Factory" + "doc": "Variant holding the value", + "type": "PropertyVar", + "name": "m_Variant" }, { - "doc": "The game object registry", - "type": "dmGameObject::HRegister", - "name": "m_Register" + "doc": "Pointer to the value, only set for mutable values. The actual data type is described by the variant.", + "type": "float*", + "name": "m_ValuePtr" }, { - "doc": "The shared script context", - "type": "dmScript::HContext", - "name": "m_Script" + "doc": "Determines whether we are permitted to write to this property.", + "type": "bool", + "name": "m_ReadOnly" }, { - "doc": "Mappings between names and contextx", - "type": "dmHashTable64", - "name": "m_Contexts" + "doc": "Indicates type of the property.", + "type": "uint8_t", + "name": "m_ValueType" } ], "error": "", "tparams": [], "type": "STRUCT", - "name": "ComponentTypeCreateCtx" + "name": "PropertyDesc" }, { "replaces": "", - "description": "Value for an invalid instance index, this must be the same as defined in gamesys_ddf.proto for Create#index.", + "description": "Update context", "parameters": [], "returnvalues": [], "notes": [], - "brief": "Value for an invalid instance index, this must be ...", + "brief": "Update context", "examples": "", - "members": [], + "members": [ + { + "doc": "the delta time elapsed since last frame (seconds)", + "type": "float", + "name": "m_DT" + } + ], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "INVALID_INSTANCE_POOL_INDEX" + "type": "STRUCT", + "name": "UpdateContext" }, { "replaces": "", - "description": "Gameobject instance handle", + "description": "Container of input related information.", "parameters": [], "returnvalues": [], "notes": [], - "brief": "Gameobject instance handle", + "brief": "Container of input related information.", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HInstance" + "type": "STRUCT", + "name": "InputAction" }, { "replaces": "", - "description": "Script handle", + "description": "Input result enum", "parameters": [], "returnvalues": [], "notes": [], - "brief": "Script handle", + "brief": "Input result enum", + "examples": "", + "members": [ + { + "doc": "= 0", + "type": "", + "name": "INPUT_RESULT_IGNORED" + }, + { + "doc": "= 1", + "type": "", + "name": "INPUT_RESULT_CONSUMED" + }, + { + "doc": "= -1000", + "type": "", + "name": "INPUT_RESULT_UNKNOWN_ERROR" + } + ], + "error": "", + "tparams": [], + "type": "ENUM", + "name": "InputResult" + }, + { + "replaces": "", + "description": "Retrieve the message socket for the specified collection.", + "parameters": [ + { + "doc": "Collection handle", + "name": "collection", + "types": [ + "dmGameObject::HCollection" + ] + } + ], + "returnvalues": [ + { + "doc": "The message socket of the specified collection", + "name": "socket", + "types": [ + "dmMessage::HSocket" + ] + } + ], + "notes": [], + "brief": "Retrieve the message socket for the specified coll...", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HScript" + "type": "FUNCTION", + "name": "GetMessageSocket" }, { "replaces": "", - "description": "Script instance handle", - "parameters": [], - "returnvalues": [], + "description": "Retrieve a collection from the specified instance", + "parameters": [ + { + "doc": "Game object instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ + { + "doc": "The collection the specified instance belongs to", + "name": "collection", + "types": [ + "dmGameObject::HInstance" + ] + } + ], "notes": [], - "brief": "Script instance handle", + "brief": "Retrieve a collection from the specified instance", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HScriptInstance" + "type": "FUNCTION", + "name": "GetCollection" }, { "replaces": "", - "description": "Collection register.", - "parameters": [], - "returnvalues": [], + "description": "Create a new gameobject instance", + "parameters": [ + { + "doc": "Gameobject collection", + "name": "collection", + "types": [ + "dmGameObject::HCollection" + ] + }, + { + "doc": "|type: const char*] Prototype file name. May be 0.", + "name": "prototype_name", + "types": [ + "" + ] + } + ], + "returnvalues": [ + { + "doc": "New gameobject instance. NULL if any error occured", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], "notes": [], - "brief": "Collection register.", + "brief": "Create a new gameobject instance", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HRegister" + "type": "FUNCTION", + "name": "New" }, { "replaces": "", - "description": "Gameobject collection handle", - "parameters": [], + "description": "Delete gameobject instance", + "parameters": [ + { + "doc": "Gameobject collection", + "name": "collection", + "types": [ + "dmGameObject::HCollection" + ] + }, + { + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + }, + { + "doc": "If true, delete child hierarchy recursively in child to parent order (leaf first)", + "name": "recursive", + "types": [ + "bool" + ] + } + ], "returnvalues": [], "notes": [], - "brief": "Gameobject collection handle", + "brief": "Delete gameobject instance", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HCollection" + "type": "FUNCTION", + "name": "Delete" }, { "replaces": "", - "description": "Gameobject prototype handle", - "parameters": [], - "returnvalues": [], + "description": "Construct a hash of an instance id based on the index provided.", + "parameters": [ + { + "doc": "The index to base the id off of.", + "name": "index", + "types": [ + "uint32_t" + ] + } + ], + "returnvalues": [ + { + "doc": "hash of the instance id constructed.", + "name": "id", + "types": [ + "dmhash_t" + ] + } + ], "notes": [], - "brief": "Gameobject prototype handle", + "brief": "Construct a hash of an instance id based on the in...", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HPrototype" + "type": "FUNCTION", + "name": "ConstructInstanceId" }, { "replaces": "", - "description": "Gameobject properties handle", - "parameters": [], - "returnvalues": [], + "description": "Retrieve an instance index from the index pool for the collection.", + "parameters": [ + { + "doc": "Collection from which to retrieve the instance index.", + "name": "collection", + "types": [ + "dmGameObject::HColleciton" + ] + } + ], + "returnvalues": [ + { + "doc": "index from the index pool of collection.", + "name": "instance", + "types": [ + "uint32_t" + ] + } + ], "notes": [], - "brief": "Gameobject properties handle", + "brief": "Retrieve an instance index from the index pool for...", "examples": "", "members": [], "error": "", "tparams": [], - "type": "TYPEDEF", - "name": "HProperties" + "type": "FUNCTION", + "name": "AcquireInstanceIndex" }, { "replaces": "", - "description": "Result enumeration.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "result enumeration", - "examples": "", - "members": [ - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_OK" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_OUT_OF_RESOURCES" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_ALREADY_REGISTERED" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_IDENTIFIER_IN_USE" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_IDENTIFIER_ALREADY_SET" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_COMPONENT_NOT_FOUND" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_MAXIMUM_HIEARCHICAL_DEPTH" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_INVALID_OPERATION" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_RESOURCE_TYPE_NOT_FOUND" - }, + "description": "Assign an index to the instance, only if the instance is not null.", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_BUFFER_OVERFLOW" + "doc": "The index to assign.", + "name": "index", + "types": [ + "uint32_t" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::RESULT_UNKNOWN_ERROR" + "doc": "The instance that should be assigned the index.", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "Assign an index to the instance, only if the insta...", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "Result" + "type": "FUNCTION", + "name": "AssignInstanceIndex" }, { "replaces": "", - "description": "Property types.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "property types", - "examples": "", - "members": [ - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_NUMBER" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_HASH" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_URL" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_VECTOR3" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_VECTOR4" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_QUAT" - }, + "description": "Get instance identifier", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_BOOLEAN" - }, + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_TYPE_COUNT" + "doc": "Identifier. dmGameObject::UNNAMED_IDENTIFIER if not set.", + "name": "", + "types": [ + "dmhash_t" + ] } ], + "notes": [], + "brief": "Get instance identifier", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "PropertyType" + "type": "FUNCTION", + "name": "GetIdentifier" }, { "replaces": "", - "description": "Property result.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "property result", - "examples": "", - "members": [ - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_OK" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_NOT_FOUND" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_INVALID_FORMAT" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_TYPE" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_TYPE_MISMATCH" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_COMP_NOT_FOUND" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_INVALID_INSTANCE" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_BUFFER_OVERFLOW" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_VALUE" - }, + "description": "Set instance identifier. Must be unique within the collection.", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_UNSUPPORTED_OPERATION" + "doc": "Collection", + "name": "collection", + "types": [ + "dmGameObject::HCollection" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_RESOURCE_NOT_FOUND" + "doc": "Instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_INVALID_INDEX" - }, + "doc": "Identifier", + "name": "identifier", + "types": [ + "dmhash_t" + ] + } + ], + "returnvalues": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROPERTY_RESULT_INVALID_KEY" + "doc": "RESULT_OK on success", + "name": "result", + "types": [ + "dmGameObject::Result" + ] } ], - "error": "", - "tparams": [], - "type": "ENUM", - "name": "PropertyResult" - }, - { - "replaces": "", - "description": "Playback type enum", - "parameters": [], - "returnvalues": [], "notes": [], - "brief": "Playback type enum", + "brief": "Set instance identifier. Must be unique within the...", "examples": "", "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "Playback" + "type": "FUNCTION", + "name": "SetIdentifier" }, { "replaces": "", - "description": "Create result enum.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Create result enum", - "examples": "", - "members": [ + "description": "Get component id from component index.", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::CREATE_RESULT_OK" + "doc": "Instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::CREATE_RESULT_UNKNOWN_ERROR" + "doc": "Component index", + "name": "component_index", + "types": [ + "uint16_t" + ] + }, + { + "doc": "[type: dmhash_t* Component id as out-argument", + "name": "component_id", + "types": [ + "" + ] + } + ], + "returnvalues": [ + { + "doc": "RESULT_OK if the comopnent was found", + "name": "result", + "types": [ + "dmGameObject::Result" + ] } ], + "notes": [], + "brief": "Get component id from component index.", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "CreateResult" + "type": "FUNCTION", + "name": "GetComponentId" }, { "replaces": "", - "description": "Update result enum.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Update result enum", - "examples": "", - "members": [ + "description": "Set gameobject instance position", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::UPDATE_RESULT_OK" + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::UPDATE_RESULT_UNKNOWN_ERROR" + "doc": "New Position", + "name": "position", + "types": [ + "dmGameObject::Point3" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set position", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "UpdateResult" + "type": "FUNCTION", + "name": "SetPosition" }, { "replaces": "", - "description": "Type of property value", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Type of property value", - "examples": "", - "members": [ + "description": "Get gameobject instance position", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROP_VALUE_ARRAY" - }, + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ { - "doc": "", - "type": "", - "name": "dmGameObject::PROP_VALUE_HASHTABLE" + "doc": "Position", + "name": "", + "types": [ + "dmGameObject::Point3" + ] } ], + "notes": [], + "brief": "get position", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "PropertyValueType" + "type": "FUNCTION", + "name": "GetPosition" }, { "replaces": "", - "description": "Parameters variant that holds key or index for a propertys data structure.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Property Options", - "examples": "", - "members": [ - { - "doc": "The index of the property to set, only applicable if property is array.", - "type": "int32_t", - "name": "m_Index" - }, + "description": "Set gameobject instance rotation", + "parameters": [ { - "doc": "The key of the property to set, only applicable if property is hashtable.", - "type": "dmhash_t", - "name": "m_Key" + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] }, { - "doc": "A flag if structure contain m_Key value (it can't contain both)", - "type": "uint8_t", - "name": "m_HasKey" + "doc": "New Position", + "name": "position", + "types": [ + "" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set rotation", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "PropertyOptions" + "type": "FUNCTION", + "name": "SetRotation" }, { "replaces": "", - "description": "Property variant that holds the data for a variable", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "property variant", - "examples": "", - "members": [ - { - "doc": "property type", - "type": "dmGameObject::PropertyType", - "name": "m_Type" - }, - { - "doc": "A floating point value (union)", - "type": "double", - "name": "m_Number" - }, - { - "doc": "A hash value (union)", - "type": "dmhash_t", - "name": "m_Hash" - }, - { - "doc": "An URL value (union)", - "type": "const uin8_t*", - "name": "m_Url" - }, + "description": "Get gameobject instance rotation", + "parameters": [ { - "doc": "A vector4 value (union)", - "type": "float", - "name": "m_V4" - }, + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ { - "doc": "A boolean value (union)", - "type": "bool", - "name": "m_Bool" + "doc": "rotation", + "name": "", + "types": [ + "dmGameObject::Quat" + ] } ], + "notes": [], + "brief": "get rotation", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "PropertyVar" + "type": "FUNCTION", + "name": "GetRotation" }, { "replaces": "", - "description": "Description of a property.\nIf the property is externally mutable, m_ValuePtr points to the value and its length is m_ElementCount.\nm_Variant always reflects the value.", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Description of a property", - "examples": "", - "members": [ - { - "doc": "For composite properties (float arrays), these ids name each element", - "type": "dmhash_t", - "name": "m_ElementIds" - }, - { - "doc": "Variant holding the value", - "type": "PropertyVar", - "name": "m_Variant" - }, - { - "doc": "Pointer to the value, only set for mutable values. The actual data type is described by the variant.", - "type": "float*", - "name": "m_ValuePtr" - }, + "description": "Set gameobject instance uniform scale", + "parameters": [ { - "doc": "Determines whether we are permitted to write to this property.", - "type": "bool", - "name": "m_ReadOnly" + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] }, { - "doc": "Indicates type of the property.", - "type": "uint8_t", - "name": "m_ValueType" + "doc": "New uniform scale", + "name": "scale", + "types": [ + "" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set uniform scale", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "PropertyDesc" + "type": "FUNCTION", + "name": "SetScale" }, { "replaces": "", - "description": "Update context", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Update context", - "examples": "", - "members": [ + "description": "Set gameobject instance non-uniform scale", + "parameters": [ { - "doc": "the delta time elapsed since last frame (seconds)", - "type": "float", - "name": "m_DT" + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + }, + { + "doc": "New uniform scale", + "name": "scale", + "types": [ + "" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set scale", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "UpdateContext" + "type": "FUNCTION", + "name": "SetScale" }, { "replaces": "", - "description": "Container of input related information.", - "parameters": [], - "returnvalues": [], + "description": "Get gameobject instance uniform scale", + "parameters": [ + { + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ + { + "doc": "Uniform scale", + "name": "", + "types": [ + "float" + ] + } + ], "notes": [], - "brief": "Container of input related information.", + "brief": "get uniform scale", "examples": "", "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "InputAction" + "type": "FUNCTION", + "name": "GetUniformScale" }, { "replaces": "", - "description": "Input result enum", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "Input result enum", - "examples": "", - "members": [ - { - "doc": "= 0", - "type": "", - "name": "INPUT_RESULT_IGNORED" - }, + "description": "Get gameobject instance scale", + "parameters": [ { - "doc": "= 1", - "type": "", - "name": "INPUT_RESULT_CONSUMED" - }, + "doc": "Gameobject instance", + "name": "instance", + "types": [ + "dmGameObject::HInstance" + ] + } + ], + "returnvalues": [ { - "doc": "= -1000", - "type": "", - "name": "INPUT_RESULT_UNKNOWN_ERROR" + "doc": "Non-uniform scale", + "name": "", + "types": [ + "dmGameObject::Vector3" + ] } ], + "notes": [], + "brief": "get scale", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "InputResult" + "type": "FUNCTION", + "name": "GetScale" }, { "replaces": "", - "description": "Retrieve the message socket for the specified collection.", + "description": "Get gameobject instance world position", "parameters": [ { - "doc": "Collection handle", - "name": "collection", + "doc": "Gameobject instance", + "name": "instance", "types": [ - "dmGameObject::HCollection" + "dmGameObject::HInstance" ] } ], "returnvalues": [ { - "doc": "The message socket of the specified collection", - "name": "socket", + "doc": "World position", + "name": "", "types": [ - "dmMessage::HSocket" + "dmGameObject::Point3" ] } ], "notes": [], - "brief": "Retrieve the message socket for the specified coll...", + "brief": "get world position", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetMessageSocket" + "name": "GetWorldPosition" }, { "replaces": "", - "description": "Retrieve a collection from the specified instance", + "description": "Get gameobject instance world rotation", "parameters": [ { - "doc": "Game object instance", + "doc": "Gameobject instance", "name": "instance", "types": [ "dmGameObject::HInstance" @@ -1418,1259 +1213,1464 @@ ], "returnvalues": [ { - "doc": "The collection the specified instance belongs to", - "name": "collection", + "doc": "World rotation", + "name": "", "types": [ - "dmGameObject::HInstance" + "dmGameObject::Quat" ] } ], "notes": [], - "brief": "Retrieve a collection from the specified instance", + "brief": "get world rotation", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetCollection" + "name": "GetWorldRotation" }, { "replaces": "", - "description": "Create a new gameobject instance", + "description": "Get game object instance world transform", "parameters": [ { - "doc": "Gameobject collection", - "name": "collection", - "types": [ - "dmGameObject::HCollection" - ] - }, - { - "doc": "|type: const char*] Prototype file name. May be 0.", - "name": "prototype_name", + "doc": "Gameobject instance", + "name": "instance", "types": [ - "" + "dmGameObject::HInstance" ] } ], "returnvalues": [ { - "doc": "New gameobject instance. NULL if any error occured", - "name": "instance", + "doc": "World scale", + "name": "", "types": [ - "dmGameObject::HInstance" + "dmGameObject::Vector3" ] } ], "notes": [], - "brief": "Create a new gameobject instance", + "brief": "get world scale", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "New" + "name": "GetWorldScale" }, { "replaces": "", - "description": "Delete gameobject instance", + "description": "Get game object instance uniform scale", "parameters": [ - { - "doc": "Gameobject collection", - "name": "collection", - "types": [ - "dmGameObject::HCollection" - ] - }, { "doc": "Gameobject instance", "name": "instance", "types": [ "dmGameObject::HInstance" ] - }, + } + ], + "returnvalues": [ { - "doc": "If true, delete child hierarchy recursively in child to parent order (leaf first)", - "name": "recursive", + "doc": "World uniform scale", + "name": "", "types": [ - "bool" + "float" ] } ], - "returnvalues": [], "notes": [], - "brief": "Delete gameobject instance", + "brief": "get world uniform scale", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "Delete" + "name": "GetWorldUniformScale" }, { "replaces": "", - "description": "Construct a hash of an instance id based on the index provided.", + "description": "Get game object instance world transform as Matrix4.", "parameters": [ { - "doc": "The index to base the id off of.", - "name": "index", + "doc": "Gameobject instance", + "name": "instance", "types": [ - "uint32_t" + "dmGameObject::HInstance" ] } ], "returnvalues": [ { - "doc": "hash of the instance id constructed.", - "name": "id", + "doc": "World transform matrix.", + "name": "", "types": [ - "dmhash_t" + "dmGameObject::MAtrix4" ] } ], "notes": [], - "brief": "Construct a hash of an instance id based on the in...", + "brief": "get world matrix", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "ConstructInstanceId" + "name": "GetWorldMatrix" }, { "replaces": "", - "description": "Retrieve an instance index from the index pool for the collection.", + "description": "Get game object instance world transform", "parameters": [ { - "doc": "Collection from which to retrieve the instance index.", - "name": "collection", + "doc": "Gameobject instance", + "name": "instance", "types": [ - "dmGameObject::HColleciton" + "dmGameObject::HInstance" ] } ], "returnvalues": [ { - "doc": "index from the index pool of collection.", - "name": "instance", + "doc": "World transform", + "name": "", "types": [ - "uint32_t" + "dmTransform::Transform" ] } ], "notes": [], - "brief": "Retrieve an instance index from the index pool for...", + "brief": "get world transform", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "AcquireInstanceIndex" + "name": "GetWorldTransform" }, { "replaces": "", - "description": "Assign an index to the instance, only if the instance is not null.", + "description": "Set whether the instance should be flagged as a bone.\nInstances flagged as bones can have their transforms updated in a batch through SetBoneTransforms.\nUsed for animated skeletons.", "parameters": [ { - "doc": "The index to assign.", - "name": "index", + "doc": "Instance", + "name": "instance", "types": [ - "uint32_t" + "HImstance" ] }, { - "doc": "The instance that should be assigned the index.", - "name": "instance", + "doc": "true if the instance is a bone", + "name": "bone", "types": [ - "dmGameObject::HInstance" + "bool" ] } ], "returnvalues": [], "notes": [], - "brief": "Assign an index to the instance, only if the insta...", + "brief": "Set whether the instance should be flagged as a bo...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "AssignInstanceIndex" + "name": "SetBone" }, { "replaces": "", - "description": "Get instance identifier", + "description": "Check whether the instance is flagged as a bone.", "parameters": [ { - "doc": "Gameobject instance", + "doc": "Instance", "name": "instance", "types": [ - "dmGameObject::HInstance" + "HImstance" ] } ], "returnvalues": [ { - "doc": "Identifier. dmGameObject::UNNAMED_IDENTIFIER if not set.", - "name": "", + "doc": "True if flagged as a bone", + "name": "result", "types": [ - "dmhash_t" + "bool" ] } ], "notes": [], - "brief": "Get instance identifier", + "brief": "Check whether the instance is flagged as a bone.", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetIdentifier" + "name": "IsBone" }, { "replaces": "", - "description": "Set instance identifier. Must be unique within the collection.", + "description": "Set the local transforms recursively of all instances flagged as bones, starting with component with id.\nThe order of the transforms is depth-first.", "parameters": [ { - "doc": "Collection", - "name": "collection", + "doc": "First Instance of the hierarchy to set", + "name": "instance", "types": [ - "dmGameObject::HCollection" + "HImstance" ] }, { - "doc": "Instance", - "name": "instance", + "doc": "the transform for component root", + "name": "component_transform", "types": [ - "dmGameObject::HInstance" + "dmTransform::Transform" ] }, { - "doc": "Identifier", - "name": "identifier", + "doc": "Array of transforms to set depth-first for the bone instances", + "name": "transforms", "types": [ - "dmhash_t" + "" + ] + }, + { + "doc": "Size of the transforms array", + "name": "transform_count", + "types": [ + "" ] } ], "returnvalues": [ { - "doc": "RESULT_OK on success", - "name": "result", + "doc": "of instances found", + "name": "Number", "types": [ - "dmGameObject::Result" + "" ] } ], "notes": [], - "brief": "Set instance identifier. Must be unique within the...", + "brief": "Set the local transforms recursively of all instan...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetIdentifier" + "name": "SetBoneTransforms" }, { "replaces": "", - "description": "Get component id from component index.", + "description": "Recursively delete all instances flagged as bones under the given parent instance.\nThe order of deletion is depth-first, so that the children are deleted before the parents.", "parameters": [ { - "doc": "Instance", - "name": "instance", + "doc": "Parent instance of the hierarchy", + "name": "parent", "types": [ - "dmGameObject::HInstance" + "HInstance" ] - }, + } + ], + "returnvalues": [], + "notes": [], + "brief": "Recursively delete all instances flagged as bones ...", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "DeleteBones" + }, + { + "replaces": "", + "description": "Opaque struct that holds info about the current node", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "scene graph traversal node", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "STRUCT", + "name": "SceneNode" + }, + { + "replaces": "", + "description": "Opaque struct that holds info about the current position when traversing the scene", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "scene graph traversal iterator", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "STRUCT", + "name": "SceneNodeIterator" + }, + { + "replaces": "", + "description": "Gets the top node of the whole game (the main collection)", + "parameters": [ { - "doc": "Component index", - "name": "component_index", + "doc": "the full gameobject register", + "name": "regist", "types": [ - "uint16_t" + "dmGameObject::HRegister" ] }, { - "doc": "[type: dmhash_t* Component id as out-argument", - "name": "component_id", + "doc": "the node to inspect", + "name": "node", "types": [ - "" + "dmGameObject::HRegister" ] } ], "returnvalues": [ { - "doc": "RESULT_OK if the comopnent was found", + "doc": "True if successful", "name": "result", "types": [ - "dmGameObject::Result" + "bool" ] } ], "notes": [], - "brief": "Get component id from component index.", - "examples": "", + "brief": "Gets the top node of the whole game (the main coll...", + "examples": "The following examples show how to iterate over currently loaded scene graph\n
void OutputNode(dmGameObject::SceneNode* node) {\n    dmGameObject::SceneNodeIterator it = dmGameObject::TraverseIterateChildren(node);\n    while(dmGameObject::TraverseIterateNext(&it))\n    {\n        OutputProperties(&it.m_Node); // see dmGameObject::TraverseIterateProperties()\n        OutputNode(&it.m_Node);\n    }\n}\n\nbool OutputScene(HRegister regist) {\n    dmGameObject::SceneNode root;\n    if (!dmGameObject::TraverseGetRoot(regist, &root))\n        return false;\n    OutputNode(&node);\n}\n
", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetComponentId" + "name": "TraverseGetRoot" }, { "replaces": "", - "description": "Set gameobject instance position", + "description": "Get a scene node iterator for the nodes' children", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the parent node", + "name": "node", "types": [ - "dmGameObject::HInstance" + "dmGameObject::SceneNode*" ] - }, + } + ], + "returnvalues": [ { - "doc": "New Position", - "name": "position", + "doc": "the iterator", + "name": "iterator", "types": [ - "dmGameObject::Point3" + "dmGameObject::SceneNodeIterator" ] } ], - "returnvalues": [], "notes": [], - "brief": "set position", + "brief": "Get a scene node iterator for the nodes' children", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetPosition" + "name": "TraverseIterateChildren" }, { "replaces": "", - "description": "Get gameobject instance position", + "description": "Step a scene node iterator to the next sibling", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the iterator", + "name": "it", "types": [ - "dmGameObject::HInstance" + "dmGameObject::SceneNodeIterator*" ] } ], "returnvalues": [ { - "doc": "Position", - "name": "", + "doc": "true if successful. false if the iterator is finished", + "name": "result", "types": [ - "dmGameObject::Point3" + "bool" ] } ], "notes": [], - "brief": "get position", + "brief": "Step a scene node iterator to the next sibling", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetPosition" + "name": "TraverseIterateNext" }, { "replaces": "", - "description": "Set gameobject instance rotation", - "parameters": [ + "description": "scene node property types", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "scene node property types", + "examples": "", + "members": [ { - "doc": "Gameobject instance", - "name": "instance", - "types": [ - "dmGameObject::HInstance" - ] + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_NUMBER" }, { - "doc": "New Position", - "name": "position", - "types": [ - "" - ] + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_HASH" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_URL" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_VECTOR3" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_VECTOR4" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_QUAT" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_BOOLEAN" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_TEXT" + }, + { + "doc": "", + "type": "", + "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_COUNT" } ], + "error": "", + "tparams": [], + "type": "ENUM", + "name": "SceneNodePropertyType" + }, + { + "replaces": "", + "description": "Struct that holds info about the current position when traversing the scene", + "parameters": [], "returnvalues": [], "notes": [], - "brief": "set rotation", + "brief": "scene traversal node property", "examples": "", - "members": [], + "members": [ + { + "doc": "name", + "type": "dmhash_t", + "name": "m_NameHash" + }, + { + "doc": "type", + "type": "dmGameObject::SceneNodePropertyType", + "name": "m_Type" + }, + { + "doc": "value\n
\n
m_Number
\n
double floating point number
\n
m_Hash
\n
dmhash_t The hashed value.
\n
m_URL
\n
char[1024] The text representation of the url (if reverse hashes are enabled)
\n
m_V4
\n
float[4] Used for Vector3, Vector4 and Quat
\n
m_Bool
\n
bool A boolean value
\n
m_Text
\n
const char* Text from a text property
\n
", + "type": "union", + "name": "m_Value" + } + ], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "SetRotation" + "type": "STRUCT", + "name": "SceneNodeProperty" }, { "replaces": "", - "description": "Get gameobject instance rotation", + "description": "Holds the property", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "scene traversal node property", + "examples": "", + "members": [ + { + "doc": "property", + "type": "dmGameObject::SceneNodeProperty", + "name": "m_Property" + } + ], + "error": "", + "tparams": [], + "type": "STRUCT", + "name": "SceneNodePropertyIterator" + }, + { + "replaces": "", + "description": "Create a scene node traversal property iterator", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the node to inspect", + "name": "node", "types": [ - "dmGameObject::HInstance" + "dmGameObject::SceneNode*" ] } ], "returnvalues": [ { - "doc": "rotation", - "name": "", + "doc": "the property iterator", + "name": "iterator", "types": [ - "dmGameObject::Quat" + "dmGameObject::SceneNodePropertyIterator" ] } ], "notes": [], - "brief": "get rotation", - "examples": "", + "brief": "Create a scene node traversal property iterator", + "examples": "The following examples show how to iterate over the properties of a node\n
dmGameObject::SceneNodePropertyIterator pit = TraverseIterateProperties(node);\nwhile(dmGameObject::TraverseIteratePropertiesNext(&pit))\n{\n    const char* name = dmHashReverseSafe64(pit.m_Property.m_NameHash);\n    switch(pit.m_Property.m_Type)\n    {\n    case dmGameObject::SCENE_NODE_PROPERTY_TYPE_NUMBER: ...\n    ...\n    }\n}\n
", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetRotation" + "name": "TraverseIterateProperties" }, { "replaces": "", - "description": "Set gameobject instance uniform scale", + "description": "Steps the scene node traversal property iterator to the next property", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the iterator", + "name": "it", "types": [ - "dmGameObject::HInstance" + "dmGameObject::SceneNodePropertyIterator*" ] - }, + } + ], + "returnvalues": [ { - "doc": "New uniform scale", - "name": "scale", + "doc": "True if the iterator it valid, false if the iterator is finished.", + "name": "finished", "types": [ - "" + "bool" ] } ], - "returnvalues": [], "notes": [], - "brief": "set uniform scale", + "brief": "Steps the scene node traversal property iterator t...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetScale" + "name": "TraverseIteratePropertiesNext" }, { "replaces": "", - "description": "Set gameobject instance non-uniform scale", + "description": "Get component user data from a url.\nThe object referenced by the url must be in the same collection as the caller.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "Lua state", + "name": "L", "types": [ - "dmGameObject::HInstance" + "lua_State*" ] }, { - "doc": "New uniform scale", - "name": "scale", + "doc": "index to argument (a url)", + "name": "index", "types": [ - "" + "lua_State*" + ] + }, + { + "doc": "the call will fail if the found component does not have the specified extension", + "name": "component_type", + "types": [ + "const char*" + ] + }, + { + "doc": "The world associated owning the component. May be 0", + "name": "world", + "types": [ + "void**" + ] + }, + { + "doc": "The component data associated with the url. May be 0", + "name": "component", + "types": [ + "void**" + ] + }, + { + "doc": "The resolved url. May be 0", + "name": "url", + "types": [ + "dmMessage::URL*" ] } ], "returnvalues": [], "notes": [], - "brief": "set scale", + "brief": "Get component user data from a url", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetScale" + "name": "GetComponentFromLua" }, { "replaces": "", - "description": "Get gameobject instance uniform scale", + "description": "Sends a script message. Wraps the message in a dmGameSystemDDF::ScriptMessage struct.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "The ddf message to send", + "name": "message", + "types": [ + "TDDFType*" + ] + }, + { + "doc": "The sender", + "name": "sender", + "types": [ + "dmMessage::Message*" + ] + }, + { + "doc": "The receiver", + "name": "receiver", + "types": [ + "dmMessage::Message*" + ] + }, + { + "doc": "The function ref. 0 wil cause the \"on_message\" to be called", + "name": "function_ref", + "types": [ + "int" + ] + }, + { + "doc": "call dmScript::UnrefInInstance on the function_ref after the dmScript::PCall is made", + "name": "unref_function_after_call", "types": [ - "dmGameObject::HInstance" + "bool" ] } ], "returnvalues": [ { - "doc": "Uniform scale", - "name": "", + "doc": "true if successful", + "name": "success", "types": [ - "float" + "bool" ] } ], "notes": [], - "brief": "get uniform scale", + "brief": "Sends a script message", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetUniformScale" + "name": "dmScript::PostDDF" }, { "replaces": "", - "description": "Get gameobject instance scale", - "parameters": [ - { - "doc": "Gameobject instance", - "name": "instance", - "types": [ - "dmGameObject::HInstance" - ] - } - ], - "returnvalues": [ - { - "doc": "Non-uniform scale", - "name": "", - "types": [ - "dmGameObject::Vector3" - ] - } - ], + "description": "Callback when iterating over the properties for a component.", + "parameters": [], + "returnvalues": [], "notes": [], - "brief": "get scale", + "brief": "Callback when iterating over the properties for a ...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetScale" + "name": "" }, { "replaces": "", - "description": "Get gameobject instance world position", + "description": "Get the component type index. Used for with e.g. dmGameObject::GetWorld()/GetContext()", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] } ], "returnvalues": [ { - "doc": "World position", - "name": "", + "doc": "The type index.", + "name": "type_index", "types": [ - "dmGameObject::Point3" + "uint32_t" ] } ], "notes": [], - "brief": "get world position", + "brief": "Get the component type index. Used for with e.g. d...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldPosition" + "name": "ComponentTypeGetTypeIndex" }, { "replaces": "", - "description": "Get gameobject instance world rotation", + "description": "Set the new world callback. Called when a collection (i.e. a \"world\") is created.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "World rotation", - "name": "", + "doc": "callback", + "name": "fn", "types": [ - "dmGameObject::Quat" + "ComponentNewWorld" ] } ], + "returnvalues": [], "notes": [], - "brief": "get world rotation", + "brief": "set the new world callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldRotation" + "name": "ComponentTypeSetNewWorldFn" }, { "replaces": "", - "description": "Get game object instance world transform", + "description": "Set the world destroy callback. Called when a collection (i.e. a \"world\") is destroyed.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "World scale", - "name": "", + "doc": "callback", + "name": "fn", "types": [ - "dmGameObject::Vector3" + "ComponentDeleteWorld" ] } ], + "returnvalues": [], "notes": [], - "brief": "get world scale", + "brief": "set the world destroy callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldScale" + "name": "ComponentTypeSetDeleteWorldFn" }, { "replaces": "", - "description": "Get game object instance uniform scale", + "description": "Set the component create callback. Called when a component instance is created.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "World uniform scale", - "name": "", + "doc": "callback", + "name": "fn", "types": [ - "float" + "ComponentCreate" ] } ], + "returnvalues": [], "notes": [], - "brief": "get world uniform scale", + "brief": "set the component create callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldUniformScale" + "name": "ComponentTypeSetCreateFn" }, { "replaces": "", - "description": "Get game object instance world transform as Matrix4.", + "description": "Set the component destroy callback. Called when a component instance is destroyed.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "World transform matrix.", - "name": "", + "doc": "callback", + "name": "fn", "types": [ - "dmGameObject::MAtrix4" + "ComponentDestroy" ] } ], + "returnvalues": [], "notes": [], - "brief": "get world matrix", + "brief": "set the component destroy callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldMatrix" + "name": "ComponentTypeSetDestroyFn" }, { "replaces": "", - "description": "Get game object instance world transform", + "description": "Set the component init callback. Called on each gameobject's components, during a gameobject's initialization.", "parameters": [ { - "doc": "Gameobject instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HInstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "World transform", - "name": "", + "doc": "callback", + "name": "fn", "types": [ - "dmTransform::Transform" + "ComponentInit" ] } ], + "returnvalues": [], "notes": [], - "brief": "get world transform", + "brief": "set the component init callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetWorldTransform" + "name": "ComponentTypeSetInitFn" }, { "replaces": "", - "description": "Set whether the instance should be flagged as a bone.\nInstances flagged as bones can have their transforms updated in a batch through SetBoneTransforms.\nUsed for animated skeletons.", + "description": "Set the component finalize callback. Called on each gameobject's components, during a gameobject's finalization.", "parameters": [ { - "doc": "Instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "HImstance" + "ComponentType*" ] }, { - "doc": "true if the instance is a bone", - "name": "bone", + "doc": "callback", + "name": "fn", "types": [ - "bool" + "ComponentFinal" ] } ], "returnvalues": [], "notes": [], - "brief": "Set whether the instance should be flagged as a bo...", + "brief": "set the component finalize callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetBone" + "name": "ComponentTypeSetFinalFn" }, { "replaces": "", - "description": "Check whether the instance is flagged as a bone.", + "description": "Set the component add-to-update callback. Called for each component instal, when the game object is spawned.", "parameters": [ { - "doc": "Instance", - "name": "instance", + "doc": "the type", + "name": "type", "types": [ - "HImstance" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "True if flagged as a bone", - "name": "result", + "doc": "callback", + "name": "fn", "types": [ - "bool" + "ComponentAddToUpdate" ] } ], + "returnvalues": [], "notes": [], - "brief": "Check whether the instance is flagged as a bone.", + "brief": "set the component add-to-update callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "IsBone" + "name": "ComponentTypeSetAddToUpdateFn" }, { "replaces": "", - "description": "Set the local transforms recursively of all instances flagged as bones, starting with component with id.\nThe order of the transforms is depth-first.", + "description": "Set the component get callback. Called when the scripts want to retrieve the individual component user data given an url.", "parameters": [ { - "doc": "First Instance of the hierarchy to set", - "name": "instance", - "types": [ - "HImstance" - ] - }, - { - "doc": "the transform for component root", - "name": "component_transform", - "types": [ - "dmTransform::Transform" - ] - }, - { - "doc": "Array of transforms to set depth-first for the bone instances", - "name": "transforms", + "doc": "the type", + "name": "type", "types": [ - "" + "ComponentType*" ] }, { - "doc": "Size of the transforms array", - "name": "transform_count", - "types": [ - "" - ] - } - ], - "returnvalues": [ - { - "doc": "of instances found", - "name": "Number", + "doc": "callback", + "name": "fn", "types": [ - "" + "ComponentGet" ] } ], + "returnvalues": [], "notes": [], - "brief": "Set the local transforms recursively of all instan...", + "brief": "set the component get callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetBoneTransforms" + "name": "ComponentTypeSetGetFn" }, { "replaces": "", - "description": "Recursively delete all instances flagged as bones under the given parent instance.\nThe order of deletion is depth-first, so that the children are deleted before the parents.", + "description": "Set the component render callback. Called when it's time to render all component instances.", "parameters": [ { - "doc": "Parent instance of the hierarchy", - "name": "parent", + "doc": "the type", + "name": "type", "types": [ - "HInstance" + "ComponentType*" + ] + }, + { + "doc": "callback", + "name": "fn", + "types": [ + "ComponentsRender" ] } ], "returnvalues": [], "notes": [], - "brief": "Recursively delete all instances flagged as bones ...", + "brief": "set the component render callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "DeleteBones" + "name": "ComponentTypeSetRenderFn" }, { "replaces": "", - "description": "Opaque struct that holds info about the current node", - "parameters": [], + "description": "Set the component update callback. Called when it's time to update all component instances.", + "parameters": [ + { + "doc": "the type", + "name": "type", + "types": [ + "ComponentType*" + ] + }, + { + "doc": "callback", + "name": "fn", + "types": [ + "ComponentsUpdate" + ] + } + ], "returnvalues": [], "notes": [], - "brief": "scene graph traversal node", + "brief": "set the component update callback", "examples": "", "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "SceneNode" + "type": "FUNCTION", + "name": "ComponentTypeSetUpdateFn" }, { "replaces": "", - "description": "Opaque struct that holds info about the current position when traversing the scene", - "parameters": [], + "description": "Set the component post update callback. Called for each collection after the update, before the render.", + "parameters": [ + { + "doc": "the type", + "name": "type", + "types": [ + "ComponentType*" + ] + }, + { + "doc": "callback", + "name": "fn", + "types": [ + "ComponentsPostUpdate" + ] + } + ], "returnvalues": [], "notes": [], - "brief": "scene graph traversal iterator", + "brief": "set the component post update callback", "examples": "", "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "SceneNodeIterator" + "type": "FUNCTION", + "name": "ComponentTypeSetPostUpdateFn" }, { "replaces": "", - "description": "Gets the top node of the whole game (the main collection)", + "description": "Set the component on-message callback. Called multiple times per frame, to flush messages.", "parameters": [ { - "doc": "the full gameobject register", - "name": "regist", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::HRegister" + "ComponentType*" ] }, { - "doc": "the node to inspect", - "name": "node", + "doc": "callback", + "name": "fn", "types": [ - "dmGameObject::HRegister" + "ComponentOnMessage" ] } ], - "returnvalues": [ + "returnvalues": [], + "notes": [], + "brief": "set the component on-message callback", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "ComponentTypeSetOnMessageFn" + }, + { + "replaces": "", + "description": "Set the component on-input callback. Called once per frame, before the Update function.", + "parameters": [ { - "doc": "True if successful", - "name": "result", + "doc": "the type", + "name": "type", "types": [ - "bool" + "ComponentType*" + ] + }, + { + "doc": "callback", + "name": "fn", + "types": [ + "ComponentOnInput" ] } ], + "returnvalues": [], "notes": [], - "brief": "Gets the top node of the whole game (the main coll...", - "examples": "The following examples show how to iterate over currently loaded scene graph\n
void OutputNode(dmGameObject::SceneNode* node) {\n    dmGameObject::SceneNodeIterator it = dmGameObject::TraverseIterateChildren(node);\n    while(dmGameObject::TraverseIterateNext(&it))\n    {\n        OutputProperties(&it.m_Node); // see dmGameObject::TraverseIterateProperties()\n        OutputNode(&it.m_Node);\n    }\n}\n\nbool OutputScene(HRegister regist) {\n    dmGameObject::SceneNode root;\n    if (!dmGameObject::TraverseGetRoot(regist, &root))\n        return false;\n    OutputNode(&node);\n}\n
", + "brief": "set the component on-input callback", + "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "TraverseGetRoot" + "name": "ComponentTypeSetOnInputFn" }, { "replaces": "", - "description": "Get a scene node iterator for the nodes' children", + "description": "Set the component on-reload callback. Called when the resource of a component instance is reloaded.", "parameters": [ { - "doc": "the parent node", - "name": "node", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::SceneNode*" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "the iterator", - "name": "iterator", + "doc": "callback", + "name": "fn", "types": [ - "dmGameObject::SceneNodeIterator" + "ComponentOnReload" ] } ], + "returnvalues": [], "notes": [], - "brief": "Get a scene node iterator for the nodes' children", + "brief": "set the component on-reload callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "TraverseIterateChildren" + "name": "ComponentTypeSetOnReloadFn" }, { "replaces": "", - "description": "Step a scene node iterator to the next sibling", + "description": "Set the component set properties callback. Called when the component instance is being spwned.", "parameters": [ { - "doc": "the iterator", - "name": "it", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::SceneNodeIterator*" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "true if successful. false if the iterator is finished", - "name": "result", + "doc": "callback", + "name": "fn", "types": [ - "bool" + "ComponentSetProperties" ] } ], + "returnvalues": [], "notes": [], - "brief": "Step a scene node iterator to the next sibling", + "brief": "set the component set properties callback", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "TraverseIterateNext" + "name": "ComponentTypeSetSetPropertiesFn" }, { "replaces": "", - "description": "scene node property types", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "scene node property types", - "examples": "", - "members": [ - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_NUMBER" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_HASH" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_URL" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_VECTOR3" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_VECTOR4" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_QUAT" - }, - { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_BOOLEAN" - }, + "description": "Set the component get property callback. Called when accessing a property via go.get()", + "parameters": [ { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_TEXT" + "doc": "the type", + "name": "type", + "types": [ + "ComponentType*" + ] }, { - "doc": "", - "type": "", - "name": "dmGameObject::SCENE_NODE_PROPERTY_TYPE_COUNT" + "doc": "callback", + "name": "fn", + "types": [ + "ComponentGetProperty" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set the component get property callback", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "ENUM", - "name": "SceneNodePropertyType" + "type": "FUNCTION", + "name": "ComponentTypeSetGetPropertyFn" }, { "replaces": "", - "description": "Struct that holds info about the current position when traversing the scene", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "scene traversal node property", - "examples": "", - "members": [ - { - "doc": "name", - "type": "dmhash_t", - "name": "m_NameHash" - }, - { - "doc": "type", - "type": "dmGameObject::SceneNodePropertyType", - "name": "m_Type" + "description": "Set the component set property callback. Called when accessing a property via go.set()", + "parameters": [ + { + "doc": "the type", + "name": "type", + "types": [ + "ComponentType*" + ] }, { - "doc": "value\n
\n
m_Number
\n
double floating point number
\n
m_Hash
\n
dmhash_t The hashed value.
\n
m_URL
\n
char[1024] The text representation of the url (if reverse hashes are enabled)
\n
m_V4
\n
float[4] Used for Vector3, Vector4 and Quat
\n
m_Bool
\n
bool A boolean value
\n
m_Text
\n
const char* Text from a text property
\n
", - "type": "union", - "name": "m_Value" + "doc": "callback", + "name": "fn", + "types": [ + "ComponentSetProperty" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set the component set property callback", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "SceneNodeProperty" + "type": "FUNCTION", + "name": "ComponentTypeSetSetPropertyFn" }, { "replaces": "", - "description": "Holds the property", - "parameters": [], - "returnvalues": [], - "notes": [], - "brief": "scene traversal node property", - "examples": "", - "members": [ + "description": "Set the component type global context. Usually set when registering the component type.", + "parameters": [ { - "doc": "property", - "type": "dmGameObject::SceneNodeProperty", - "name": "m_Property" + "doc": "the type", + "name": "type", + "types": [ + "ComponentType*" + ] + }, + { + "doc": "component type global context", + "name": "context", + "types": [ + "void*" + ] } ], + "returnvalues": [], + "notes": [], + "brief": "set the component type global context", + "examples": "", + "members": [], "error": "", "tparams": [], - "type": "STRUCT", - "name": "SceneNodePropertyIterator" + "type": "FUNCTION", + "name": "ComponentTypeSetContext" }, { "replaces": "", - "description": "Create a scene node traversal property iterator", + "description": "get the component type global context", "parameters": [ { - "doc": "the node to inspect", - "name": "node", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::SceneNode*" + "ComponentType*" ] } ], "returnvalues": [ { - "doc": "the property iterator", - "name": "iterator", + "doc": "component type global context", + "name": "context", "types": [ - "dmGameObject::SceneNodePropertyIterator" + "void*" ] } ], "notes": [], - "brief": "Create a scene node traversal property iterator", - "examples": "The following examples show how to iterate over the properties of a node\n
dmGameObject::SceneNodePropertyIterator pit = TraverseIterateProperties(node);\nwhile(dmGameObject::TraverseIteratePropertiesNext(&pit))\n{\n    const char* name = dmHashReverseSafe64(pit.m_Property.m_NameHash);\n    switch(pit.m_Property.m_Type)\n    {\n    case dmGameObject::SCENE_NODE_PROPERTY_TYPE_NUMBER: ...\n    ...\n    }\n}\n
", + "brief": "get the component type global context", + "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "TraverseIterateProperties" + "name": "ComponentTypeGetContext" }, { "replaces": "", - "description": "Steps the scene node traversal property iterator to the next property", + "description": "Set the component type transform dependency flag.\nIf this flag is set, it might trigger an dmGameObject::UpdateTransforms() (if there are dirty transforms)", "parameters": [ { - "doc": "the iterator", - "name": "it", + "doc": "the type", + "name": "type", "types": [ - "dmGameObject::SceneNodePropertyIterator*" + "ComponentType*" ] - } - ], - "returnvalues": [ + }, { - "doc": "True if the iterator it valid, false if the iterator is finished.", - "name": "finished", + "doc": "transform dependency flag", + "name": "reads_transforms", "types": [ "bool" ] } ], + "returnvalues": [], "notes": [], - "brief": "Steps the scene node traversal property iterator t...", + "brief": "set the component type transform dependency flag", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "TraverseIteratePropertiesNext" + "name": "ComponentTypeSetReadsTransforms" }, { "replaces": "", - "description": "Get component user data from a url.\nThe object referenced by the url must be in the same collection as the caller.", + "description": "Set the component type prio order. Defines the update order of the component types.", "parameters": [ { - "doc": "Lua state", - "name": "L", + "doc": "the type", + "name": "type", "types": [ - "lua_State*" + "ComponentType*" ] }, { - "doc": "index to argument (a url)", - "name": "index", + "doc": "prio order", + "name": "prio", "types": [ - "lua_State*" + "uint16_t" ] - }, + } + ], + "returnvalues": [], + "notes": [], + "brief": "set the component type prio order", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "ComponentTypeSetPrio" + }, + { + "replaces": "", + "description": "Set the component type need for a per component instance user data. Defaults to true.", + "parameters": [ { - "doc": "the call will fail if the found component does not have the specified extension", - "name": "component_type", + "doc": "the type", + "name": "type", "types": [ - "const char*" + "ComponentType*" ] }, { - "doc": "The world associated owning the component. May be 0", - "name": "world", + "doc": "does each component instance need user data", + "name": "has_user_data", "types": [ - "void**" + "bool" ] - }, + } + ], + "returnvalues": [], + "notes": [], + "brief": "set the component type need for a per component instance user data", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "ComponentTypeSetHasUserData" + }, + { + "replaces": "", + "description": "set the component child iterator function. Called during inspection", + "parameters": [ { - "doc": "The component data associated with the url. May be 0", - "name": "component", + "doc": "the type", + "name": "type", "types": [ - "void**" + "ComponentType*" ] }, { - "doc": "The resolved url. May be 0", - "name": "url", + "doc": "child iterator function", + "name": "fn", "types": [ - "dmMessage::URL*" + "FIteratorChildren" ] } ], "returnvalues": [], "notes": [], - "brief": "Get component user data from a url", + "brief": "set the component child iterator function", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetComponentFromLua" + "name": "ComponentTypeSetChildIteratorFn" }, { "replaces": "", - "description": "Sends a script message. Wraps the message in a dmGameSystemDDF::ScriptMessage struct.", + "description": "set the component property iterator function. Called during inspection", "parameters": [ { - "doc": "The ddf message to send", - "name": "message", + "doc": "the type", + "name": "type", "types": [ - "TDDFType*" + "ComponentType*" ] }, { - "doc": "The sender", - "name": "sender", + "doc": "property iterator function", + "name": "fn", "types": [ - "dmMessage::Message*" + "FIteratorProperties" ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "set the component property iterator function", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "ComponentTypeSetPropertyIteratorFn" + }, + { + "replaces": "", + "description": "Context used when registering a new component type", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Context used when registering a new component type", + "examples": "", + "members": [ + { + "doc": "The config file", + "type": "dmConfigFile::HConfig", + "name": "m_Config" }, { - "doc": "The receiver", - "name": "receiver", - "types": [ - "dmMessage::Message*" - ] + "doc": "The resource factory", + "type": "dmResource::HFactory", + "name": "m_Factory" }, { - "doc": "The function ref. 0 wil cause the \"on_message\" to be called", - "name": "function_ref", - "types": [ - "int" - ] + "doc": "The game object registry", + "type": "dmGameObject::HRegister", + "name": "m_Register" }, { - "doc": "call dmScript::UnrefInInstance on the function_ref after the dmScript::PCall is made", - "name": "unref_function_after_call", - "types": [ - "bool" - ] - } - ], - "returnvalues": [ + "doc": "The shared script context", + "type": "dmScript::HContext", + "name": "m_Script" + }, { - "doc": "true if successful", - "name": "success", - "types": [ - "bool" - ] + "doc": "Mappings between names and contextx", + "type": "dmHashTable64", + "name": "m_Contexts" } ], - "notes": [], - "brief": "Sends a script message", - "examples": "", - "members": [], "error": "", "tparams": [], - "type": "FUNCTION", - "name": "dmScript::PostDDF" + "type": "STRUCT", + "name": "ComponentTypeCreateCtx" } ] } \ No newline at end of file diff --git a/DefoldDocs/doc/dmGraphics_doc.json b/DefoldDocs/doc/dmGraphics_doc.json index b7c221d..85ca40c 100644 --- a/DefoldDocs/doc/dmGraphics_doc.json +++ b/DefoldDocs/doc/dmGraphics_doc.json @@ -1,343 +1,14 @@ { "info": { - "description": "<dmsdk/graphics/graphics.h>\nGraphics API", + "group": "DEFOLD SDK", + "description": "Platform specific native graphics functions.", "namespace": "dmGraphics", - "brief": "Graphics API documentation", - "file": "", - "path": "", + "brief": "SDK Graphics API documentation", + "file": "dmsdk/graphics/graphics_native.h", + "path": "engine/dlib/src/dmsdk/graphics/graphics_native.h", "name": "Graphics" }, "elements": [ - { - "replaces": "", - "description": "Get iOS UIWindow native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get iOS UIWindow", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeiOSUIWindow" - }, - { - "replaces": "", - "description": "Get iOS UIView native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get iOS UIView", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeiOSUIView" - }, - { - "replaces": "", - "description": "Get iOS EAGLContext native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get iOS EAGLContext", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeiOSEAGLContext" - }, - { - "replaces": "", - "description": "Get OSX NSWindow native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get OSX NSWindow", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeOSXNSWindow" - }, - { - "replaces": "", - "description": "Get OSX NSView native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get OSX NSView", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeOSXNSView" - }, - { - "replaces": "", - "description": "Get OSX NSOpenGLContext native handle (id). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "id", - "types": [ - "id" - ] - } - ], - "notes": [], - "brief": "get OSX NSOpenGLContext", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeOSXNSOpenGLContext" - }, - { - "replaces": "", - "description": "Get Win32 windows native handle (HWND). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "HWND", - "types": [ - "HWND" - ] - } - ], - "notes": [], - "brief": "get Win32 HWND", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeWindowsHWND" - }, - { - "replaces": "", - "description": "Get Win32 gl rendercontext native handle (HGLRC). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "HGLRC", - "types": [ - "HGLRC" - ] - } - ], - "notes": [], - "brief": "get Win32 HGLRC", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeWindowsHGLRC" - }, - { - "replaces": "", - "description": "Get Android EGLContext native handle (EGLContext). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "EGLContext", - "types": [ - "EGLContext" - ] - } - ], - "notes": [], - "brief": "get Android EGLContext", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeAndroidEGLContext" - }, - { - "replaces": "", - "description": "Get Android EGLSurface native handle (EGLSurface). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "EGLSurface", - "types": [ - "EGLSurface" - ] - } - ], - "notes": [], - "brief": "get Android EGLSurface", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeAndroidEGLSurface" - }, - { - "replaces": "", - "description": "Get Android JavaVM ptr. Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "JavaVM*", - "types": [ - "JavaVM*" - ] - } - ], - "notes": [], - "brief": "get Android native JavaVM", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeAndroidJavaVM" - }, - { - "replaces": "", - "description": "Get Android native jobject. Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "jobject", - "types": [ - "jobject" - ] - } - ], - "notes": [], - "brief": "get Android native jobject", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeAndroidActivity" - }, - { - "replaces": "", - "description": "Get Android app object. Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "app", - "types": [ - "struct android_app*" - ] - } - ], - "notes": [], - "brief": "get Android app object", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeAndroidApp" - }, - { - "replaces": "", - "description": "Get Linux X11Window windows native handle (Window). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "Window", - "types": [ - "Window" - ] - } - ], - "notes": [], - "brief": "get Linux X11Window", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeX11Window" - }, - { - "replaces": "", - "description": "Get Linux X11GLXContext native handle (GLXContext). Any other platform return zero.", - "parameters": [], - "returnvalues": [ - { - "doc": "native handle", - "name": "GLXContext", - "types": [ - "GLXContext" - ] - } - ], - "notes": [], - "brief": "get Linux X11GLXContext", - "examples": "", - "members": [], - "error": "", - "tparams": [], - "type": "FUNCTION", - "name": "dmGraphics::GetNativeX11GLXContext" - }, { "replaces": "", "description": "Context handle", @@ -956,70 +627,259 @@ ] }, { - "doc": "the array of vertex elements", - "name": "element", + "doc": "the array of vertex elements", + "name": "element", + "types": [ + "dmGraphics::VertexElement*" + ] + }, + { + "doc": "the number of items in the element array", + "name": "count", + "types": [ + "uint32_t" + ] + }, + { + "doc": "the stride between the start of each vertex (in bytes)", + "name": "stride", + "types": [ + "uint32_t" + ] + } + ], + "returnvalues": [ + { + "doc": "the vertex declaration", + "name": "declaration", + "types": [ + "dmGraphics::HVertexDeclaration" + ] + } + ], + "notes": [], + "brief": "Create new vertex declaration", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "NewVertexDeclaration" + }, + { + "replaces": "", + "description": "Delete vertex declaration", + "parameters": [ + { + "doc": "the vertex declaration", + "name": "vertex_declaration", + "types": [ + "dmGraphics::HVertexDeclaration" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Delete vertex declaration", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "DeleteVertexDeclaration" + }, + { + "replaces": "", + "description": "Create new vertex buffer with initial data", + "parameters": [ + { + "doc": "the context", + "name": "context", + "types": [ + "dmGraphics::HContext" + ] + }, + { + "doc": "the size of the buffer (in bytes). May be 0", + "name": "size", + "types": [ + "uint32_t" + ] + }, + { + "doc": "the data", + "name": "data", + "types": [ + "void*" + ] + }, + { + "doc": "the usage", + "name": "buffer_usage", + "types": [ + "dmGraphics::BufferUsage" + ] + } + ], + "returnvalues": [ + { + "doc": "the vertex buffer", + "name": "buffer", + "types": [ + "dmGraphics::HVertexBuffer" + ] + } + ], + "notes": [], + "brief": "Create new vertex buffer with initial data", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "NewVertexBuffer" + }, + { + "replaces": "", + "description": "Delete vertex buffer", + "parameters": [ + { + "doc": "the buffer", + "name": "buffer", + "types": [ + "dmGraphics::HVertexBuffer" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Delete vertex buffer", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "DeleteVertexBuffer" + }, + { + "replaces": "", + "description": "Set vertex buffer data", + "parameters": [ + { + "doc": "the buffer", + "name": "buffer", + "types": [ + "dmGraphics::HVertexBuffer" + ] + }, + { + "doc": "the size of the buffer (in bytes). May be 0", + "name": "size", + "types": [ + "uint32_t" + ] + }, + { + "doc": "the data", + "name": "data", + "types": [ + "void*" + ] + }, + { + "doc": "the usage", + "name": "buffer_usage", + "types": [ + "dmGraphics::BufferUsage" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Set vertex buffer data", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "SetVertexBufferData" + }, + { + "replaces": "", + "description": "Set subset of vertex buffer data", + "parameters": [ + { + "doc": "the buffer", + "name": "buffer", "types": [ - "dmGraphics::VertexElement*" + "dmGraphics::HVertexBuffer" ] }, { - "doc": "the number of items in the element array", - "name": "count", + "doc": "the offset into the desination buffer (in bytes)", + "name": "offset", "types": [ "uint32_t" ] }, { - "doc": "the stride between the start of each vertex (in bytes)", - "name": "stride", + "doc": "the size of the buffer (in bytes). May be 0", + "name": "size", "types": [ "uint32_t" ] - } - ], - "returnvalues": [ + }, { - "doc": "the vertex declaration", - "name": "declaration", + "doc": "the data", + "name": "data", "types": [ - "dmGraphics::HVertexDeclaration" + "void*" ] } ], + "returnvalues": [], "notes": [], - "brief": "Create new vertex declaration", + "brief": "Set subset of vertex buffer data", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "NewVertexDeclaration" + "name": "SetVertexBufferSubData" }, { "replaces": "", - "description": "Delete vertex declaration", + "description": "Get the max number of vertices allowed by the system in a vertex buffer", "parameters": [ { - "doc": "the vertex declaration", - "name": "vertex_declaration", + "doc": "the context", + "name": "context", "types": [ - "dmGraphics::HVertexDeclaration" + "dmGraphics::HContext" + ] + } + ], + "returnvalues": [ + { + "doc": "the count", + "name": "count", + "types": [ + "uint32_t" ] } ], - "returnvalues": [], "notes": [], - "brief": "Delete vertex declaration", + "brief": "Get the max number of vertices allowed by the syst...", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "DeleteVertexDeclaration" + "name": "GetMaxElementsVertices" }, { "replaces": "", - "description": "Create new vertex buffer with initial data", + "description": "Create new index buffer with initial data", "parameters": [ { "doc": "the context", @@ -1052,53 +912,53 @@ ], "returnvalues": [ { - "doc": "the vertex buffer", + "doc": "the index buffer", "name": "buffer", "types": [ - "dmGraphics::HVertexBuffer" + "dmGraphics::HIndexBuffer" ] } ], "notes": [], - "brief": "Create new vertex buffer with initial data", + "brief": "Create new index buffer with initial data", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "NewVertexBuffer" + "name": "NewIndexBuffer" }, { "replaces": "", - "description": "Delete vertex buffer", + "description": "Delete the index buffer", "parameters": [ { - "doc": "the buffer", + "doc": "the index buffer", "name": "buffer", "types": [ - "dmGraphics::HVertexBuffer" + "dmGraphics::HIndexBuffer" ] } ], "returnvalues": [], "notes": [], - "brief": "Delete vertex buffer", + "brief": "Delete the index buffer", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "DeleteVertexBuffer" + "name": "DeleteIndexBuffer" }, { "replaces": "", - "description": "Set vertex buffer data", + "description": "Set index buffer data", "parameters": [ { "doc": "the buffer", "name": "buffer", "types": [ - "dmGraphics::HVertexBuffer" + "dmGraphics::HIndexBuffer" ] }, { @@ -1125,17 +985,17 @@ ], "returnvalues": [], "notes": [], - "brief": "Set vertex buffer data", + "brief": "Set index buffer data", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetVertexBufferData" + "name": "SetIndexBufferData" }, { "replaces": "", - "description": "Set subset of vertex buffer data", + "description": "Set subset of index buffer data", "parameters": [ { "doc": "the buffer", @@ -1159,277 +1019,418 @@ ] }, { - "doc": "the data", - "name": "data", + "doc": "the data", + "name": "data", + "types": [ + "void*" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Set subset of index buffer data", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "SetIndexBufferSubData" + }, + { + "replaces": "", + "description": "Check if the index format is supported", + "parameters": [ + { + "doc": "the context", + "name": "context", + "types": [ + "dmGraphics::HContext" + ] + }, + { + "doc": "the format", + "name": "format", + "types": [ + "dmGraphics::IndexBufferFormat" + ] + }, + { + "doc": "true if the format is supoprted", + "name": "result", + "types": [ + "bool" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "Check if the index format is supported", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "IsIndexBufferFormatSupported" + }, + { + "replaces": "", + "description": "Get the max number of indices allowed by the system in an index buffer", + "parameters": [ + { + "doc": "the context", + "name": "context", + "types": [ + "dmGraphics::HContext" + ] + } + ], + "returnvalues": [ + { + "doc": "the count", + "name": "count", + "types": [ + "uint32_t" + ] + } + ], + "notes": [], + "brief": "Get the max number of indices allowed by the syste...", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "GetMaxElementsIndices" + }, + { + "replaces": "", + "description": "Get iOS UIWindow native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ + { + "doc": "native handle", + "name": "id", + "types": [ + "id" + ] + } + ], + "notes": [], + "brief": "get iOS UIWindow", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeiOSUIWindow" + }, + { + "replaces": "", + "description": "Get iOS UIView native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ + { + "doc": "native handle", + "name": "id", + "types": [ + "id" + ] + } + ], + "notes": [], + "brief": "get iOS UIView", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeiOSUIView" + }, + { + "replaces": "", + "description": "Get iOS EAGLContext native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ + { + "doc": "native handle", + "name": "id", + "types": [ + "id" + ] + } + ], + "notes": [], + "brief": "get iOS EAGLContext", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeiOSEAGLContext" + }, + { + "replaces": "", + "description": "Get OSX NSWindow native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ + { + "doc": "native handle", + "name": "id", + "types": [ + "id" + ] + } + ], + "notes": [], + "brief": "get OSX NSWindow", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeOSXNSWindow" + }, + { + "replaces": "", + "description": "Get OSX NSView native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ + { + "doc": "native handle", + "name": "id", "types": [ - "void*" + "id" ] } ], - "returnvalues": [], "notes": [], - "brief": "Set subset of vertex buffer data", + "brief": "get OSX NSView", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetVertexBufferSubData" + "name": "dmGraphics::GetNativeOSXNSView" }, { "replaces": "", - "description": "Get the max number of vertices allowed by the system in a vertex buffer", - "parameters": [ + "description": "Get OSX NSOpenGLContext native handle (id). Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the context", - "name": "context", + "doc": "native handle", + "name": "id", "types": [ - "dmGraphics::HContext" + "id" ] } ], + "notes": [], + "brief": "get OSX NSOpenGLContext", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeOSXNSOpenGLContext" + }, + { + "replaces": "", + "description": "Get Win32 windows native handle (HWND). Any other platform return zero.", + "parameters": [], "returnvalues": [ { - "doc": "the count", - "name": "count", + "doc": "native handle", + "name": "HWND", "types": [ - "uint32_t" + "HWND" ] } ], "notes": [], - "brief": "Get the max number of vertices allowed by the syst...", + "brief": "get Win32 HWND", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetMaxElementsVertices" + "name": "dmGraphics::GetNativeWindowsHWND" }, { "replaces": "", - "description": "Create new index buffer with initial data", - "parameters": [ - { - "doc": "the context", - "name": "context", - "types": [ - "dmGraphics::HContext" - ] - }, - { - "doc": "the size of the buffer (in bytes). May be 0", - "name": "size", - "types": [ - "uint32_t" - ] - }, - { - "doc": "the data", - "name": "data", - "types": [ - "void*" - ] - }, + "description": "Get Win32 gl rendercontext native handle (HGLRC). Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the usage", - "name": "buffer_usage", + "doc": "native handle", + "name": "HGLRC", "types": [ - "dmGraphics::BufferUsage" + "HGLRC" ] } ], + "notes": [], + "brief": "get Win32 HGLRC", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeWindowsHGLRC" + }, + { + "replaces": "", + "description": "Get Android EGLContext native handle (EGLContext). Any other platform return zero.", + "parameters": [], "returnvalues": [ { - "doc": "the index buffer", - "name": "buffer", + "doc": "native handle", + "name": "EGLContext", "types": [ - "dmGraphics::HIndexBuffer" + "EGLContext" ] } ], "notes": [], - "brief": "Create new index buffer with initial data", + "brief": "get Android EGLContext", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "NewIndexBuffer" + "name": "dmGraphics::GetNativeAndroidEGLContext" }, { "replaces": "", - "description": "Delete the index buffer", - "parameters": [ + "description": "Get Android EGLSurface native handle (EGLSurface). Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the index buffer", - "name": "buffer", + "doc": "native handle", + "name": "EGLSurface", "types": [ - "dmGraphics::HIndexBuffer" + "EGLSurface" ] } ], - "returnvalues": [], "notes": [], - "brief": "Delete the index buffer", + "brief": "get Android EGLSurface", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "DeleteIndexBuffer" + "name": "dmGraphics::GetNativeAndroidEGLSurface" }, { "replaces": "", - "description": "Set index buffer data", - "parameters": [ - { - "doc": "the buffer", - "name": "buffer", - "types": [ - "dmGraphics::HIndexBuffer" - ] - }, - { - "doc": "the size of the buffer (in bytes). May be 0", - "name": "size", - "types": [ - "uint32_t" - ] - }, - { - "doc": "the data", - "name": "data", - "types": [ - "void*" - ] - }, + "description": "Get Android JavaVM ptr. Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the usage", - "name": "buffer_usage", + "doc": "native handle", + "name": "JavaVM*", "types": [ - "dmGraphics::BufferUsage" + "JavaVM*" ] } ], - "returnvalues": [], "notes": [], - "brief": "Set index buffer data", + "brief": "get Android native JavaVM", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetIndexBufferData" + "name": "dmGraphics::GetNativeAndroidJavaVM" }, { "replaces": "", - "description": "Set subset of index buffer data", - "parameters": [ - { - "doc": "the buffer", - "name": "buffer", - "types": [ - "dmGraphics::HVertexBuffer" - ] - }, - { - "doc": "the offset into the desination buffer (in bytes)", - "name": "offset", - "types": [ - "uint32_t" - ] - }, - { - "doc": "the size of the buffer (in bytes). May be 0", - "name": "size", - "types": [ - "uint32_t" - ] - }, + "description": "Get Android native jobject. Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the data", - "name": "data", + "doc": "native handle", + "name": "jobject", "types": [ - "void*" + "jobject" ] } ], - "returnvalues": [], "notes": [], - "brief": "Set subset of index buffer data", + "brief": "get Android native jobject", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "SetIndexBufferSubData" + "name": "dmGraphics::GetNativeAndroidActivity" }, { "replaces": "", - "description": "Check if the index format is supported", - "parameters": [ - { - "doc": "the context", - "name": "context", - "types": [ - "dmGraphics::HContext" - ] - }, - { - "doc": "the format", - "name": "format", - "types": [ - "dmGraphics::IndexBufferFormat" - ] - }, + "description": "Get Android app object. Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "true if the format is supoprted", - "name": "result", + "doc": "native handle", + "name": "app", "types": [ - "bool" + "struct android_app*" ] } ], - "returnvalues": [], "notes": [], - "brief": "Check if the index format is supported", + "brief": "get Android app object", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "IsIndexBufferFormatSupported" + "name": "dmGraphics::GetNativeAndroidApp" }, { "replaces": "", - "description": "Get the max number of indices allowed by the system in an index buffer", - "parameters": [ + "description": "Get Linux X11Window windows native handle (Window). Any other platform return zero.", + "parameters": [], + "returnvalues": [ { - "doc": "the context", - "name": "context", + "doc": "native handle", + "name": "Window", "types": [ - "dmGraphics::HContext" + "Window" ] } ], + "notes": [], + "brief": "get Linux X11Window", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmGraphics::GetNativeX11Window" + }, + { + "replaces": "", + "description": "Get Linux X11GLXContext native handle (GLXContext). Any other platform return zero.", + "parameters": [], "returnvalues": [ { - "doc": "the count", - "name": "count", + "doc": "native handle", + "name": "GLXContext", "types": [ - "uint32_t" + "GLXContext" ] } ], "notes": [], - "brief": "Get the max number of indices allowed by the syste...", + "brief": "get Linux X11GLXContext", "examples": "", "members": [], "error": "", "tparams": [], "type": "FUNCTION", - "name": "GetMaxElementsIndices" + "name": "dmGraphics::GetNativeX11GLXContext" } ] } \ No newline at end of file diff --git a/DefoldDocs/doc/dmLog_doc.json b/DefoldDocs/doc/dmLog_doc.json index 6a05385..926ecd3 100644 --- a/DefoldDocs/doc/dmLog_doc.json +++ b/DefoldDocs/doc/dmLog_doc.json @@ -244,6 +244,153 @@ "tparams": [], "type": "FUNCTION", "name": "dmLogFatal" + }, + { + "replaces": "", + "description": "Log severity", + "parameters": [], + "returnvalues": [], + "notes": [], + "brief": "Log severity", + "examples": "", + "members": [ + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_DEBUG" + }, + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_USER_DEBUG" + }, + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_INFO" + }, + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_WARNING" + }, + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_ERROR" + }, + { + "doc": "", + "type": "", + "name": "dmLog::LOG_SEVERITY_FATAL" + } + ], + "error": "", + "tparams": [], + "type": "ENUM", + "name": "dmLog::Severity" + }, + { + "replaces": "", + "description": "dmLog listener function type. Provides all logs from dmLog* functions and print/pprint Lua functions.\nUsed with dmLogRegisterListener() and dmLogUnregisterListener()", + "parameters": [ + { + "doc": "", + "name": "severity", + "types": [ + "dmLog::Severity" + ] + }, + { + "doc": "", + "name": "domain", + "types": [ + "const char*" + ] + }, + { + "doc": "null terminated string", + "name": "formatted_string", + "types": [ + "const char*" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "dmLog:LogListener callback typedef", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "TYPEDEF", + "name": "dmLog:LogListener" + }, + { + "replaces": "", + "description": "Registers a dmLog listener.\nThis listener recieve logs even in release bundle.", + "parameters": [ + { + "doc": "", + "name": "listener", + "types": [ + "dmLog::LogListener" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "register dmLog listener.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmLog::RegisterLogListener" + }, + { + "replaces": "", + "description": "Unregisters a dmLog listener.", + "parameters": [ + { + "doc": "listener", + "name": "[type:dmLog::LogListener]", + "types": [ + "" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "unregister dmLog listener.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmLog::UnregisterLogListener" + }, + { + "replaces": "", + "description": "set log system severity level.", + "parameters": [ + { + "doc": "severity", + "name": "[type:dmLog::Severity]", + "types": [ + "" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "set log system severity level.", + "examples": "", + "members": [], + "error": "", + "tparams": [], + "type": "FUNCTION", + "name": "dmLog::Setlevel" } ] } \ No newline at end of file diff --git a/DefoldDocs/doc/dmScript_doc.json b/DefoldDocs/doc/dmScript_doc.json index 21ed010..7ad0756 100644 --- a/DefoldDocs/doc/dmScript_doc.json +++ b/DefoldDocs/doc/dmScript_doc.json @@ -260,7 +260,7 @@ }, { "replaces": "", - "description": "Get the value at index as a Vectormath::Aos::Vector3*", + "description": "Get the value at index as a dmVMath::Vector3*", "parameters": [ { "doc": "Lua state", @@ -282,12 +282,12 @@ "doc": "The pointer to the value, or 0 if not correct type", "name": "v", "types": [ - "Vectormath::Aos::Vector3*" + "dmVMath::Vector3*" ] } ], "notes": [], - "brief": "get the value at index as a Vectormath::Aos::Vector3*", + "brief": "get the value at index as a dmVMath::Vector3*", "examples": "", "members": [], "error": "", @@ -297,7 +297,7 @@ }, { "replaces": "", - "description": "Check if the value at #index is a Vectormath::Aos::Vector3*", + "description": "Check if the value at #index is a dmVMath::Vector3*", "parameters": [ { "doc": "Lua state", @@ -316,7 +316,7 @@ ], "returnvalues": [ { - "doc": "if value at #index is a Vectormath::Aos::Vector3*", + "doc": "if value at #index is a dmVMath::Vector3*", "name": "true", "types": [ "" @@ -324,7 +324,7 @@ } ], "notes": [], - "brief": "Check if the value at #index is a Vectormath::Aos:...", + "brief": "Check if the value at #index is a dmVMath::Vector3...", "examples": "", "members": [], "error": "", @@ -334,7 +334,7 @@ }, { "replaces": "", - "description": "Push a Vectormath::Aos::Vector3 value onto the supplied lua state, will increase the stack by 1.", + "description": "Push a dmVMath::Vector3 value onto the supplied lua state, will increase the stack by 1.", "parameters": [ { "doc": "Lua state", @@ -347,13 +347,13 @@ "doc": "Vector3 value to push", "name": "v", "types": [ - "Vectormath::Aos::Vector3" + "dmVMath::Vector3" ] } ], "returnvalues": [], "notes": [], - "brief": "push a Vectormath::Aos::Vector3 onto the Lua stack", + "brief": "push a dmVMath::Vector3 onto the Lua stack", "examples": "", "members": [], "error": "", @@ -363,7 +363,7 @@ }, { "replaces": "", - "description": "Check if the value in the supplied index on the lua stack is a Vectormath::Aos::Vector3.", + "description": "Check if the value in the supplied index on the lua stack is a dmVMath::Vector3.", "parameters": [ { "doc": "Lua state", @@ -385,12 +385,12 @@ "doc": "The pointer to the value", "name": "vector3", "types": [ - "Vectormath::Aos::Vector3*" + "dmVMath::Vector3*" ] } ], "notes": [], - "brief": "check if the value is a Vectormath::Aos::Vector3", + "brief": "check if the value is a dmVMath::Vector3", "examples": "", "members": [], "error": "", @@ -400,7 +400,7 @@ }, { "replaces": "", - "description": "Get the value at index as a Vectormath::Aos::Vector4*", + "description": "Get the value at index as a dmVMath::Vector4*", "parameters": [ { "doc": "Lua state", @@ -422,12 +422,12 @@ "doc": "The pointer to the value, or 0 if not correct type", "name": "v", "types": [ - "Vectormath::Aos::Vector4*" + "dmVMath::Vector4*" ] } ], "notes": [], - "brief": "get the value at index as a Vectormath::Aos::Vector4*", + "brief": "get the value at index as a dmVMath::Vector4*", "examples": "", "members": [], "error": "", @@ -437,7 +437,7 @@ }, { "replaces": "", - "description": "Check if the value at #index is a Vectormath::Aos::Vector4*", + "description": "Check if the value at #index is a dmVMath::Vector4*", "parameters": [ { "doc": "Lua state", @@ -456,7 +456,7 @@ ], "returnvalues": [ { - "doc": "if value at #index is a Vectormath::Aos::Vector4*", + "doc": "if value at #index is a dmVMath::Vector4*", "name": "true", "types": [ "" @@ -464,7 +464,7 @@ } ], "notes": [], - "brief": "Check if the value at #index is a Vectormath::Aos:...", + "brief": "Check if the value at #index is a dmVMath::Vector4...", "examples": "", "members": [], "error": "", @@ -474,7 +474,7 @@ }, { "replaces": "", - "description": "Push a Vectormath::Aos::Vector4 value onto the supplied lua state, will increase the stack by 1.", + "description": "Push a dmVMath::Vector4 value onto the supplied lua state, will increase the stack by 1.", "parameters": [ { "doc": "Lua state", @@ -484,16 +484,16 @@ ] }, { - "doc": "Vectormath::Aos::Vector4 value to push", + "doc": "dmVMath::Vector4 value to push", "name": "v", "types": [ - "Vectormath::Aos::Vector4" + "dmVMath::Vector4" ] } ], "returnvalues": [], "notes": [], - "brief": "push a Vectormath::Aos::Vector4 on the stack", + "brief": "push a dmVMath::Vector4 on the stack", "examples": "", "members": [], "error": "", @@ -503,7 +503,7 @@ }, { "replaces": "", - "description": "Check if the value in the supplied index on the lua stack is a Vectormath::Aos::Vector3.", + "description": "Check if the value in the supplied index on the lua stack is a dmVMath::Vector3.", "parameters": [ { "doc": "Lua state", @@ -525,12 +525,12 @@ "doc": "The pointer to the value", "name": "vector4", "types": [ - "Vectormath::Aos::Vector4*" + "dmVMath::Vector4*" ] } ], "notes": [], - "brief": "check if the value is a Vectormath::Aos::Vector3", + "brief": "check if the value is a dmVMath::Vector3", "examples": "", "members": [], "error": "", @@ -540,7 +540,7 @@ }, { "replaces": "", - "description": "Get the value at index as a Vectormath::Aos::Quat*", + "description": "Get the value at index as a dmVMath::Quat*", "parameters": [ { "doc": "Lua state", @@ -562,12 +562,12 @@ "doc": "The pointer to the value, or 0 if not correct type", "name": "quat", "types": [ - "Vectormath::Aos::Quat*" + "dmVMath::Quat*" ] } ], "notes": [], - "brief": "get the value at index as a Vectormath::Aos::Quat*", + "brief": "get the value at index as a dmVMath::Quat*", "examples": "", "members": [], "error": "", @@ -577,7 +577,7 @@ }, { "replaces": "", - "description": "Check if the value at #index is a Vectormath::Aos::Quat*", + "description": "Check if the value at #index is a dmVMath::Quat*", "parameters": [ { "doc": "Lua state", @@ -596,7 +596,7 @@ ], "returnvalues": [ { - "doc": "if value at #index is a Vectormath::Aos::Quat*", + "doc": "if value at #index is a dmVMath::Quat*", "name": "true", "types": [ "" @@ -604,7 +604,7 @@ } ], "notes": [], - "brief": "Check if the value at #index is a Vectormath::Aos:...", + "brief": "Check if the value at #index is a dmVMath::Quat*", "examples": "", "members": [], "error": "", @@ -624,16 +624,16 @@ ] }, { - "doc": "Vectormath::Aos::Quat value to push", + "doc": "dmVMath::Quat value to push", "name": "quat", "types": [ - "Vectormath::Aos::Quat" + "dmVMath::Quat" ] } ], "returnvalues": [], "notes": [], - "brief": "push a Vectormath::Aos::Quat onto the Lua stack", + "brief": "push a dmVMath::Quat onto the Lua stack", "examples": "", "members": [], "error": "", @@ -643,7 +643,7 @@ }, { "replaces": "", - "description": "Check if the value in the supplied index on the lua stack is a Vectormath::Aos::Quat.", + "description": "Check if the value in the supplied index on the lua stack is a dmVMath::Quat.", "parameters": [ { "doc": "Lua state", @@ -665,12 +665,12 @@ "doc": "The pointer to the value", "name": "quat", "types": [ - "Vectormath::Aos::Quat*" + "dmVMath::Quat*" ] } ], "notes": [], - "brief": "check if the value is a Vectormath::Aos::Vector3", + "brief": "check if the value is a dmVMath::Vector3", "examples": "", "members": [], "error": "", @@ -680,7 +680,7 @@ }, { "replaces": "", - "description": "Get the value at index as a Vectormath::Aos::Matrix4*", + "description": "Get the value at index as a dmVMath::Matrix4*", "parameters": [ { "doc": "Lua state", @@ -702,12 +702,12 @@ "doc": "The pointer to the value, or 0 if not correct type", "name": "quat", "types": [ - "Vectormath::Aos::Matrix4*" + "dmVMath::Matrix4*" ] } ], "notes": [], - "brief": "get the value at index as a Vectormath::Aos::Matrix4*", + "brief": "get the value at index as a dmVMath::Matrix4*", "examples": "", "members": [], "error": "", @@ -717,7 +717,7 @@ }, { "replaces": "", - "description": "Check if the value at #index is a Vectormath::Aos::Matrix4*", + "description": "Check if the value at #index is a dmVMath::Matrix4*", "parameters": [ { "doc": "Lua state", @@ -736,7 +736,7 @@ ], "returnvalues": [ { - "doc": "if value at #index is a Vectormath::Aos::Matrix4*", + "doc": "if value at #index is a dmVMath::Matrix4*", "name": "true", "types": [ "" @@ -744,7 +744,7 @@ } ], "notes": [], - "brief": "Check if the value at #index is a Vectormath::Aos:...", + "brief": "Check if the value at #index is a dmVMath::Matrix4...", "examples": "", "members": [], "error": "", @@ -764,16 +764,16 @@ ] }, { - "doc": "Vectormath::Aos::Matrix4 value to push", + "doc": "dmVMath::Matrix4 value to push", "name": "matrix", "types": [ - "Vectormath::Aos::Matrix4" + "dmVMath::Matrix4" ] } ], "returnvalues": [], "notes": [], - "brief": "push a Vectormath::Aos::Matrix4 onto the Lua stack", + "brief": "push a dmVMath::Matrix4 onto the Lua stack", "examples": "", "members": [], "error": "", @@ -783,7 +783,7 @@ }, { "replaces": "", - "description": "Check if the value in the supplied index on the lua stack is a Vectormath::Aos::Matrix4.", + "description": "Check if the value in the supplied index on the lua stack is a dmVMath::Matrix4.", "parameters": [ { "doc": "Lua state", @@ -805,12 +805,12 @@ "doc": "The pointer to the value", "name": "matrix", "types": [ - "Vectormath::Aos::Matrix4*" + "dmVMath::Matrix4*" ] } ], "notes": [], - "brief": "check if the value is a Vectormath::Aos::Matrix4", + "brief": "check if the value is a dmVMath::Matrix4", "examples": "", "members": [], "error": "", diff --git a/DefoldDocs/doc/dmStaticAssert_doc.json b/DefoldDocs/doc/dmStaticAssert_doc.json new file mode 100644 index 0000000..dcac0d9 --- /dev/null +++ b/DefoldDocs/doc/dmStaticAssert_doc.json @@ -0,0 +1,42 @@ +{ + "info": { + "group": "DEFOLD SDK", + "description": "
void test() {\n    DM_STATIC_ASSERT(sizeof(int) == 4, Invalid_int_size);\n}\n
", + "namespace": "dmStaticAssert", + "brief": "Static assert", + "file": "dmsdk/dlib/static_assert.h", + "path": "engine/dlib/src/dmsdk/dlib/static_assert.h", + "name": "Static Assert" + }, + "elements": [ + { + "replaces": "", + "description": "This is using C++11 static_assert on platforms that support it and use c++11. Otherwise\nit's using a c construct to check the condition.\nAs such, it is currently required to be used whithin a function scope.", + "parameters": [ + { + "doc": "expression", + "name": "x", + "types": [ + "bool" + ] + }, + { + "doc": "expression", + "name": "xmsg", + "types": [ + "string" + ] + } + ], + "returnvalues": [], + "notes": [], + "brief": "compile time assert", + "examples": "Verify the size of a struct is within a limit\n
DM_STATIC_ASSERT(sizeof(MyStruct) <= 32, Invalid_Struct_Size);\n
", + "members": [], + "error": "", + "tparams": [], + "type": "MACRO", + "name": "DM_STATIC_ASSERT" + } + ] +} \ No newline at end of file diff --git a/DefoldDocs/doc/dmThread_doc.json b/DefoldDocs/doc/dmThread_doc.json index 1320ef4..1530c35 100644 --- a/DefoldDocs/doc/dmThread_doc.json +++ b/DefoldDocs/doc/dmThread_doc.json @@ -52,7 +52,7 @@ ], "notes": [], "brief": "create a new thread", - "examples": "Create a thread\n
#include <dmsdh/sdk.h>\n\nstruct Context\n{\n    bool m_DoWork;\n    int  m_Work;\n};\n\nstatic void Worker(void* _ctx)\n{\n    Context* ctx = (Context*)_ctx;\n    while (ctx->m_DoWork)\n    {\n        ctx->m_Work++; // do work\n        dmTime::Sleep(10*1000); // yield\n    }\n}\n\nint StartThread()\n{\n    Context ctx;\n    ctx.m_DoWork = true;\n    ctx.m_Work = 0;\n    dmThread::Thread thread = dmThread::New(Worker, 0x80000, (void*)&ctx, "my_thread");\n\n    // do other work...\n    // ..eventually stop the thread:\n    ctx.m_DoWork = false;\n\n    // wait for thread\n    dmThread::Join(thread);\n\n    printf("work done: %d\\n", ctx.m_Work);\n}\n
", + "examples": "Create a thread\n
#include <dmsdk/sdk.h>\n\nstruct Context\n{\n    bool m_DoWork;\n    int  m_Work;\n};\n\nstatic void Worker(void* _ctx)\n{\n    Context* ctx = (Context*)_ctx;\n    while (ctx->m_DoWork)\n    {\n        ctx->m_Work++; // do work\n        dmTime::Sleep(10*1000); // yield\n    }\n}\n\nint StartThread()\n{\n    Context ctx;\n    ctx.m_DoWork = true;\n    ctx.m_Work = 0;\n    dmThread::Thread thread = dmThread::New(Worker, 0x80000, (void*)&ctx, "my_thread");\n\n    // do other work...\n    // ..eventually stop the thread:\n    ctx.m_DoWork = false;\n\n    // wait for thread\n    dmThread::Join(thread);\n\n    printf("work done: %d\\n", ctx.m_Work);\n}\n
", "members": [], "error": "", "tparams": [], diff --git a/DefoldDocs/doc/physics_doc.json b/DefoldDocs/doc/physics_doc.json index 6276ef3..0a2a129 100644 --- a/DefoldDocs/doc/physics_doc.json +++ b/DefoldDocs/doc/physics_doc.json @@ -834,7 +834,7 @@ ] }, { - "doc": "the new group name to be assigned.\n
function changeCollisionGroup()\n     physics.set_group("#collisionobject", "enemy")\nend\n
", + "doc": "the new group name to be assigned.\n
local function change_collision_group()\n     physics.set_group("#collisionobject", "enemy")\nend\n
", "name": "group", "types": [ "string" @@ -867,7 +867,7 @@ ], "returnvalues": [ { - "doc": "hash value of the group.\n
function checkIsEnemy()\n    local grp = physics.get_group("#collisionobject")\n    assert( grp == hash("enemy") )\nend\n
", + "doc": "hash value of the group.\n
local function check_is_enemy()\n    local group = physics.get_group("#collisionobject")\n    return group == hash("enemy")\nend\n
", "name": "", "types": [ "hash" @@ -904,8 +904,8 @@ ] }, { - "doc": "boolean value of the new maskbit. 'true' to enable, 'false' to disable.\n
function makeUserAlly()\n    -- no longer collide with the "user" group\n    physics.set_maskbit("#collisionobject","user",false)\nend\n
", - "name": "[type]", + "doc": "boolean value of the new maskbit. 'true' to enable, 'false' to disable.\n
local function make_invincible()\n    -- no longer collide with the "bullet" group\n    physics.set_maskbit("#collisionobject", "bullet", false)\nend\n
", + "name": "maskbit", "types": [ "boolean" ] @@ -944,7 +944,7 @@ ], "returnvalues": [ { - "doc": "boolean value of the maskbit. 'true' if present, 'false' otherwise.\n
function checkCollideWithUser()\n    -- to check if the collisionobject would collide with "user" group\n    local hits_user = physics.get_maskbit("#collisionobject","user")\n    return hits_user\nend\n
", + "doc": "boolean value of the maskbit. 'true' if present, 'false' otherwise.\n
local function is_invincible()\n    -- check if the collisionobject would collide with the "bullet" group\n    local invincible = physics.get_maskbit("#collisionobject", "bullet")\n    return invincible\nend\n
", "name": "", "types": [ "boolean" diff --git a/DefoldDocs/doc/sys_doc.json b/DefoldDocs/doc/sys_doc.json index bdc9f5d..6defcf7 100644 --- a/DefoldDocs/doc/sys_doc.json +++ b/DefoldDocs/doc/sys_doc.json @@ -282,7 +282,7 @@ "parameters": [], "returnvalues": [ { - "doc": "table with system information in the following fields:\n
\n
device_model
\n
string Only available on iOS and Android.
\n
manufacturer
\n
string Only available on iOS and Android.
\n
system_name
\n
string The system OS name: \"Darwin\", \"Linux\", \"Windows\", \"HTML5\", \"Android\" or \"iPhone OS\"
\n
system_version
\n
string The system OS version.
\n
api_version
\n
string The API version on the system.
\n
language
\n
string Two character ISO-639 format, i.e. \"en\".
\n
device_language
\n
string Two character ISO-639 format (i.e. \"sr\") and, if applicable, followed by a dash (-) and an ISO 15924 script code (i.e. \"sr-Cyrl\" or \"sr-Latn\"). Reflects the device preferred language.
\n
territory
\n
string Two character ISO-3166 format, i.e. \"US\".
\n
gmt_offset
\n
number The current offset from GMT (Greenwich Mean Time), in minutes.
\n
device_ident
\n
string \"identifierForVendor\" on iOS. \"android_id\" on Android. On Android, you need to add READ_PHONE_STATE permission to be able to get this data. We don't use this permission in Defold.
\n
user_agent
\n
string The HTTP user agent, i.e. \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 (KHTML, like Gecko) Version/10.0.3 Safari/602.4.8\"
\n
", + "doc": "table with system information in the following fields:\n
\n
device_model
\n
string Only available on iOS and Android.
\n
manufacturer
\n
string Only available on iOS and Android.
\n
system_name
\n
string The system name: \"Darwin\", \"Linux\", \"Windows\", \"HTML5\", \"Android\" or \"iPhone OS\"
\n
system_version
\n
string The system OS version.
\n
api_version
\n
string The API version on the system.
\n
language
\n
string Two character ISO-639 format, i.e. \"en\".
\n
device_language
\n
string Two character ISO-639 format (i.e. \"sr\") and, if applicable, followed by a dash (-) and an ISO 15924 script code (i.e. \"sr-Cyrl\" or \"sr-Latn\"). Reflects the device preferred language.
\n
territory
\n
string Two character ISO-3166 format, i.e. \"US\".
\n
gmt_offset
\n
number The current offset from GMT (Greenwich Mean Time), in minutes.
\n
device_ident
\n
string \"identifierForVendor\" on iOS. \"android_id\" on Android. On Android, you need to add READ_PHONE_STATE permission to be able to get this data. We don't use this permission in Defold.
\n
user_agent
\n
string The HTTP user agent, i.e. \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/602.4.8 (KHTML, like Gecko) Version/10.0.3 Safari/602.4.8\"
\n
", "name": "sys_info", "types": [ "table"