Class: Yuki::Animation::SpriteSheetAnimation

Inherits:
TimedAnimation show all
Defined in:
docs/4_Systems_005_Animation.rb

Overview

Class that describe a SpriteSheet animation

Instance Attribute Summary

Attributes inherited from TimedAnimation

#begin_time, #end_time, #time_source

Attributes included from Yuki::AnimationMixin

#player, #resolver

Instance Method Summary collapse

Methods inherited from TimedAnimation

#done?, #duration, #parallel_add, #play_before, #update

Methods included from Yuki::AnimationMixin

#begin_offset_for_next_animation, #done?, #duration, #update

Constructor Details

#initialize(time_to_process, on, cells, rounding = :round, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE) ⇒ SpriteSheetAnimation

Create a new ScalarAnimation convert it to another number (between 0 & 1) in order to distord time

Parameters:

  • time_to_process (Float) —

    number of seconds (with generic time) to process the animation

  • on (SpriteSheet, Symbol) —

    object that will receive the property

  • cells (Array<Array<Integer>>, Symbol) —

    all the select arguments that should be sent during the animation

  • rounding (Symbol) (defaults to: :round) —

    kind of rounding, can be: :ceil, :round, :floor

  • distortion (#call, Symbol) (defaults to: :UNICITY_DISTORTION) —

    callable taking one paramater (between 0 & 1) and

  • time_source (#call, Symbol) (defaults to: :SCENE_TIME_SOURCE) —

    callable taking no parameter and giving the current time



548
549
# File 'docs/4_Systems_005_Animation.rb', line 548

def initialize(time_to_process, on, cells, rounding = :round, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE)
end

Instance Method Details

#start(begin_offset = 0) ⇒ self

Start the animation (initialize it)

Parameters:

  • begin_offset (Float) (defaults to: 0) —

    offset that prevents the animation from starting before now + begin_offset seconds

Returns:

  • (self)


553
554
# File 'docs/4_Systems_005_Animation.rb', line 553

def start(begin_offset = 0)
end