Class: Yuki::Animation::Player
- Includes:
- Yuki::AnimationMixin
- Defined in:
- docs/4_Systems_005_Animation.rb
Overview
Class responsive of playing several animations in order
Direct Known Subclasses
Battle::Visual::HPAnimation, FullyResolvedAnimation, HealingParticlePlayer, SignalWaiter, TimedLoopAnimation, UserBankRelativeAnimation
Instance Attribute Summary
Attributes included from Yuki::AnimationMixin
Instance Method Summary collapse
-
#animation_index(animation) ⇒ Integer?
Get the index of an animation.
-
#done? ⇒ Boolean
Check if the animation is done.
-
#duration ⇒ Float
Get the animation duration in seconds.
-
#first_start_time ⇒ Time?
Get the first start_time in the animation player.
-
#initialize(animations = nil, parallel = nil) ⇒ Player
constructor
Create a new Animation Player.
-
#last_end_time ⇒ Time?
Get the last end_time in the animation player.
-
#parallel_add(other, index = nil) ⇒ self
(also: #<<, #|, #parallel_play)
Add a parallel animation.
-
#play(other) ⇒ self
(also: #play_before, #>)
Add an animation that will be played after self.
-
#resolver=(value)
Set the resolver.
-
#root ⇒ self
Retro compatibility with legacy animation.
-
#start(begin_offset = 0) ⇒ self
Start the animation.
-
#update
Update the animation.
Methods included from Yuki::AnimationMixin
#begin_offset_for_next_animation
Constructor Details
#initialize(animations = nil, parallel = nil) ⇒ Player
Create a new Animation Player
88 89 |
# File 'docs/4_Systems_005_Animation.rb', line 88 def initialize(animations = nil, parallel = nil) end |
Instance Method Details
#animation_index(animation) ⇒ Integer?
Get the index of an animation
129 130 |
# File 'docs/4_Systems_005_Animation.rb', line 129 def animation_index(animation) end |
#done? ⇒ Boolean
Check if the animation is done
101 102 |
# File 'docs/4_Systems_005_Animation.rb', line 101 def done? end |
#duration ⇒ Float
Get the animation duration in seconds
108 109 |
# File 'docs/4_Systems_005_Animation.rb', line 108 def duration end |
#first_start_time ⇒ Time?
Get the first start_time in the animation player
137 138 |
# File 'docs/4_Systems_005_Animation.rb', line 137 def first_start_time end |
#last_end_time ⇒ Time?
Get the last end_time in the animation player
141 142 |
# File 'docs/4_Systems_005_Animation.rb', line 141 def last_end_time end |
#parallel_add(other, index = nil) ⇒ self Also known as: <<, |, parallel_play
Add a parallel animation
114 115 |
# File 'docs/4_Systems_005_Animation.rb', line 114 def parallel_add(other, index = nil) end |
#play(other) ⇒ self Also known as: play_before, >
Add an animation that will be played after self
122 123 |
# File 'docs/4_Systems_005_Animation.rb', line 122 def play(other) end |
#resolver=(value)
Set the resolver
92 93 |
# File 'docs/4_Systems_005_Animation.rb', line 92 def resolver=(value) end |
#root ⇒ self
Retro compatibility with legacy animation
133 134 |
# File 'docs/4_Systems_005_Animation.rb', line 133 def root end |
#start(begin_offset = 0) ⇒ self
Start the animation
97 98 |
# File 'docs/4_Systems_005_Animation.rb', line 97 def start(begin_offset = 0) end |
#update
Update the animation
104 105 |
# File 'docs/4_Systems_005_Animation.rb', line 104 def update end |