Module: GamePlay::DisplayMessage
- Included in:
- Base
- Defined in:
- docs/4_Systems_004_Message.rb
Overview
Module responsive of adding the display message functionality to a class
Constant Summary collapse
- MESSAGE_ERROR =
Message the displays when a GamePlay scene has been initialized without message processing and try to display a message
'This interface has no MessageWindow, you cannot call display_message'- MESSAGE_PROCESS_ERROR =
Error message when display_message is called from "itself"
'display_message was called inside display_message. Please fix your scene update.'
Instance Attribute Summary collapse
-
#message_window ⇒ UI::Message::Window?
readonly
The message window.
Instance Method Summary collapse
-
#can_display_message_be_called? ⇒ Boolean
Tell if the display_message function can be called.
-
#close_message_window { ... }
Force the message window to "close" (but does not update scene).
-
#display_message(message, start = 1, *choices, &block) ⇒ Integer?
Display a message with choice or not.
-
#display_message_and_wait(message, start = 1, *choices, &block) ⇒ Integer?
Display a message with choice or not.
-
#message_class ⇒ Class<UI::Message::Window>
Return the message class used.
-
#message_processing? ⇒ Boolean
Prevent the update to process if the message are still processing.
-
#message_visible ⇒ Boolean
Get the visibility of message.
-
#message_visible=(visible)
Set the visibility of message.
Instance Attribute Details
#message_window ⇒ UI::Message::Window? (readonly)
The message window
790 791 792 |
# File 'docs/4_Systems_004_Message.rb', line 790 def @message_window end |
Instance Method Details
#can_display_message_be_called? ⇒ Boolean
Tell if the display_message function can be called
797 798 |
# File 'docs/4_Systems_004_Message.rb', line 797 def end |
#close_message_window { ... }
Force the message window to "close" (but does not update scene)
801 802 |
# File 'docs/4_Systems_004_Message.rb', line 801 def end |
#display_message(message, start = 1, *choices, &block) ⇒ Integer?
Display a message with choice or not
821 822 |
# File 'docs/4_Systems_004_Message.rb', line 821 def (, start = 1, *choices, &block) end |
#display_message_and_wait(message, start = 1, *choices, &block) ⇒ Integer?
Display a message with choice or not. This method will wait the message window to disappear
829 830 |
# File 'docs/4_Systems_004_Message.rb', line 829 def (, start = 1, *choices, &block) end |
#message_class ⇒ Class<UI::Message::Window>
Return the message class used
805 806 |
# File 'docs/4_Systems_004_Message.rb', line 805 def end |
#message_processing? ⇒ Boolean
Prevent the update to process if the message are still processing
793 794 |
# File 'docs/4_Systems_004_Message.rb', line 793 def end |
#message_visible ⇒ Boolean
Get the visibility of message
813 814 |
# File 'docs/4_Systems_004_Message.rb', line 813 def end |
#message_visible=(visible)
Set the visibility of message
809 810 |
# File 'docs/4_Systems_004_Message.rb', line 809 def (visible) end |