-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation in different folders (#146)
* Fix typo * Add more documentation in different folders. Add documentation files in different parts of the plugin to explain what's the purpose of the contained files.
- Loading branch information
Showing
5 changed files
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Command | ||
Command is a Collection derivation, containing information about what the processor should do when it reach that command. | ||
|
||
Each command defines its own behavior and should notify the processor when it ends or what should be the next step that it should take. | ||
|
||
To create a custom command, just extend from `Command`, define a name, its behavior and finally register it to `CommandRecord`. | ||
|
||
```gdscript | ||
@tool # <- It MUST be tool or editor will not be able to use it. | ||
extends Command | ||
func _execution_steps() -> void: | ||
## Always notify that your command started. You have total control on | ||
## where to emit this signal, but be sure to emit it once. | ||
command_started.emit() # Notify that your command started | ||
## Implement your command behavior | ||
print("Hello") | ||
## Never forget to notify that you command have finished in order | ||
## to let the command manager know that is safe to continue to | ||
## the next event. | ||
go_to_next_command() | ||
## Here you define your command name | ||
func _get_name() -> StringName: | ||
return "CUSTOM_COMMAND" | ||
## You can define other properties of the command, | ||
## Editor will use those to change the command block appeareance. | ||
func _get_icon() -> Texture: | ||
return load("res://icon.svg") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Core | ||
Very important files that didn't fit in any other folder. | ||
|
||
These files are usually tied to the plugin than the editor itself, like the main plugin script or util functions used in many editor places. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Debugger | ||
Debugger is the bridge between running game and editor. | ||
|
||
Its goal is to provide a visual feedback about the flow of the current processors that are in the current scene of the game. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Editor | ||
Blockflow editor. | ||
|
||
The editor main purpose is to provide a tool to create and modify collections and commands to be used later in game through processors. |