Commit Graph

162 Commits

Author SHA1 Message Date
Brandon Lamb
734c65b470 Clarify example code for signal
Section discussing placing signals above other properties did not actually contain a line for signals (which confused me). Clarifying the style guide by showing a signal on top
2020-05-25 11:47:16 -07:00
Hugo Locurcio
4f6fdbc710 Fix various spacing and capitalization issues 2020-05-18 09:54:32 +02:00
Max Hilbrunner
b24b9ad9a5 GDScript basics: improve match explanation
Co-authored-by: Jacob Gray <jacopo.grayscale@gmail.com>
2020-05-17 18:33:21 +02:00
mechPenSketch
e7a7e11c42 Expand Resource section (#3543)
* Expand Resource section

Added how you can export classes that inherits from Resource as a convenience.
2020-05-17 16:20:36 +02:00
Max Hilbrunner
be931dc655 Merge pull request #3546 from Calinou/gdscript-warning-system-split
Split the GDScript warning system documentation into its own page
2020-05-17 15:55:50 +02:00
Hugo Locurcio
9e57202866 Split the GDScript warning system documentation into its own page
It's not strictly related to static typing, as it can work without it
(e.g. to signal unreachable code).
2020-05-17 01:01:59 +02:00
Hugo Locurcio
d494d19dac Remove trailing whitespace and irregular whitespace 2020-05-17 00:26:19 +02:00
Max Hilbrunner
54f2ef4ba2 GDScript: Add type casting to the precedence table 2020-05-14 18:03:05 +02:00
mtttz
c7719aa020 Replace outdated 'GDScriptFunction' identifier with 'GDScriptFunctionState' in example code 2020-05-12 23:47:50 +02:00
Hugo Locurcio
0cba774249 Mention Object bracket property access and dynamic property indexing
This closes #3506.
2020-05-08 17:28:49 +02:00
Hugo Locurcio
a53ab27329 Add file name conventions in the GDScript style guide (#3355)
This closes #2376.
2020-05-04 19:07:29 +02:00
Andrii Doroshenko
387882f458 Document GDScript export category and property grouping (#3444)
* Document GDScript export category and property grouping

* Update getting_started/scripting/gdscript/gdscript_exports.rst

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2020-05-04 16:26:18 +02:00
Michael Alexsander
e4f6430262 Make more snippets in GDScript basics page follow the styleguide (#3487) 2020-05-03 15:22:42 +02:00
Max Hilbrunner
fb45e50509 Merge pull request #2644 from Xrayez/gdscript-coroutines-completed
Elaborate on yielding to `completed` signal in GDScript basics
2020-05-03 01:00:03 +02:00
Eric M
8ea31de5ef Added documentation for drag-and-drop support for exported arrays (#3480)
* Added documentation for drag-and-drop support for exported arrays

* Apply suggestions from code review

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2020-05-02 22:32:02 +02:00
mechPenSketch
b844c946d9 Expand NodePath hints, added Resource hints to GDScript exports (#3473) 2020-05-02 14:03:24 +02:00
Rémi Verschelde
e6b00ca97a Misc formatting fixes 2020-04-27 12:17:47 +02:00
Michael Alexsander
fec78c3c04 Fix some more errors 2020-04-17 16:43:12 -03:00
Rémi Verschelde
706e3b8f28 Merge pull request #3398 from Calinou/gdscript-export-tool-script
Document how to update the inspector after setting an exported variable
2020-04-17 18:56:03 +02:00
Hugo Locurcio
d2a420b3a8 Document how to update the inspector after setting an exported variable
This closes https://github.com/godotengine/godot/issues/21009.
2020-04-17 12:06:38 +02:00
Hugo Locurcio
046215542d Fix some typos and grammar mistakes found using LanguageTool 2020-04-16 23:07:05 +02:00
Hugo Locurcio
ac4c28d279 Add advice about local variables in the GDScript and C# style guides 2020-04-15 11:45:23 +02:00
Frederick Kramer Dal Pra
efa4e6ef5f Safe line vs Unsafe line unclear label (#3366)
Although line 6 is safe, line 7, that actually is what the paragraph talking about, is unsafe and line 8 is safe.
The way it was before, it was in reverse order, making it confusing which is safe and which is not. So I changed the order to be as the picture.
To further assure it is clear, I added the line numbers in parentheses.
The parentheses could be excessive verbosity, but the order importance stands. I believe it was confusing before.
Alternatively, the picture could be changed, having the safe line first. Then it's clearer as the unsafe line it's the only one different and the order would be also correct; 2 safe lines, one unsafe for last. Specifying the lines would not be needed then.
2020-04-12 13:58:40 +02:00
Hugo Locurcio
62725b30f1 Move the GDScript history to the FAQ, reference it in GDScript basics 2020-04-09 16:24:31 +02:00
Hugo Locurcio
32d9019e5e Always use parentheses when calling assert() in GDScript
This is now required since Godot 3.2.

This also adds an assert message to the Godot interfaces page to match
its C# counterpart.
2020-04-09 14:46:36 +02:00
Yuri Sizov
075acc61b0 Replace Pool*Arrays with Packed*Arrays in tutorials and references 2020-03-17 11:15:34 +03:00
Yuri Sizov
37604be65f Improved keystroke formatting for shortcuts and key press menti… (#3257) 2020-03-09 23:50:53 +01:00
Michael Alexsander
95784cf94f General formating fixes for GDScript scripting pages (#3248) 2020-03-06 20:28:58 +01:00
Michael Alexsander
3f9c09fbf7 Small fixes for recent formating errors (#3247) 2020-03-06 13:51:11 +01:00
Johannes Witt
1eab94c72d Added looped Coroutine Example to GDScript Basics (#2586) 2020-03-03 22:28:56 +01:00
Michael Alexsander
91df8e4ed2 Apply minor fixups to the GDScript styleguide 2020-02-05 22:19:23 -03:00
Rémi Verschelde
1df5a0ae68 Merge pull request #3061 from asynts/asynts.syntax-highlighting-2
Incorrect syntax highlighting for languages other than GDScript.
2020-01-27 08:39:00 +01:00
Marincia Catalin
37670ff9e4 Replaced wrong semicolon by a colon ! 2020-01-23 23:31:35 +02:00
Michael Alexsander
ecc41a15f4 Fix trailing comma examples in style guide page 2020-01-23 16:00:31 -03:00
Feniks
98bcb8af4a Updated style guide to include enums and dir in exception to 2… (#3082)
It appears that general consensus across the docs is that 2 indents for continuous line rule does not apply to enums and dictionaries. This is not mentioned in docs which is confusing to anyone who doesn't know about unofficial exception. This commit makes it official
2020-01-22 15:15:14 +01:00
Michael Alexsander
83511dc224 Fix nonexistent reference in the "GDScript style guide" page 2020-01-14 18:26:02 -03:00
Nathan Lovato
9a64d9a5c5 GDScript style guide: add suggested code order (#3022)
* GDScript style guide: add suggested code order

Following the discussion in #2997

* Update the code order example in the GDScript style guide
2020-01-14 18:23:24 +01:00
asynts
53f878bdaf Replace 'code' directives with 'code-block' directives.
The `code` directive highlights all sources as GDScript. Other languages are
highlighted incorrectly at the moment, even if `.. code:: [language]` is
specified.

It does, however, work with the `code-block` directive. The reason seems to be
that this directive is Sphinx specific.
2020-01-13 18:45:39 +01:00
Igor
088279f8e2 Fix typo in Vector2 description 2020-01-13 09:34:48 +02:00
Nathan Lovato
dcb9cb43e8 Tweak GDScript and C# Style guides
Rename code structure -> formatting
Add a heading Encoding and special characters for the corresponding section
Add missing Indentation heading that was gone
2020-01-06 13:55:46 +01:00
Aaron Franke
766e4687e5 Add file formatting to GDScript style guide
Recommend LF, newline at end of file, UTF-8, no BOM, and tabs. The displayed size of tabs does not matter as it does not affect the saved files, so don't mention it. Also slightly change the C# style guide for consistency.
2020-01-04 16:59:52 -05:00
Michael Alexsander
f7505fdf79 Add references for the built-in type pages in GDScript basics 2020-01-03 14:52:48 -03:00
Nathan Lovato
f56dee8d22 Change phrasing of the line length gdscript guideline. 2020-01-02 20:26:43 +01:00
Nathan Lovato
373f662571 Merge pull request #2994 from Calinou/add-gdscript-line-length-guideline
Add a line length guideline to the GDScript style guide
2020-01-02 20:08:58 +01:00
Nathan Lovato
60b8b5b11b Fix typo before comment 2020-01-02 09:48:10 +01:00
Nathan Lovato
176d4482be Edit gdscript_styleguide 2019-12-31 20:26:33 +01:00
Nathan Lovato
0321330075 Merge pull request #2995 from Calinou/add-gdscript-boolean-operators-guideline
Add a boolean operators guideline to the GDScript style guide
2019-12-31 19:46:45 +01:00
Nathan Lovato
c640a90329 Merge pull request #2996 from Calinou/add-gdscript-enums-guideline
Add an enum naming guideline to the GDScript style guide
2019-12-31 19:41:44 +01:00
Nathan Lovato
b19ead1230 Merge pull request #2967 from Scony/func-call-operator
function call operator added to operator table
2019-12-31 12:49:55 +01:00
Michael Alexsander
19417063c8 Very small styling fixups to the GDScript export page 2019-12-27 15:00:11 -03:00