Class: UI::MiningGame::Tool_Buttons

Inherits:
SpriteStack show all
Defined in:
docs/4_Systems_801_Mining_Game.rb

Overview

Class that describes the buttons that let the player choose his tool

Constant Summary collapse

COORD_Y_2_TOOLS =

Coordinates in no dynamite mode

[0, 80]
COORD_Y_3_TOOLS =

Coordinates in dynamite mode

[0, 64, 128]
TOOL_FILENAME =

Symbols of the tools

['pickaxe', 'mace', 'dynamite']

Constants inherited from SpriteStack

SpriteStack::NO_INITIAL_IMAGE

Instance Attribute Summary collapse

Attributes inherited from SpriteStack

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

Instance Method Summary collapse

Methods inherited from 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, #update_animation, #update_position, #visible, #visible=, #with_cache, #with_font, #with_surface, #z, #z=

Constructor Details

#initialize(viewport) ⇒ Tool_Buttons

Create the tool buttons

Parameters:

  • viewport (Viewport) —

    the viewport of the scene



638
639
# File 'docs/4_Systems_801_Mining_Game.rb', line 638

def initialize(viewport)
end

Instance Attribute Details

#animation ⇒ Yuki::AnimationMixin | nil

Returns the animation played when selecting a button.

Returns:



635
636
637
# File 'docs/4_Systems_801_Mining_Game.rb', line 635

def animation
  @animation
end

#buttons ⇒ Array<SpriteSheet>

Returns the array containing each button.

Returns:

  • (Array<SpriteSheet>) —

    the array containing each button



633
634
635
# File 'docs/4_Systems_801_Mining_Game.rb', line 633

def buttons
  @buttons
end

#index ⇒ Integer

Returns the currently selected button.

Returns:

  • (Integer) —

    the currently selected button



631
632
633
# File 'docs/4_Systems_801_Mining_Game.rb', line 631

def index
  @index
end

Instance Method Details

#change_buttons_state(index) ⇒ Symbol

Change the state of each button depending on the one that is hit

Parameters:

  • index (Integer) —

    the index of the hitted button

Returns:

  • (Symbol) —

    the symbol of the new tool to use



643
644
# File 'docs/4_Systems_801_Mining_Game.rb', line 643

def change_buttons_state(index)
end

#cycle_through_buttons ⇒ Symbol

Cycle through the buttons with a keyboard input

Returns:

  • (Symbol) —

    the symbol of the new tool to use



647
648
# File 'docs/4_Systems_801_Mining_Game.rb', line 647

def cycle_through_buttons
end