Defold c++

Defold lua

Extension

Version

gui

Version: stable

FUNCTIONS
gui.new_spine_node()
gui.play_spine_anim()
gui.cancel_spine()
gui.get_spine_bone()
gui.set_spine_scene()
gui.get_spine_scene()
gui.set_spine_skin()
gui.add_spine_skin()
gui.copy_spine_skin()
gui.clear_spine_skin()
gui.get_spine_skin()
gui.get_spine_animation()
gui.set_spine_cursor()
gui.get_spine_cursor()
gui.set_spine_playback_rate()
gui.get_spine_playback_rate()
gui.set_spine_attachment()
gui.set_spine_slot_color()
gui.spine_physics_translate()
gui.spine_physics_rotate()
gui.set_spine_ik_target_position()
gui.set_spine_ik_target()
gui.reset_spine_ik_target()

Functions

gui.new_spine_node()

gui.new_spine_node(pos,spine_scene)

Dynamically create a new spine node.

PARAMETERS

`pos`	`vector3` `vector4`	node position
`spine_scene`	`string` `hash`	spine scene id

gui.play_spine_anim()

gui.play_spine_anim(node,animation_id,playback,play_properties,complete_function)

Starts a spine animation.

PARAMETERS

node node spine node that should play the animation

animation_id string
hash id of the animation to play

playback constant playback mode - `gui.PLAYBACK_ONCE_FORWARD` - `gui.PLAYBACK_ONCE_BACKWARD` - `gui.PLAYBACK_ONCE_PINGPONG` - `gui.PLAYBACK_LOOP_FORWARD` - `gui.PLAYBACK_LOOP_BACKWARD` - `gui.PLAYBACK_LOOP_PINGPONG`

play_properties

table

optional table with properties

`blend_duration`	`number`	The duration of a linear blend between the current and new animation
`offset`	`number`	The normalized initial value of the animation cursor when the animation starts playing
`playback_rate`	`number`	The rate with which the animation will be played. Must be positive

complete_function function(self, node) function to call when the animation has completed

gui.cancel_spine()

gui.cancel_spine(node)

cancel a spine animation

PARAMETERS

node node spine node that should cancel its animation

gui.get_spine_bone()

gui.get_spine_bone(node,bone_id)

The returned node can be used for parenting and transform queries. This function has complexity O(n), where n is the number of bones in the spine model skeleton.

PARAMETERS

`node`	`node`	spine node to query for bone node
`bone_id`	`string` `hash`	id of the corresponding bone

gui.set_spine_scene()

gui.set_spine_scene(node,spine_scene)

Set the spine scene on a spine node. The spine scene must be mapped to the gui scene in the gui editor.

PARAMETERS

`node`	`node`	node to set spine scene for
`spine_scene`	`string` `hash`	spine scene id

gui.get_spine_scene()

gui.get_spine_scene(node)

Returns the spine scene id of the supplied node. This is currently only useful for spine nodes. The returned spine scene must be mapped to the gui scene in the gui editor.

PARAMETERS

node node node to get texture from

gui.set_spine_skin()

gui.set_spine_skin(node,spine_skin)

Sets the spine skin on a spine node.

PARAMETERS

`node`	`node`	node to set the spine skin on
`spine_skin`	`string` `hash`	spine skin id

EXAMPLES

Change skin of a Spine node

function init(self)
  gui.set_spine_skin(gui.get_node("spine_node"), "monster")
end

gui.add_spine_skin()

gui.add_spine_skin(node,spine_skin_a,spine_skin_b)

Add a spine skin on a spine node to another skin on the same node.

PARAMETERS

`node`	`node`	node having both skins
`spine_skin_a`	`string` `hash`	spine skin id that recieves other skin
`spine_skin_b`	`string` `hash`	spine skin id that will be added

EXAMPLES

Add skin of a Spine node to another skin

function init(self)
  gui.add_spine_skin(gui.get_node("spine_node"), "monster_head", "monster_body")
end

gui.copy_spine_skin()

gui.copy_spine_skin(node,spine_skin_a,spine_skin_b)

Copy a spine skin on a spine node to another skin on the same node.

PARAMETERS

`node`	`node`	node having both skins
`spine_skin_a`	`string` `hash`	spine skin id that copies other skin
`spine_skin_b`	`string` `hash`	spine skin id that will be copied

EXAMPLES

Copy skin of a Spine node to another skin

function init(self)
  gui.copy_spine_skin(gui.get_node("spine_node"), "monster_head", "monster_body")
end

gui.clear_spine_skin()

gui.clear_spine_skin(node,spine_skin)

Clear a spine skin on a spine node of all attachments and constraints

PARAMETERS

`node`	`node`	node having both skins
`spine_skin`	`string` `hash`	spine skin id

EXAMPLES

Clear skin of a Spine node

function init(self)
  gui.clear_spine_skin(gui.get_node("spine_node"), "monster")
end

gui.get_spine_skin()

gui.get_spine_skin(node)

Gets the spine skin of a spine node

PARAMETERS

node node node to get spine skin from

gui.get_spine_animation()

gui.get_spine_animation(node)

Gets the playing animation on a spine node

PARAMETERS

node node node to get spine skin from

gui.set_spine_cursor()

gui.set_spine_cursor(node,cursor)

This is only useful for spine nodes. The cursor is normalized.

PARAMETERS

`node`	`node`	spine node to set the cursor for
`cursor`	`number`	cursor value

gui.get_spine_cursor()

gui.get_spine_cursor(node)

This is only useful for spine nodes. Gets the normalized cursor of the animation on a spine node.

PARAMETERS

node node spine node to get the cursor for (node)

gui.set_spine_playback_rate()

gui.set_spine_playback_rate(node,playback_rate)

This is only useful for spine nodes. Sets the playback rate of the animation on a spine node. Must be positive.

PARAMETERS

`node`	`node`	spine node to set the cursor for
`playback_rate`	`number`	playback rate

gui.get_spine_playback_rate()

gui.get_spine_playback_rate(node)

This is only useful for spine nodes. Gets the playback rate of the animation on a spine node.

PARAMETERS

node node spine node to set the cursor for

gui.set_spine_attachment()

gui.set_spine_attachment(node,slot,attachment)

This is only useful for spine nodes. Sets an attachment to a slot on a spine node.

PARAMETERS

`node`	`node`	spine node to set the slot for
`slot`	`string` `hash`	slot name
`attachment`	`string` `hash`	attachment name. May be nil.

gui.set_spine_slot_color()

gui.set_spine_slot_color(node,slot,color)

This is only useful for spine nodes. Sets a tint for all attachments on a slot

PARAMETERS

`node`	`node`	spine node to set the slot for
`slot`	`string` `hash`	slot name
`color`	`vector4`	target color.

gui.spine_physics_translate()

gui.spine_physics_translate(node,translation)

Apply a physics-based translation to the Spine GUI node.

PARAMETERS

`node`	`node`	The Spine GUI node to translate.
`translation`	`vector3`	The translation vector to apply to the Spine GUI node.

gui.spine_physics_rotate()

gui.spine_physics_rotate(node,center,degrees)

Apply a physics-based rotation to the Spine GUI node.

PARAMETERS

`node`	`node`	The Spine GUI node to rotate.
`center`	`vector3`	The center point around which to rotate.
`degrees`	`number`	The rotation angle in degrees.

gui.set_spine_ik_target_position()

gui.set_spine_ik_target_position(node,ik_constraint_id,position)

Sets a static (vector3) target position of an inverse kinematic (IK) object.

PARAMETERS

`node`	`node`	the Spine GUI node containing the object
`ik_constraint_id`	`string` `hash`	id of the corresponding IK constraint object
`position`	`vector3`	target position

EXAMPLES

The following example assumes that the Spine GUI node has id "spine_node".

How to set the target IK position of the right_hand_constraint constraint object of the player object

function init(self)
  local pos = vmath.vector3(1, 2, 0)
  gui.set_spine_ik_target_position(gui.get_node("spine_node"), "right_hand_constraint", pos)
end

gui.set_spine_ik_target()

gui.set_spine_ik_target(node,ik_constraint_id,target_node)

Sets a GUI node as target position of an inverse kinematic (IK) object. As the target GUI node's position is updated, the constraint object is updated with the new position.

PARAMETERS

`node`	`node`	the Spine GUI node containing the object
`ik_constraint_id`	`string` `hash`	id of the corresponding IK constraint object
`target_node`	`node`	target GUI node

EXAMPLES

The following example assumes that the Spine GUI node has id "spine_node".

How to set the target IK position of the right_hand_constraint constraint object to follow the position of GUI node with id "target_node"

function init(self)
  local spine_node = gui.get_node("spine_node")
  local target_node = gui.get_node("target_node")
  gui.set_spine_ik_target(spine_node, "right_hand_constraint", target_node)
end

gui.reset_spine_ik_target()

gui.reset_spine_ik_target(node,ik_constraint_id)

Resets any previously set IK target of a Spine GUI node, the position will be reset to the original position from the spine scene.

PARAMETERS

`node`	`node`	the Spine GUI node containing the object
`ik_constraint_id`	`string` `hash`	id of the corresponding IK constraint object

EXAMPLES

The following example assumes that the Spine GUI node has id "spine_node".

A player no longer has an item in hand, that previously was controlled through IK, let's reset the IK of the right hand.

function player_lost_item(self)
  gui.reset_spine_ik_target(gui.get_node("spine_node"), "right_hand_constraint")
end