Class: Yuki::Animation::ScalarXFromSprite

Inherits:
TimedAnimation show all
Defined in:
docs/5_Battle_20_MoveAnimation.rb

Overview

Class that performs a scalar on the X axis from sprite 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, sprite, start_x, offset_x, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE) ⇒ ScalarXFromSprite

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

Parameters:

  • time_to_process (Float) —

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

  • on (Object) —

    object that will receive the property

  • sprite (Object) —

    on which the origin will be based on

  • start_x (Integer) —

    start_x

  • offset_x (Integer) —

    offset_x

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

    callable taking one parameter (between 0 & 1) and

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

    callable taking no parameter and giving the current time



455
456
# File 'docs/5_Battle_20_MoveAnimation.rb', line 455

def initialize(time_to_process, on, sprite, start_x, offset_x, distortion: :UNICITY_DISTORTION, time_source: :SCENE_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



459
460
# File 'docs/5_Battle_20_MoveAnimation.rb', line 459

def start(begin_offset = 0)
end

#update_internal(time_factor)

Update the scalar animation

Parameters:

  • time_factor (Float) —

    number between 0 & 1 indicating the progression of the animation



463
464
# File 'docs/5_Battle_20_MoveAnimation.rb', line 463

def update_internal(time_factor)
end