Optimized Docs (#7)

Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
Dennis Ploeger
2021-06-22 23:06:20 +02:00
committed by GitHub
parent d5a0022b7b
commit 58d880101d
111 changed files with 6362 additions and 801 deletions

72
docs/api/ESCCommand.md Normal file
View File

@@ -0,0 +1,72 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCCommand
**Extends:** [ESCStatement](../ESCStatement) < [Object](../Object)
## Description
An ESC command
## Constants Descriptions
### REGEX
```gdscript
const REGEX: String = "^(\\s*)(?<name>[^\\s]+)(\\s(?<parameters>([^\\[]|$)+))?(\\[(?<conditions>[^\\]]+)\\])?"
```
Regex matching command lines
## Property Descriptions
### name
```gdscript
var name: String
```
The name of this command
### parameters
```gdscript
var parameters: Array
```
Parameters of this command
### conditions
```gdscript
var conditions: Array
```
A list of ESCConditions to run this command.
Conditions are combined using logical AND
## Method Descriptions
### \_init
```gdscript
func _init(command_string)
```
Create a command from a command string
### is\_valid
```gdscript
func is_valid() -> bool
```
Check, if conditions match
### run
```gdscript
func run() -> var
```
Run this command