Fix command docs, automate API doc generation (#327)

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-07-27 16:05:14 +02:00
committed by GitHub
parent 43dc217359
commit 604cccb56d
25 changed files with 575 additions and 161 deletions

View File

@@ -125,7 +125,7 @@ Currenly running task
### teleport
```gdscript
func teleport(target, angle: Object = null) -> void
func teleport(target: Node, angle: Object = null) -> void
```
Teleports this item to the target position.
@@ -134,7 +134,21 @@ can be removed
#### Parameters
- target: Vector2, Position2d or ESCItem
- target: Position2d or ESCItem to teleport to
### teleport\_to
```gdscript
func teleport_to(target: Vector2, angle: Object = null) -> void
```
Teleports this item to the target position.
TODO angle is only used for logging and has no further use, so it probably
can be removed
#### Parameters
- target: Vector2 target position to teleport to
### walk\_to
@@ -194,7 +208,7 @@ TODO Refactor to make this stuff understandable :D
#### Parameters
- angle: Angle to test
- interval : Array of size 2, containing the starting angle, and the size of
- interval: Array of size 2, containing the starting angle, and the size of
interval
eg: [90, 40] corresponds to angle between 90° and 130°