Spine model API documentation

Version: stable

Functions

spine.play_anim()

spine.play_anim(url,anim_id,playback,[play_properties],[complete_function])

Plays a specified animation on a spine model component with specified playback mode and parameters. An optional completion callback function can be provided that will be called when the animation has completed playing. If no function is provided, a spine_animation_done message is sent to the script that started the animation. The callback is not called (or message sent) if the animation is cancelled with spine.cancel. The callback is called (or message sent) only for animations that play with the following playback modes:

• go.PLAYBACK_ONCE_FORWARD
• go.PLAYBACK_ONCE_BACKWARD
• go.PLAYBACK_ONCE_PINGPONG

PARAMETERS

EXAMPLES

local function anim_done(self, message_id, message, sender)
  if message_id == hash("spine_animation_done") then
    if message.animation_id == hash("jump") then
      -- open animation done, chain with "run"
      local properties = { blend_duration = 0.2 }
      spine.play_anim(sender, "run", go.PLAYBACK_LOOP_FORWARD, properties, anim_done)
    end
  end
end

function init(self)
    local url = msg.url("#spinemodel")
    local play_properties = { blend_duration = 0.1 }
    -- first blend during 0.1 sec into the jump, then during 0.2 s into the run animation
    spine.play_anim(url, "open", go.PLAYBACK_ONCE_FORWARD, play_properties, anim_done)
end

spine.cancel()

spine.cancel(url)

Cancels all running animations on a specified spine model component.

PARAMETERS

EXAMPLES

function init(self)
  spine.cancel("#spinemodel")
end

spine.get_go()

spine.get_go(url,bone_id)

Returns the id of the game object that corresponds to a specified skeleton bone. The returned game object 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. Game objects corresponding to a spine model skeleton bone can not be individually deleted.

PARAMETERS

RETURNS

EXAMPLES

function init(self)
  local parent = spine.get_go("player#spinemodel", "right_hand")
  msg.post(".", "set_parent", {parent_id = parent})
end

spine.set_skin()

spine.set_skin(url,spine_skin,[spine_slot])

Sets the spine skin on a spine model.

PARAMETERS

EXAMPLES

function init(self)
  spine.set_skin("#spinemodel", "monster")
end

function monster_transform_arm(self)
  -- The player is transforming into a monster, begin with changing the arm.
  spine.set_skin("#spinemodel", "monster", "left_arm_slot")
end

spine.set_ik_target_position()

spine.set_ik_target_position(url,ik_constraint_id,position)

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

PARAMETERS

EXAMPLES

function init(self)
  local pos = vmath.vector3(1, 2, 3)
  spine.set_ik_target_position("player#spinemodel", "right_hand_constraint", pos)
end

spine.set_ik_target()

spine.set_ik_target(url,ik_constraint_id,target_url)

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

PARAMETERS

EXAMPLES

function init(self)
  spine.set_ik_target("player#spinemodel", "right_hand_constraint", "some_game_object")
end

spine.reset_ik_target()

spine.reset_ik_target(url,ik_constraint_id)

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

PARAMETERS

EXAMPLES

function player_lost_item(self)
  spine.reset_ik_target("player#spinemodel", "right_hand_constraint")
end

Messages

spine_animation_done

This message is sent when a Spine animation has finished playing back to the script that started the animation. No message is sent if a completion callback function was supplied when the animation was started. No message is sent if the animation is cancelled with model.cancel(). This message is sent only for animations that play with the following playback modes:

• go.PLAYBACK_ONCE_FORWARD
• go.PLAYBACK_ONCE_BACKWARD
• go.PLAYBACK_ONCE_PINGPONG

EXAMPLES

function on_message(self, message_id, message, sender)
  if message_id == hash("spine_animation_done") then
    if message.animation_id == hash("run") and message.playback == go.PLAYBACK_ONCE_FORWARD then
      -- The animation "run" has finished running forward.
    end
  end
end

spine_event

This message is sent when Spine animation playback fires events. These events has to be defined on the animation track in the Spine animation editor. An event can contain custom values expressed in the fields integer, float and string.

EXAMPLES

function on_message(self, message_id, message, sender)
  if message_id == hash("spine_event") then
    -- Receiving animation event from Spine. Play footsteps.
    if message.event_id == hash("footstep") and message.integer == 0 then
      msg.post("#sound_footstep_right", "play_sound")
    elseif message.event_id == hash("footstep") and message.integer == 1 then
      msg.post("#sound_footstep_left", "play_sound")
  end
end

Properties

cursor

The normalized animation cursor. The type of the property is number. Please note that spine events may not fire as expected when the cursor is manipulated directly.

EXAMPLES

function init(self)
  -- Get the cursor value on component "spine"
  cursor = go.get("#spine", "cursor")
end

function init(self)
  -- Get the current value on component "spine"
  go.set("#spine", "cursor", 0.0)
  -- Animate the cursor value
  go.animate("#spine", "cursor", go.PLAYBACK_LOOP_FORWARD, 1.0, go.EASING_LINEAR, 2)
end

playback_rate

The animation playback rate. A multiplier to the animation playback rate. The type of the property is number. The playback_rate is a non-negative number, a negative value will be clamped to 0.

EXAMPLES

function init(self)
  -- Get the current value on component "spine"
  playback_rate = go.get("#spine", "playback_rate")
  -- Set the playback_rate to double the previous value.
  go.set("#spine", "playback_rate", playback_rate * 2)
end

animation

READ ONLY The current animation set on the component. The type of the property is hash.

EXAMPLES

function init(self)
  -- Get the current animation on component "spinemodel"
  local animation = go.get("#spinemodel", "animation")
end

skin

The current skin on the component. The type of the property is hash. If setting the skin property the skin must be present on the spine model or a runtime error is signalled.

EXAMPLES

function init(self)
  -- If the hero skin is set to "bruce_banner", turn him green
  local skin = go.get("#hero", "skin")
  if skin == hash("bruce_banner") then
    go.set("#hero", "skin", hash("green"))
  end
end

material

The material used when rendering the spine model. The type of the property is hash.

EXAMPLES

go.property("my_material", resource.material("/material.material"))
function init(self)
  go.set("#spinemodel", "material", self.my_material)
end