docs: Automatic update of API docs

This commit is contained in:
StraToN
2021-10-27 06:35:05 +00:00
parent 7b5f96c98c
commit 08645e6903
9 changed files with 115 additions and 277 deletions

View File

@@ -6,9 +6,9 @@
## Description
`say object text [type] [avatar]`
`say player text [type]`
Runs the specified string as a dialog said by the object. Blocks execution
Runs the specified string as a dialog said by the player. Blocks execution
until the dialog finishes playing.
The text supports translation keys by prepending the key and separating
@@ -19,8 +19,6 @@ Example: `say player ROOM1_PICTURE:"Picture's looking good."`
Optional parameters:
* "type" determines the type of dialog UI to use. Default value is "default"
* "avatar" determines the avatar to use for the dialog. Default value is
"default"
@ESC
@@ -34,6 +32,14 @@ func configure() -> ESCCommandArgumentDescriptor
Return the descriptor of the arguments of this command
### validate
```gdscript
func validate(arguments: Array)
```
Validate wether the given arguments match the command descriptor
### run
```gdscript