Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
55
docs/api/ESCDialogOption.md
Normal file
55
docs/api/ESCDialogOption.md
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
|
||||
|
||||
# ESCDialogOption
|
||||
|
||||
**Extends:** [ESCStatement](../ESCStatement) < [Object](../Object)
|
||||
|
||||
## Description
|
||||
|
||||
An option of an ESC dialog
|
||||
|
||||
## Constants Descriptions
|
||||
|
||||
### REGEX
|
||||
|
||||
```gdscript
|
||||
const REGEX: String = "^[^-]*- \"(?<option>[^\"]+)\"( \\[(?<conditions>[^\\]]+)\\])?$"
|
||||
```
|
||||
|
||||
Regex that matches dialog option lines
|
||||
|
||||
## Property Descriptions
|
||||
|
||||
### option
|
||||
|
||||
```gdscript
|
||||
var option: String
|
||||
```
|
||||
|
||||
Option displayed in the HUD
|
||||
|
||||
### conditions
|
||||
|
||||
```gdscript
|
||||
var conditions: Array
|
||||
```
|
||||
|
||||
Conditions to show this dialog
|
||||
|
||||
## Method Descriptions
|
||||
|
||||
### \_init
|
||||
|
||||
```gdscript
|
||||
func _init(option_string: String)
|
||||
```
|
||||
|
||||
Create a dialog option from a string
|
||||
|
||||
### is\_valid
|
||||
|
||||
```gdscript
|
||||
func is_valid() -> bool
|
||||
```
|
||||
|
||||
Check, if conditions match
|
||||
Reference in New Issue
Block a user