Class: UI::StatusAnimation
- Inherits:
-
SpriteSheet
- Object
- LiteRGSS::Disposable
- LiteRGSS::Drawable
- LiteRGSS::Sprite
- LiteRGSS::ShaderedSprite
- Sprite
- ShaderedSprite
- SpriteSheet
- UI::StatusAnimation
- Includes:
- RecenterSprite
- Defined in:
- docs/5_Battle_02_Visual.rb
Overview
Class that describes the Basic Status Animation used when a Creature is affected by a status condition
Defined Under Namespace
Classes: AttractAnimation, BurnAnimation, ConfusionAnimation, FreezeAnimation, ParalyzeAnimation, PoisonAnimation, SleepAnimation
Instance Attribute Summary collapse
-
#status ⇒ Symbol
readonly
Get the db_symbol of the status.
Attributes inherited from SpriteSheet
Attributes inherited from LiteRGSS::ShaderedSprite
Attributes inherited from LiteRGSS::Sprite
#__index__, #angle, #bitmap, #height, #mirror, #opacity, #ox, #oy, #src_rect, #viewport, #visible, #width, #x, #y, #z, #zoom, #zoom_x, #zoom_y
Class Method Summary collapse
-
.new(viewport, status, z, bank, scene = $scene) ⇒ StatusAnimation
Create a new Status animation.
-
.register(db_symbol, klass)
Register a new status.
Instance Method Summary collapse
-
#animation_progression=(progression)
Function that change the sprite according to the progression of the animation.
-
#initialize(viewport, status, z, bank, scene = $scene) ⇒ StatusAnimation
constructor
Create a new StatusAnimation.
-
#status_duration ⇒ Integer
Return the duration of the Status Animation.
-
#x_offset ⇒ Integer
Return the x offset for the Status Animation.
-
#y_offset ⇒ Integer
Return the y offset for the Status Animation.
-
#z=(z)
Set the z position of the sprite.
Methods included from RecenterSprite
Methods inherited from SpriteSheet
Methods inherited from Sprite
#load, #mouse_in?, #set_origin_div, #set_rect, #set_rect_div, #set_z, #simple_mouse_in?, #translate_mouse_coords, #update
Methods inherited from LiteRGSS::Sprite
Methods inherited from LiteRGSS::Disposable
Constructor Details
#initialize(viewport, status, z, bank, scene = $scene) ⇒ StatusAnimation
Create a new StatusAnimation
2162 2163 |
# File 'docs/5_Battle_02_Visual.rb', line 2162 def initialize(, status, z, bank, scene = $scene) end |
Instance Attribute Details
#status ⇒ Symbol (readonly)
Get the db_symbol of the status
2154 2155 2156 |
# File 'docs/5_Battle_02_Visual.rb', line 2154 def status @status end |
Class Method Details
.new(viewport, status, z, bank, scene = $scene) ⇒ StatusAnimation
Create a new Status animation
2177 2178 |
# File 'docs/5_Battle_02_Visual.rb', line 2177 def new(, status, z, bank, scene = $scene) end |
.register(db_symbol, klass)
Register a new status
2168 2169 |
# File 'docs/5_Battle_02_Visual.rb', line 2168 def register(db_symbol, klass) end |
Instance Method Details
#animation_progression=(progression)
Function that change the sprite according to the progression of the animation
2182 2183 |
# File 'docs/5_Battle_02_Visual.rb', line 2182 def animation_progression=(progression) end |
#status_duration ⇒ Integer
Return the duration of the Status Animation
2198 2199 |
# File 'docs/5_Battle_02_Visual.rb', line 2198 def status_duration end |
#x_offset ⇒ Integer
Return the x offset for the Status Animation
2190 2191 |
# File 'docs/5_Battle_02_Visual.rb', line 2190 def x_offset end |
#y_offset ⇒ Integer
Return the y offset for the Status Animation
2194 2195 |
# File 'docs/5_Battle_02_Visual.rb', line 2194 def y_offset end |
#z=(z)
Set the z position of the sprite
2186 2187 |
# File 'docs/5_Battle_02_Visual.rb', line 2186 def z=(z) end |