oier/gymkhana-actions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Issue 336 (#380)

Browse Source 
Co-authored-by: Dennis Ploeger <develop@dieploegers.de>
Co-authored-by: dploeger <dploeger@users.noreply.github.com>
This commit is contained in:
Dennis Ploeger
2021-08-30 20:57:25 +02:00
committed by GitHub
parent 3b36031f24
commit 3dc779311c
35 changed files with 389 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/ESCDialogOption.md
View File

@@ -13,7 +13,7 @@ An option of an ESC dialog
### REGEX
```gdscript
const REGEX: String = "^[^-]*- \"(?<option>[^\"]+)\"( \\[(?<conditions>[^\\]]+)\\])?$"
const REGEX: String = "^[^-]*- (?<trans_key>[^:]+)?:?\"(?<option>[^\"]+)\"( \\[(?<conditions>[^\\]]+)\\])?$"
```
Regex that matches dialog option lines
@@ -26,6 +26,8 @@ Regex that matches dialog option lines
var option: String
```
- **Getter**: `get_option`
Option displayed in the HUD
### conditions
@@ -46,6 +48,12 @@ func _init(option_string: String)
Create a dialog option from a string
### get\_option
```gdscript
func get_option()
```
### is\_valid
```gdscript

9
docs/api/SayCommand.md
View File

@@ -9,7 +9,14 @@
`say object text [type] [avatar]`
Runs the specified string as a dialog said by the object. Blocks execution
until the dialog finishes playing. Optional parameters:
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

30
docs/esc.md
View File

@@ -252,7 +252,14 @@ group or an event.
#### <a name="SayCommand.md"></a>`say object text [type] [avatar]` [API-Doc](api/SayCommand.md)
Runs the specified string as a dialog said by the object. Blocks execution
until the dialog finishes playing. Optional parameters:
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
@@ -373,21 +380,6 @@ Makes the `player` walk to the position `x`/`y`.
<!-- /ESCCOMMANDS -->
## Dialogs
Dialogs are specified by writing `?` with optional parameters, followed by a list of dialog options starting with `-`. Use `!` to end the dialog.
@@ -398,17 +390,19 @@ The following parameters are available:
* timeout: (default value 0) timeout to select an option. After the time has passed, the "timeout_option" will be selected automatically. If the value is 0, there's no timeout.
* timeout_option: (default value 0) index of option (starting from 1) selected when timeout is reached.
Options support translation keys by prepending and separating them with a `:` from the rest of the text.
Example:
```
# character's "talk" event
:talk
? avatar timeout timeout_option
- "I'd like to buy a map." [!player_has_map]
- MAP:"I'd like to buy a map." [!player_has_map]
say player "I'd like to buy a map"
say map_vendor "Do you know the secret code?"
?
- "Uncle Sven sends regards."
- UNCLE_SVEN:"Uncle Sven sends regards."
say player "Uncle Sven sends regards."
> [player_has_money]