Class: UI::GenericBase
- Inherits:
-
SpriteStack
- Object
- SpriteStack
- UI::GenericBase
- Defined in:
- docs/01450_Systems_00000_General_00100_UI_Generics.rb
Overview
Generica base UI for most of the scenes
Direct Known Subclasses
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
Instance Attribute Summary collapse
- #background ⇒ Sprite readonly
-
#button_texts ⇒ Array<String>
The texts shown in the button.
-
#ctrl ⇒ Array<ControlButton>
readonly
The control buttons.
-
#keys ⇒ Array<Symbol>
Keys shown in the button.
Attributes inherited from SpriteStack
#animated, #data, #moving, #stack, #viewport, #x, #y
Instance Method Summary collapse
-
#hide_win_text
Hide the “win text”.
-
#initialize(viewport, texts = [], keys = DEFAULT_KEYS, hide_background_and_button: false) ⇒ GenericBase
constructor
Create a new GenericBase UI.
-
#show_win_text(text)
Show the “win text” (bottom text giving information to the player).
-
#update_background_animation
Update the background animation.
-
#win_text_visible? ⇒ Boolean
Tell if the win text is visible.
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
389 390 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 389 def initialize(, texts = [], keys = DEFAULT_KEYS, hide_background_and_button: false) end |
Instance Attribute Details
#background ⇒ Sprite (readonly)
379 380 381 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 379 def background @background end |
#button_texts ⇒ Array<String>
Returns the texts shown in the button.
375 376 377 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 375 def @button_texts end |
#ctrl ⇒ Array<ControlButton> (readonly)
Returns the control buttons.
377 378 379 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 377 def ctrl @ctrl end |
#keys ⇒ Array<Symbol>
Returns keys shown in the button.
373 374 375 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 373 def keys @keys end |
Instance Method Details
#hide_win_text
Hide the “win text”
404 405 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 404 def hide_win_text end |
#show_win_text(text)
Show the “win text” (bottom text giving information to the player)
401 402 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 401 def show_win_text(text) end |
#update_background_animation
Update the background animation
411 412 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 411 def update_background_animation end |
#win_text_visible? ⇒ Boolean
Tell if the win text is visible
408 409 |
# File 'docs/01450_Systems_00000_General_00100_UI_Generics.rb', line 408 def win_text_visible? end |