Skip to content
GitLab
Explore
Sign in
This is an archived project. Repository and other project resources are read-only.
Commits on Source (2)
Change the instructions for writing the API
· 9803f05a
adud
authored
Jun 28, 2019
Godot API is such a mess: 1000 lines of Python to parse XML that outputs rst to feed the sphinx...
9803f05a
commented the 10 first lines of the editor (the 10 hardest)
· a99937a2
adud
authored
Jun 28, 2019
a99937a2
Show whitespace changes
Inline
Side-by-side
CONTRIBUTING.md
View file @
a99937a2
...
...
@@ -9,9 +9,13 @@ commit will..."
## Coding Style
The program is written in Godot's scripting language GDScript. We follow here
the
[
style guide
](
https://docs.godotengine.org/en/latest/getting_started/\scripting/gdscript/gdscript_styleguide.html
)
described in Godot Documentation.
the [style guide] described in Godot Documentation.
When creating a class or a function, describe it in the API chapter of the documentation
The API follows the same style as
[
Godot API
](
https://docs.godotengine.org/en/latest/classes/index.html
)
## API
When creating a class or a function, describe it in the API chapter of the
documentation. Use the object description directives. If you are doing a scene
prefix the name with
`class-`
and use lowercase and separate words with
`-`
.
Do not forget to indicate signals.
[
style guide
]:
https://docs.godotengine.org/en/latest/getting_started/scripting/gdscript/gdscript_styleguide.html
docs/sphinx/source/api/class-work-space.rst
View file @
a99937a2
.. _WorkSpace:
===========
WorkSpace
===========
Inherits from the Container class.
-----------------
Brief Description
-----------------
.. class:: WorkSpace
Container used to prompt the speech in a text-editor way
.
A WorkSpace, to display and edit signed speech
.
----------
Properties
----------
.. attribute:: sep(Vector2)
.. _class_WorkSpace_prop_sep:
The size of the horizontal and vertical separators between signs.
This attribute is a script variable.
* Vector2 **sep**
.. attribute:: text(signs Array)
The sizes in pixel of the horizontal and vertical separators between two
words.
The signed speech, stored in one single array (like strings).
.. _class_WorkSpace_prop_text:
.. todo:: Should be accessed through functions.
* Array **text**
.. function:: dispose_childs()
The
signs
of
the speech
in a big "string".
Draw all
signs
in
the speech
editor/WorkSpace.tscn
View file @
a99937a2
...
...
@@ -7,5 +7,8 @@
margin_right = 620.0
margin_bottom = 480.0
script = ExtResource( 1 )
__meta__ = {
"_edit_group_": true
}
SignSymb = ExtResource( 2 )