Files
gymkhana-actions/docs/api/SayCommand.md
Dennis Ploeger 3dc779311c Issue 336 (#380)
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
2021-08-30 20:57:25 +02:00

43 lines
936 B
Markdown

<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# SayCommand
**Extends:** [ESCBaseCommand](../ESCBaseCommand) < [Node](../Node)
## Description
`say object text [type] [avatar]`
Runs the specified string as a dialog said by the object. Blocks execution
until the dialog finishes playing.
The text supports translation keys by prepending the key and separating
it with a `:` from the text.
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
## Method Descriptions
### configure
```gdscript
func configure() -> ESCCommandArgumentDescriptor
```
Return the descriptor of the arguments of this command
### run
```gdscript
func run(command_params: Array) -> var
```
Run the command