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.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()

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.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.