Class: Yuki::Animation::SpriteSheetAnimation

Inherits:

TimedAnimation

• Object
• TimedAnimation
• Yuki::Animation::SpriteSheetAnimation

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, #parallel_animations, #root, #sub_animation, #time_source

Instance Method Summary

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

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

• #start(begin_offset = 0)

  Start the animation (initialize it).

Methods inherited from TimedAnimation

#done?, #in_parallel_of, #parallel_add, #play_before, #resolver=, #update

Constructor Details

#initialize(time_to_process, on, cells, rounding = :round, distortion: :UNICITY_DISTORTION, time_source: :GENERIC_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: :GENERIC_TIME_SOURCE) —

  callable taking no parameter and giving the current time

# File 'docs/4_Systems_005_Animation.rb', line 344

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

Instance Method Details

#start(begin_offset = 0)

Start the animation (initialize it)

Parameters:

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

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

# File 'docs/4_Systems_005_Animation.rb', line 348

def start(begin_offset = 0)
end