Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
72
docs/api/ESCCommand.md
Normal file
72
docs/api/ESCCommand.md
Normal 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
|
||||
Reference in New Issue
Block a user