Defold GUI system
A handle to a gui context
A handle to a gui scene
A handle to a gui node
A handle to a gui script
A handle to a texture source, which can be a pointer to a resource, a dmGraphics::HTexture or a dynamic texture created from a gui script.
Invalid node handle
PLAYBACK_ONCE_FORWARD -
PLAYBACK_ONCE_BACKWARD -
PLAYBACK_ONCE_PINGPONG -
PLAYBACK_LOOP_FORWARD -
PLAYBACK_LOOP_BACKWARD -
PLAYBACK_LOOP_PINGPONG -
PLAYBACK_NONE -
ADJUST_REFERENCE_PARENT -
ADJUST_REFERENCE_DISABLED -
This enum denotes what kind of texture type the m_Texture pointer is referencing.
NODE_TEXTURE_TYPE_NONE -
NODE_TEXTURE_TYPE_TEXTURE -
NODE_TEXTURE_TYPE_TEXTURE_SET -
NODE_TEXTURE_TYPE_DYNAMIC -
NODE_TYPE_BOX - //!< 0,
NODE_TYPE_TEXT - //!< 1,
NODE_TYPE_PIE - //!< 2,
NODE_TYPE_TEMPLATE - //!< 3,
NODE_TYPE_PARTICLEFX - //!< 5,
NODE_TYPE_CUSTOM - //!< 6,
NODE_TYPE_COUNT - //!< 7,
RESULT_OK - //!< 0
RESULT_SYNTAX_ERROR - //!< -1
RESULT_SCRIPT_ERROR - //!< -2
RESULT_OUT_OF_RESOURCES - //!< -4
RESULT_RESOURCE_NOT_FOUND - //!< -5
RESULT_TEXTURE_ALREADY_EXISTS - //!< -6
RESULT_INVAL_ERROR - //!< -7
RESULT_INF_RECURSION - //!< -8
RESULT_DATA_ERROR - //!< -9
RESULT_WRONG_TYPE - //!< -10
scene - the gui scene
position - the position
size - the size
node_type - the node type
custom_type - If node_type == dmGui::NODE_TYPE_CUSTOM, then this is used to create a custom node data for the registered custom type
node - the created node
Defer delete a node
scene - the gui scene
node - the node to delete
Set the id of a node.
scene - the gui scene
node - the gui node
id - the id
Get the id of a node.
scene - the gui scene
node - the gui node
id - the id of the node
Set the parent of a gui node
scene - the gui scene
node - the gui node
parent - the new parent. May be null
keep_scene_transform - true to keep the world position
result - dmGui::RESULT_OK is successful
Get the parent of a gui node
scene - the gui scene
node - the gui node
parent - the parent, or INVALID_HANDLE is unsuccessful
Get first child node
scene - the gui scene
node - Gets the first child node. If 0, gets the first top level node.
child - The first child node
Get next sibling
scene - the gui scene
node - the current sibling
sibling - the next sibling, or INVALID_HANDLE if no more siblings
Query if the node is a bone
scene - the gui scene
node - the gui node
result - true if the node is a bone
Set the bone state of the node
scene - the gui scene
node - the gui node
is_bone - true if the node is ot be used as a bone
PROPERTY_POSITION - //!< 0
PROPERTY_ROTATION - //!< 1
PROPERTY_SCALE -
//!< 2
PROPERTY_COLOR -
//!< 3
PROPERTY_SIZE -
//!< 4
PROPERTY_OUTLINE -
//!< 5
PROPERTY_SHADOW -
//!< 6
PROPERTY_SLICE9 -
//!< 7
PROPERTY_PIE_PARAMS - //!< 8
PROPERTY_TEXT_PARAMS - //!< 9
PROPERTY_COUNT -
//!< 10
Get property value
scene - type: dmGui::HScene] scene
node - type: dmGui::HNode] node
property - property enum
value -
Set property value
scene - type: dmGui::HScene] scene
node - type: dmGui::HNode] node
property - property enum
value -
ADJUST_MODE_FIT -
//!< 0
ADJUST_MODE_ZOOM - //!< 1
ADJUST_MODE_STRETCH - //!< 2
Set adjust mode
scene - type: dmGui::HScene] scene
node - type: dmGui::HNode] node
adjust_mode - the adjust mode
get node custom type
scene - the gui scene
node - the gui node
type - the custom type. Or 0 if it is no custom type
get node custom data
scene - the gui scene
node - the gui node
data - the custom data created per node by the gui node type extension
get node texture
scene - the gui scene
node - the gui node
texture - the currently assigned texture
set node texture
scene - the gui scene
node - the gui node
texture_id - the texture id
set node texture
scene - the gui scene
node - the gui node
type - the type of texture
texture - A pointer to a e.g. dmGameSystem::TextureSetResource*
Gets a resource by its resource alias.
scene - the gui scene
resource_id - the resource alias
suffix_with_dot - the hash of the suffix: hash(".spinescenec")
resource - the resource if successful
Pushes a dmGui::HNode to the stack
L - the Lua scene
scene - the gui scene
node - the gui node