Class: BattleUI::AbilityBar

Inherits:

UI::SpriteStack

• Object
• UI::SpriteStack
• BattleUI::AbilityBar

Includes:

GoingInOut, MultiplePosition, UI

Defined in:

docs/5_Battle_01_Scene.rb

Overview

Sprite of a Trainer in the battle

Direct Known Subclasses

ItemBar

Defined Under Namespace

Classes: Background

Constant Summary

Constants inherited from UI::SpriteStack

UI::SpriteStack::NO_INITIAL_IMAGE

Instance Attribute Summary

• #animation_handler ⇒ Yuki::Animation::Handler{ Symbol => Yuki::Animation::TimedAnimation} readonly

  Get the animation handler.

• #bank ⇒ Integer readonly

  Get the bank of the pokemon shown by the sprite.

• #no_go_out ⇒ Boolean readonly

  Get if the animation out should be not played automatically.

• #position ⇒ Integer readonly

  Get the position of the pokemon shown by the sprite.

• #scene ⇒ Battle::Scene readonly

  Get the scene linked to this object.

Attributes inherited from UI::SpriteStack

#animated, #data, #moving, #stack, #viewport, #x, #y

Instance Method Summary

• #done? ⇒ Boolean

  Tell if the animations are done.

• #go_in_ability(no_go_out = false)

  Tell the ability to go into the scene.

• #initialize(viewport, scene, bank, position) ⇒ AbilityBar constructor

  Create a new Ability Bar.

• #update

  Update the animations.

Methods included from MultiplePosition

#enemy?

Methods included from GoingInOut

#go_in, #go_out, #in?, #out?

Methods inherited from UI::SpriteStack

#[], #add_background, #add_line, #add_text, #anime, #anime_delta_set, #dispose, #each, #execute_anime, #move, #move_to, #opacity, #opacity=, #push, #push_sprite, #set_origin, #set_position, #simple_mouse_in?, #size, #stop_animation, #translate_mouse_coords, #update_animation, #update_position, #visible, #visible=, #with_cache, #with_font, #with_surface, #z, #z=

Constructor Details

#initialize(viewport, scene, bank, position) ⇒ AbilityBar

Create a new Ability Bar

Parameters:

• viewport (Viewport)
• scene (Battle::Scene)
• bank (Integer)
• position (Integer)

# File 'docs/5_Battle_01_Scene.rb', line 1041

def initialize(viewport, scene, bank, position)
end

Instance Attribute Details

#animation_handler ⇒ Yuki::Animation::Handler{ Symbol => Yuki::Animation::TimedAnimation} (readonly)

Get the animation handler

Returns:

• (Yuki::Animation::Handler{ Symbol => Yuki::Animation::TimedAnimation})

# File 'docs/5_Battle_01_Scene.rb', line 1023

def animation_handler
  @animation_handler
end

#bank ⇒ Integer (readonly)

Get the bank of the pokemon shown by the sprite

Returns:

• (Integer)

# File 'docs/5_Battle_01_Scene.rb', line 1029

def bank
  @bank
end

#no_go_out ⇒ Boolean (readonly)

Get if the animation out should be not played automatically

Returns:

• (Boolean)

# File 'docs/5_Battle_01_Scene.rb', line 1035

def no_go_out
  @no_go_out
end

#position ⇒ Integer (readonly)

Get the position of the pokemon shown by the sprite

Returns:

• (Integer)

# File 'docs/5_Battle_01_Scene.rb', line 1026

def position
  @position
end

#scene ⇒ Battle::Scene (readonly)

Get the scene linked to this object

Returns:

• (Battle::Scene)

# File 'docs/5_Battle_01_Scene.rb', line 1032

def scene
  @scene
end

Instance Method Details

#done? ⇒ Boolean

Tell if the animations are done

Returns:

• (Boolean)

# File 'docs/5_Battle_01_Scene.rb', line 1048

def done?
end

#go_in_ability(no_go_out = false)

Tell the ability to go into the scene

Parameters:

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

  Set if the animation out should be not played automatically

# File 'docs/5_Battle_01_Scene.rb', line 1055

def go_in_ability(no_go_out = false)
end

#update

Update the animations

# File 'docs/5_Battle_01_Scene.rb', line 1044

def update
end