docs: Automatic update of API docs
This commit is contained in:
@@ -1,8 +1,8 @@
|
|||||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
# dialog\_box\_inset.gd
|
# avatar\_dialog\_player.gd
|
||||||
|
|
||||||
**Extends:** [PanelContainer](../PanelContainer)
|
**Extends:** [Popup](../Popup)
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
# dialog\_label.gd
|
# floating\_dialog\_player.gd
|
||||||
|
|
||||||
**Extends:** [RichTextLabel](../RichTextLabel)
|
**Extends:** [RichTextLabel](../RichTextLabel)
|
||||||
|
|
||||||
33
docs/api/load_game.gd.md
Normal file
33
docs/api/load_game.gd.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# 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
|
||||||
16
docs/api/load_save_slot.gd.md
Normal file
16
docs/api/load_save_slot.gd.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# 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)
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,8 +1,9 @@
|
|||||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
# verbs\_menu\_scumm9.gd
|
# main\_menu.gd
|
||||||
|
|
||||||
**Extends:** [Control](../Control)
|
**Extends:** [Control](../Control)
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
|
A simple main menu
|
||||||
52
docs/api/options.gd.md
Normal file
52
docs/api/options.gd.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# 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
|
||||||
11
docs/api/overwrite_confirm_popup.gd.md
Normal file
11
docs/api/overwrite_confirm_popup.gd.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# overwrite\_confirm\_popup.gd
|
||||||
|
|
||||||
|
**Extends:** [PopupDialog](../PopupDialog)
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
## Signals
|
||||||
|
|
||||||
|
- signal confirm_yes():
|
||||||
22
docs/api/pause_menu.gd.md
Normal file
22
docs/api/pause_menu.gd.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# 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
|
||||||
9
docs/api/room_select.gd.md
Normal file
9
docs/api/room_select.gd.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# room\_select.gd
|
||||||
|
|
||||||
|
**Extends:** [OptionButton](../OptionButton)
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
A small utility to quickly switch to a room while developing
|
||||||
33
docs/api/save_game.gd.md
Normal file
33
docs/api/save_game.gd.md
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# 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
|
||||||
12
docs/api/save_name_popup.gd.md
Normal file
12
docs/api/save_name_popup.gd.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
|
# save\_name\_popup.gd
|
||||||
|
|
||||||
|
**Extends:** [PopupDialog](../PopupDialog)
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
## Signals
|
||||||
|
|
||||||
|
- signal savegame_name_ok(savegame_name):
|
||||||
|
- signal savegame_cancel():
|
||||||
@@ -1,11 +1,14 @@
|
|||||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||||
|
|
||||||
# text\_dialog\_choice.gd
|
# text\_dialog\_chooser.gd
|
||||||
|
|
||||||
**Extends:** [ESCDialogOptionsChooser](../ESCDialogOptionsChooser) < [Node](../Node)
|
**Extends:** [ESCDialogOptionsChooser](../ESCDialogOptionsChooser) < [Node](../Node)
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
|
A simple dialog chooser that shows selectable lines of text
|
||||||
|
Supports timeout and avatar display
|
||||||
|
|
||||||
## Property Descriptions
|
## Property Descriptions
|
||||||
|
|
||||||
### color\_normal
|
### color\_normal
|
||||||
@@ -34,9 +37,12 @@ export var font = "[Object:null]"
|
|||||||
func show_chooser()
|
func show_chooser()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Show the chooser
|
||||||
|
|
||||||
### hide\_chooser
|
### hide\_chooser
|
||||||
|
|
||||||
```gdscript
|
```gdscript
|
||||||
func hide_chooser()
|
func hide_chooser()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Hide the chooser
|
||||||
Reference in New Issue
Block a user