Class: Yuki::Animation::MoveParticleOffsetAnimation

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

Overview

Class that performs a move particle animation with offset

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, particle, from, to, offset_x, offset_y, from_center: false, distortion: :UNICITY_DISTORTION, time_source: :SCENE_TIME_SOURCE) ⇒ MoveParticleOffsetAnimation

Note:

Create an animation between two sprites with the possibility to apply an offset in both coordinates between the sprites

Create a new MoveParticleOffsetAnimation

Parameters:

  • time_to_process (Float) —

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

  • particle (Sprite, Sprite3D) —

    sprite that will be moved

  • from (PokemonSprite, PokemonSprite3D) —

    based on which Sprite it will start

  • to (PokemonSprite, PokemonSprite3D) —

    on which Sprite it will go

  • offset_x (Integer) —

    offset on x

  • offset_y (Integer) —

    offset on y

  • from_center (Boolean) (defaults to: false) —

    is the origin from the center of the sprite (by default false)

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

    callable taking one parameter (between 0 & 1) and converting it to another number (between 0 & 1) to distort time

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

    callable taking no parameter and giving the current time



209
210
# File 'docs/5_Battle_20_MoveAnimation.rb', line 209

def initialize(time_to_process, particle, from, to, offset_x, offset_y, from_center: false, 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



213
214
# File 'docs/5_Battle_20_MoveAnimation.rb', line 213

def start(begin_offset = 0)
end

#update_internal(time_factor)

Method you should always overwrite in order to perform the right animation

Parameters:

  • time_factor (Float) —

    number between 0 & 1 indicating the progression of the animation



217
218
# File 'docs/5_Battle_20_MoveAnimation.rb', line 217

def update_internal(time_factor)
end