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

54
docs/api/ESCCompiler.md Normal file
View File

@@ -0,0 +1,54 @@
<!-- Auto-generated from JSON by GDScript docs maker. Do not edit this document directly. -->
# ESCCompiler
**Extends:** [Object](../Object)
## Description
Compiler of the ESC language
## Constants Descriptions
### COMMENT\_REGEX
```gdscript
const COMMENT_REGEX: String = "^\\s*#.*$"
```
A RegEx for comment lines
.*$'
### EMPTY\_REGEX
```gdscript
const EMPTY_REGEX: String = "^\\s*$"
```
A RegEx for empty lines
### INDENT\_REGEX
```gdscript
const INDENT_REGEX: String = "^(?<indent>\\s*)"
```
A RegEx for finding out the indent of a line
## Method Descriptions
### load\_esc\_file
```gdscript
func load_esc_file(path: String) -> ESCScript
```
Load an ESC file from a file resource
### compile
```gdscript
func compile(lines: Array) -> ESCScript
```
Compiles an array of ESC script strings to an ESCScript