From ee03321b37ee3e18239dfeaa8ffd4af508210f2e Mon Sep 17 00:00:00 2001 From: StraToN Date: Mon, 25 Oct 2021 07:00:14 +0000 Subject: [PATCH] docs: Automatic update of API docs --- ...inset.gd.md => avatar_dialog_player.gd.md} | 4 +- ...bel.gd.md => floating_dialog_player.gd.md} | 2 +- docs/api/load_game.gd.md | 33 ++++++++++++ docs/api/load_save_slot.gd.md | 16 ++++++ ...erbs_menu_scumm9.gd.md => main_menu.gd.md} | 3 +- docs/api/options.gd.md | 52 +++++++++++++++++++ docs/api/overwrite_confirm_popup.gd.md | 11 ++++ docs/api/pause_menu.gd.md | 22 ++++++++ docs/api/room_select.gd.md | 9 ++++ docs/api/save_game.gd.md | 33 ++++++++++++ docs/api/save_name_popup.gd.md | 12 +++++ ...choice.gd.md => text_dialog_chooser.gd.md} | 8 ++- 12 files changed, 200 insertions(+), 5 deletions(-) rename docs/api/{dialog_box_inset.gd.md => avatar_dialog_player.gd.md} (96%) rename docs/api/{dialog_label.gd.md => floating_dialog_player.gd.md} (97%) create mode 100644 docs/api/load_game.gd.md create mode 100644 docs/api/load_save_slot.gd.md rename docs/api/{verbs_menu_scumm9.gd.md => main_menu.gd.md} (81%) create mode 100644 docs/api/options.gd.md create mode 100644 docs/api/overwrite_confirm_popup.gd.md create mode 100644 docs/api/pause_menu.gd.md create mode 100644 docs/api/room_select.gd.md create mode 100644 docs/api/save_game.gd.md create mode 100644 docs/api/save_name_popup.gd.md rename docs/api/{text_dialog_choice.gd.md => text_dialog_chooser.gd.md} (78%) diff --git a/docs/api/dialog_box_inset.gd.md b/docs/api/avatar_dialog_player.gd.md similarity index 96% rename from docs/api/dialog_box_inset.gd.md rename to docs/api/avatar_dialog_player.gd.md index 611ba0a9..c3a47974 100644 --- a/docs/api/dialog_box_inset.gd.md +++ b/docs/api/avatar_dialog_player.gd.md @@ -1,8 +1,8 @@ -# dialog\_box\_inset.gd +# avatar\_dialog\_player.gd -**Extends:** [PanelContainer](../PanelContainer) +**Extends:** [Popup](../Popup) ## Description diff --git a/docs/api/dialog_label.gd.md b/docs/api/floating_dialog_player.gd.md similarity index 97% rename from docs/api/dialog_label.gd.md rename to docs/api/floating_dialog_player.gd.md index bd150fc3..18361758 100644 --- a/docs/api/dialog_label.gd.md +++ b/docs/api/floating_dialog_player.gd.md @@ -1,6 +1,6 @@ -# dialog\_label.gd +# floating\_dialog\_player.gd **Extends:** [RichTextLabel](../RichTextLabel) diff --git a/docs/api/load_game.gd.md b/docs/api/load_game.gd.md new file mode 100644 index 00000000..8f331e45 --- /dev/null +++ b/docs/api/load_game.gd.md @@ -0,0 +1,33 @@ + + +# load\_game.gd + +**Extends:** [Control](../Control) + +## Description + +A container for loading from a save slot + +## Property Descriptions + +### slot\_ui\_scene + +```gdscript +export var slot_ui_scene = "[Object:null]" +``` + +The scene to display a slot + +## Method Descriptions + +### refresh\_savegames + +```gdscript +func refresh_savegames() +``` + +Create the slots from the list of savegames + +## Signals + +- signal back_button_pressed(): Emitted when the back button is pressed diff --git a/docs/api/load_save_slot.gd.md b/docs/api/load_save_slot.gd.md new file mode 100644 index 00000000..8d9bdf08 --- /dev/null +++ b/docs/api/load_save_slot.gd.md @@ -0,0 +1,16 @@ + + +# load\_save\_slot.gd + +**Extends:** [Button](../Button) + +## Description + +## Method Descriptions + +### set\_slot\_name\_date + +```gdscript +func set_slot_name_date(p_name: String, p_date: String) +``` + diff --git a/docs/api/verbs_menu_scumm9.gd.md b/docs/api/main_menu.gd.md similarity index 81% rename from docs/api/verbs_menu_scumm9.gd.md rename to docs/api/main_menu.gd.md index 4171493a..adcd7823 100644 --- a/docs/api/verbs_menu_scumm9.gd.md +++ b/docs/api/main_menu.gd.md @@ -1,8 +1,9 @@ -# verbs\_menu\_scumm9.gd +# main\_menu.gd **Extends:** [Control](../Control) ## Description +A simple main menu \ No newline at end of file diff --git a/docs/api/options.gd.md b/docs/api/options.gd.md new file mode 100644 index 00000000..a0e17557 --- /dev/null +++ b/docs/api/options.gd.md @@ -0,0 +1,52 @@ + + +# options.gd + +**Extends:** [Control](../Control) + +## Description + +An options menu + +## Property Descriptions + +### backup\_settings + +```gdscript +var backup_settings +``` + +The current settings + +### settings\_changed + +```gdscript +var settings_changed +``` + +The settings changed + +## Method Descriptions + +### show + +```gdscript +func show() +``` + +Show the options + +### initialize\_options + +```gdscript +func initialize_options(p_settings) +``` + +Set the sliders to the values of the settings + +#### Parameters +- p_settings: The settings to use + +## Signals + +- signal back_button_pressed(): The back button was pressed diff --git a/docs/api/overwrite_confirm_popup.gd.md b/docs/api/overwrite_confirm_popup.gd.md new file mode 100644 index 00000000..0da6c616 --- /dev/null +++ b/docs/api/overwrite_confirm_popup.gd.md @@ -0,0 +1,11 @@ + + +# overwrite\_confirm\_popup.gd + +**Extends:** [PopupDialog](../PopupDialog) + +## Description + +## Signals + +- signal confirm_yes(): diff --git a/docs/api/pause_menu.gd.md b/docs/api/pause_menu.gd.md new file mode 100644 index 00000000..42086bee --- /dev/null +++ b/docs/api/pause_menu.gd.md @@ -0,0 +1,22 @@ + + +# pause\_menu.gd + +**Extends:** [Control](../Control) + +## Description + +A menu shown in game + +## Method Descriptions + +### set\_save\_enabled + +```gdscript +func set_save_enabled(p_enabled: bool) +``` + +Set wether saving is enabled currently + +#### Parameters +- p_enabled: Enable or disable saving \ No newline at end of file diff --git a/docs/api/room_select.gd.md b/docs/api/room_select.gd.md new file mode 100644 index 00000000..a8bf8af0 --- /dev/null +++ b/docs/api/room_select.gd.md @@ -0,0 +1,9 @@ + + +# room\_select.gd + +**Extends:** [OptionButton](../OptionButton) + +## Description + +A small utility to quickly switch to a room while developing \ No newline at end of file diff --git a/docs/api/save_game.gd.md b/docs/api/save_game.gd.md new file mode 100644 index 00000000..f4cb118f --- /dev/null +++ b/docs/api/save_game.gd.md @@ -0,0 +1,33 @@ + + +# save\_game.gd + +**Extends:** [Control](../Control) + +## Description + +A container for saving to a save slot + +## Property Descriptions + +### slot\_ui\_scene + +```gdscript +export var slot_ui_scene = "[Object:null]" +``` + +The scene to display a slot + +## Method Descriptions + +### refresh\_savegames + +```gdscript +func refresh_savegames() +``` + +Create the slots from the list of savegames + +## Signals + +- signal back_button_pressed(): Emitted when the back button is pressed diff --git a/docs/api/save_name_popup.gd.md b/docs/api/save_name_popup.gd.md new file mode 100644 index 00000000..b73ab814 --- /dev/null +++ b/docs/api/save_name_popup.gd.md @@ -0,0 +1,12 @@ + + +# save\_name\_popup.gd + +**Extends:** [PopupDialog](../PopupDialog) + +## Description + +## Signals + +- signal savegame_name_ok(savegame_name): +- signal savegame_cancel(): diff --git a/docs/api/text_dialog_choice.gd.md b/docs/api/text_dialog_chooser.gd.md similarity index 78% rename from docs/api/text_dialog_choice.gd.md rename to docs/api/text_dialog_chooser.gd.md index 885dba7a..2babadab 100644 --- a/docs/api/text_dialog_choice.gd.md +++ b/docs/api/text_dialog_chooser.gd.md @@ -1,11 +1,14 @@ -# text\_dialog\_choice.gd +# text\_dialog\_chooser.gd **Extends:** [ESCDialogOptionsChooser](../ESCDialogOptionsChooser) < [Node](../Node) ## Description +A simple dialog chooser that shows selectable lines of text +Supports timeout and avatar display + ## Property Descriptions ### color\_normal @@ -34,9 +37,12 @@ export var font = "[Object:null]" func show_chooser() ``` +Show the chooser + ### hide\_chooser ```gdscript func hide_chooser() ``` +Hide the chooser \ No newline at end of file