Class: UI::GenericBase

Inherits:
SpriteStack show all
Defined in:
scripts/01300 UI/00100 Generic/00400 GenericBase.rb

Overview

Generica base UI for most of the scenes

Defined Under Namespace

Classes: ControlButton

Constant Summary collapse

DEFAULT_KEYS =

List of key by default

%i[A X Y B]
BUTTON_TO_HIDE =

List of button to hide when a text is shown

0..2

Constants inherited from SpriteStack

SpriteStack::NO_INITIAL_IMAGE

Instance Attribute Summary collapse

Attributes inherited from SpriteStack

#animated, #data, #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, texts = [], keys = DEFAULT_KEYS, hide_background_and_button: false) ⇒ GenericBase

Create a new GenericBase UI

Parameters:

  • viewport (Viewport)
  • texts (Array<String>) (defaults to: [])

    list of texts shown in the ControlButton

  • keys (Array<Symbol>) (defaults to: DEFAULT_KEYS)

    list of keys used in the ControlButton

  • hide_background_and_button (Boolean) (defaults to: false)

    tell if we don't want to show the button and its bar

Instance Attribute Details

#backgroundSprite (readonly)

Returns:

#button_textsArray<String>

Returns the texts shown in the button.

Returns:

  • (Array<String>)

    the texts shown in the button

#ctrlArray<ControlButton> (readonly)

Returns the control buttons.

Returns:

#keysArray<Symbol>

Returns keys shown in the button.

Returns:

  • (Array<Symbol>)

    keys shown in the button

Instance Method Details

#hide_win_text

Hide the “win text”

#show_win_text(text)

Show the “win text” (bottom text giving information to the player)

Parameters:

  • text (String)

    text to show

#update_background_animation

Update the background animation

#win_text_visible?Boolean

Tell if the win text is visible

Returns:

  • (Boolean)