Class: Yuki::Animation::TimedAnimation
- Includes:
- Yuki::AnimationMixin
- Defined in:
- docs/4_Systems_005_Animation.rb
Overview
Class calculating time offset for animation.
Direct Known Subclasses
Battle::Visual::FakeHPAnimation, Anchor, Command, CompressAnimation, Dim2Animation, Dim2AnimationDiscreet, DiscreetAnimation, EllipseAnimation, EqAnimation, FallingAnimation, MessageLocked, MoveParticleAnimation, MoveParticleOffsetAnimation, MoveParticleOnSprite, ParticleOnSpriteAnimation, ParticleZoomAnimation, RadiusMoveAnimation, ScalarAnimation, ScalarXFromSprite, ScalarYFromSprite, SpriteSheetAnimation, ToneAnimation
Instance Attribute Summary collapse
-
#begin_time ⇒ Time?
readonly
Get the begin time of the animation (if started).
-
#end_time ⇒ Time?
readonly
Get the end time of the animation (if started).
-
#time_source ⇒ #call?
readonly
Get the time source of the animation (if started).
Attributes included from Yuki::AnimationMixin
Instance Method Summary collapse
-
#done? ⇒ Boolean
Indicate if the animation is done.
-
#duration ⇒ Float
Get the animation duration in seconds.
-
#initialize(time_to_process, distortion = :UNICITY_DISTORTION, time_source = :SCENE_TIME_SOURCE) ⇒ TimedAnimation
constructor
Create a new TimedAnimation.
-
#parallel_add(other)
(also: #<<, #|, #parallel_play)
deprecated
Deprecated.
You should use a variant of Player for animation orchestration
-
#play_before(other)
(also: #>)
deprecated
Deprecated.
You should use a variant of Player for animation orchestration
-
#start(begin_offset = 0) ⇒ self
Start the animation (initialize it).
-
#update ⇒ self
Update the animation internal time and call update_internal with a parameter between 0 & 1 indicating the progression of the animation.
Methods included from Yuki::AnimationMixin
#begin_offset_for_next_animation
Constructor Details
#initialize(time_to_process, distortion = :UNICITY_DISTORTION, time_source = :SCENE_TIME_SOURCE) ⇒ TimedAnimation
Create a new TimedAnimation
227 228 |
# File 'docs/4_Systems_005_Animation.rb', line 227 def initialize(time_to_process, distortion = :UNICITY_DISTORTION, time_source = :SCENE_TIME_SOURCE) end |
Instance Attribute Details
#begin_time ⇒ Time? (readonly)
Get the begin time of the animation (if started)
215 216 217 |
# File 'docs/4_Systems_005_Animation.rb', line 215 def begin_time @begin_time end |
#end_time ⇒ Time? (readonly)
Get the end time of the animation (if started)
218 219 220 |
# File 'docs/4_Systems_005_Animation.rb', line 218 def end_time @end_time end |
#time_source ⇒ #call? (readonly)
Get the time source of the animation (if started)
221 222 223 |
# File 'docs/4_Systems_005_Animation.rb', line 221 def time_source @time_source end |
Instance Method Details
#done? ⇒ Boolean
should always be called after start
Indicate if the animation is done
237 238 |
# File 'docs/4_Systems_005_Animation.rb', line 237 def done? end |
#duration ⇒ Float
Get the animation duration in seconds
257 258 |
# File 'docs/4_Systems_005_Animation.rb', line 257 def duration end |
#parallel_add(other) Also known as: <<, |, parallel_play
You should use a variant of Player for animation orchestration
246 247 |
# File 'docs/4_Systems_005_Animation.rb', line 246 def parallel_add(other) end |
#play_before(other) Also known as: >
You should use a variant of Player for animation orchestration
252 253 |
# File 'docs/4_Systems_005_Animation.rb', line 252 def play_before(other) end |
#start(begin_offset = 0) ⇒ self
Start the animation (initialize it)
232 233 |
# File 'docs/4_Systems_005_Animation.rb', line 232 def start(begin_offset = 0) end |
#update ⇒ self
should always be called after start
Update the animation internal time and call update_internal with a parameter between 0 & 1 indicating the progression of the animation
243 244 |
# File 'docs/4_Systems_005_Animation.rb', line 243 def update end |