NineVerbGUI

Inherits: PopochiuGraphicInterface

Description

Defines the behavior of the 9 Verbs GUI.

In this GUI players interact with objects based on the active command, which can be changed by clicking one of the nine buttons in the bottom panel. The inventory is always visible in the bottom right corner of the screen, and the settings popup can be opened using the button in the top right corner of the screen.

---

Methods

Return Type	Method
void	_on_blocked(props: = { blocking = true }) virtual
void	_on_dialog_finished(_dialog: PopochiuDialog) virtual
void	_on_dialog_line_finished() virtual
void	_on_dialog_line_started() virtual
void	_on_dialog_options_shown() virtual
void	_on_dialog_started(_dialog: PopochiuDialog) virtual
void	_on_game_loaded(loaded_game: Dictionary) virtual
void	_on_game_saved() virtual
void	_on_inventory_item_selected(item: PopochiuInventoryItem) virtual
void	_on_mouse_entered_clickable(clickable: PopochiuClickable) virtual
void	_on_mouse_entered_inventory_item(inventory_item: PopochiuInventoryItem) virtual
void	_on_mouse_exited_clickable(clickable: PopochiuClickable) virtual
void	_on_mouse_exited_inventory_item(inventory_item: PopochiuInventoryItem) virtual
void	_on_system_text_hidden() virtual
void	_on_system_text_shown(_msg: String) virtual
void	_on_unblocked() virtual

---

Signals

• settings_requested()

---

Signal Descriptions

settings_requested

signal settings_requested()

---

Method Descriptions

_on_blocked

func _on_blocked(props: = { blocking = true }) -> void

This is a virtual method. Override it in your subclass.

Called when the GUI is blocked. Sets E.current_command to none of the available commands, hides the bottom panel, and stops processing unhandled input.

---

_on_dialog_finished

func _on_dialog_finished(_dialog: PopochiuDialog) -> void

This is a virtual method. Override it in your subclass.

Called when a PopochiuDialog finishes. It shows the "normal" cursor.

---

_on_dialog_line_finished

func _on_dialog_line_finished() -> void

This is a virtual method. Override it in your subclass.

Called when a dialogue line finishes. It shows the "gui" cursor if there is an active PopochiuDialog, otherwise it shows the "normal" cursor.

---

_on_dialog_line_started

func _on_dialog_line_started() -> void

This is a virtual method. Override it in your subclass.

Called when a dialogue line starts. It shows the "wait" cursor.

---

_on_dialog_options_shown

func _on_dialog_options_shown() -> void

This is a virtual method. Override it in your subclass.

Called when the running PopochiuDialog shows its options on screen. It shows the "gui" cursor.

---

_on_dialog_started

func _on_dialog_started(_dialog: PopochiuDialog) -> void

This is a virtual method. Override it in your subclass.

Called when a PopochiuDialog starts. It shows the "gui" cursor.

---

_on_game_loaded

func _on_game_loaded(loaded_game: Dictionary) -> void

This is a virtual method. Override it in your subclass.

Called when a game is loaded. loaded_game has the loaded data. By default, it shows Game loaded in the SystemText component.

---

_on_game_saved

func _on_game_saved() -> void

This is a virtual method. Override it in your subclass.

Called when the game is saved. By default, it shows Game saved in the SystemText component.

---

_on_inventory_item_selected

func _on_inventory_item_selected(item: PopochiuInventoryItem) -> void

This is a virtual method. Override it in your subclass.

Called when item is selected in the inventory (i.e. by clicking it). For this GUI, this will only occur when the current command is USE.

---

_on_mouse_entered_clickable

func _on_mouse_entered_clickable(clickable: PopochiuClickable) -> void

This is a virtual method. Override it in your subclass.

Called when the mouse enters (hovers) clickable. Displays the description in the HoverText component.

---

_on_mouse_entered_inventory_item

func _on_mouse_entered_inventory_item(inventory_item: PopochiuInventoryItem) -> void

This is a virtual method. Override it in your subclass.

Called when the mouse enters (hovers) inventory_item. Displays the description in the HoverText component.

---

_on_mouse_exited_clickable

func _on_mouse_exited_clickable(clickable: PopochiuClickable) -> void

This is a virtual method. Override it in your subclass.

Called when the mouse exits clickable. Clears the HoverText and shows the "normal" cursor.

---

_on_mouse_exited_inventory_item

func _on_mouse_exited_inventory_item(inventory_item: PopochiuInventoryItem) -> void

This is a virtual method. Override it in your subclass.

Called when the mouse exits inventory_item. Clears the HoverText and shows the "normal" cursor.

---

_on_system_text_hidden

func _on_system_text_hidden() -> void

This is a virtual method. Override it in your subclass.

Called when the system text is hidden. Shows the "normal" cursor.

---

_on_system_text_shown

func _on_system_text_shown(_msg: String) -> void

This is a virtual method. Override it in your subclass.

Called when G.show_system_text() is executed. Shows the "wait" cursor.

---

_on_unblocked

func _on_unblocked() -> void

This is a virtual method. Override it in your subclass.

Called when the GUI is unblocked. Restores E.current_command to WALK_TO, shows the bottom panel, and re-enables unhandled input processing.