Commit Graph
107 Commits
Author SHA1 Message Date
Ryan Roden-Corrent 584ff890d4 Add link to tool docs in gdscript docs.
The gdscript_basics docs give a pretty sparse description of the tool
keyword. I ended up figuring out a lot of it on my own before I finally
realized there was a more detailed page hidden elsewhere in the docs.
2019-12-24 08:09:47 -05:00
Paul Joannon fae465f34f Documentation page about C#/GDScript interactions (#2826) 2019-12-21 11:52:32 +01:00
Nathan Lovato 82dd565936 Change less -> fewer 2019-11-25 11:04:02 +01:00
Hugo Locurcio 193b866848 Add quote style recommendation to the GDScript style guide
This closes #2869.
2019-11-14 15:00:28 +01:00
Rémi Verschelde 219b3f91f4 Merge pull request #2766 from Kaligule/patch-3
Document all comments that disable warnings
2019-10-29 12:06:05 +01:00
Rémi Verschelde 7287412268 Merge pull request #2844 from Calinou/clarify-gdscript-export-step
Clarify how the "step" value behaves in GDScript exports
2019-10-29 09:14:24 +01:00
Aaron Franke 1dfb69578c GDScript style guide: Add comments section, and change quotes (#2868)
* Add section about spacing comments

* Replace single quotes with double quotes
2019-10-23 13:32:24 +02:00
Johan Thelin 90c8056e8c Change example signal name to animation_finished
The AnimationPlayer signal used to demonstrate the yield function is called "animation_finished".
2019-10-19 15:36:50 +02:00
asakuno 7b8cf1d4fe Directive fixes
important 652Line
2019-10-14 14:33:42 +09:00
Hugo Locurcio 25c94ccb82 Clarify how the "step" value behaves in GDScript exports 2019-10-11 10:27:26 +02:00
Nathan Merrill 6d46050ecb Fix extends statement
When extending from a filepath, you need to use a string
2019-09-25 07:15:57 -06:00
Kaligule 97b8ad885b Document all comments that disable warnings
These are the 3 types that I found in the code:

- # warning-ignore:id_of_warning
- # warning-ignore-all:id_of_warning
- # warnings-disable

I found them at https://github.com/godotengine/godot/blob/24e1039eb6fe32115e8d1a62a84965e9be19a2ed/modules/gdscript/gdscript_tokenizer.cpp#L558
If there are any more they should also be added.
2019-09-17 22:33:07 +02:00
Rémi Verschelde aaca561488 Code style fixes in Procedural geometry docs 2019-09-02 11:12:44 +02:00
Aaron Franke cdd4ef33e3 Update int, float, and bool docs
It's useful to explain what C++ type they use in the background so that people with any questions can look up the equivalent type in C++ if they need more specific documentation.
2019-09-01 13:46:17 -04:00
Rémi Verschelde b0d064677b Merge pull request #2714 from nippysaurus/patch-1
correct variable reference in setget example
2019-09-01 15:46:35 +02:00
Michael Dawson a36056fd62 correct variable reference in setget example 2019-08-22 18:39:49 +10:00
Hugo Locurcio c41d188838 Split GDScript exports documentation into its own page
This makes the GDScript basics page shorter.
2019-08-21 17:30:19 +02:00
Chris Bradfield 9d8ae252f7 Merge pull request #2677 from AlexanderPavlenko/patch-1
Update gdscript_basics.rst
2019-08-12 12:29:31 -07:00
Chris Bradfield efc78e5b0e Merge pull request #2687 from Calinou/improve-gdscript-basics
Improve the GDScript basics page
2019-08-12 11:49:37 -07:00
Dan Boorstein b4fb258356 Document 'for' treatment of a bare number as a 'range()' 2019-08-08 12:30:24 -08:00
Hugo Locurcio 4fa1ddbde9 Improve the GDScript basics page
- Add more information on the `assert` keyword
- Document binary literals
- Use "parent class" everywhere for consistency
- Move information about parent class function overloading
  to be more visible
- Don't recommend multiline strings for multiline comments
  to avoid performance issues in tight loops
- Improve grammar and writing style
2019-08-06 20:34:41 +02:00
Alexander Pavlenko 3a1b7c01c7 Update gdscript_basics.rst 2019-08-02 22:33:48 +03:00
Rodrigo Matos 5067b9b58b Just some small code corrections
1º - Missing quotation marks
2º - Damage calculation was resulting in negative numbers.
2019-07-17 09:12:24 +02:00
Michael Alexsander Silva Dias bd7ed603c9 Fix links in the note in "Signals" section of the "GDScripts basics" page 2019-07-15 12:17:50 -03:00
Rodrigo Matos eb17706cd9 [Minor] Getting Started corrections (#2611)
* Update gdscript_basics.rst

* Small typo
2019-07-14 15:33:56 -07:00
Cameron Reikes 5402f28f59 Add warning to reflect behavior with tool nodes (#2577)
In response to this issue: https://github.com/godotengine/godot/issues/30104
2019-07-02 13:56:06 +02:00
Nathan Lovato b9a9aea6da Rewrite GDScript basics - Signals section with more concrete examples (#2526)
Close #2526
2019-07-01 15:29:19 +09:00
Nathan Lovato 5bd6fcf3bd Update the GDScript styleguide
Add a note about type hints, closes #2506
Recommend to skip 2 lines between functions to help make the code easier to read, closes #2505
2019-06-15 12:10:07 +09:00
fogine d2ac16935c document the ability which allows to export a Curve resource variable for godot editor from gdscript 2019-05-31 20:10:56 +02:00
Max Hilbrunneranda e aed79c2583 GDScript Advanced: Improve custom iterator example
Fix syntax by removing multiple variable declarations on the same line, which GDScript does not (yet?) support, use clearer class and variable names, and rename the misleading "is_done()" function to "should_continue()", as the value returned (and returned by _iter_init() and iter_next() actually signifies the opposite: true means continue, false means stop. Also remove the superfluous do_step() function. 

Closes #2433.

Co-authored-by: a e <afablee@gmail.com>
2019-05-09 03:48:56 +02:00
Max Hilbrunner 193ee9cbf7 Merge pull request #2370 from kmcphillips/master
Change case sensitive string to "waiting"
2019-04-15 16:34:25 +02:00
Kevin McPhillips f3c2eda0a3 Change case sensitive string to "waiting" 2019-04-13 21:42:18 -04:00
Henrique Campos c602bc4aa8 Fix wrong type on replacing callback's types example 2019-03-30 09:45:39 -03:00
Denys Lytviak 5015e602bd gdscript_basics missing double quotes
(cherry picked from commit 2d84bba7e2)
2019-03-29 20:49:50 +01:00
Chris Bradfield 41b67909fe Minor tutorial fixes for 3.1 2019-03-20 18:35:40 -07:00
Chaosus 5497c12709 Removed deleted gdscript keywords 2019-02-21 08:46:00 +03:00
Rémi Verschelde c344f8d801 Misc style fixes 2019-02-10 13:38:13 +01:00
Nathan Lovato cc98ef723d Merge pull request #2149 from Dar13/issue_1973
Rewrite 'Signals' introduction to have clearer examples
2019-02-06 07:13:00 +09:00
Neil Moore fb64a084cb Rewrite 'Signals' introduction to have clearer examples
Previous examples used signals in the same file which can cause confusion to
some new users (as seen in #1973). New examples follow basic framework
of existing work, but take care to explicitly show an example of
inter-instance signals.
2019-01-28 23:18:10 -05:00
Rémi Verschelde a30183a4c4 Fix GDScript enum docs for 3.1 2019-01-28 12:05:20 +01:00
Rémi Verschelde 5b2aaf8d41 Optimize PNGs with optipng
Using `find -name "*.png" -exec optipng \;` and optipng 0.7.7
2019-01-26 22:10:03 +01:00
Rémi Verschelde aa7a9f8675 Misc heading fixes 2019-01-08 11:30:55 +01:00
Rémi Verschelde 739ea5eeb9 Fix most Sphinx warnings 2019-01-07 12:14:46 +01:00
Wilson E. Alvarez 0ca14438ae Changed TYPE_FLOAT to TYPE_REAL 2018-12-24 19:28:50 -05:00
Rémi Verschelde dc2dfb6224 Fix escaping plural 's' after inlined code
Also add missing inline code formatting to Custom drawing in 2D.
2018-12-13 15:02:07 +01:00
Rémi Verschelde 8a49da6da5 Fix internal links to use proper :ref: syntax 2018-12-13 12:05:35 +01:00
clayjohn 6dce55e70a add constant example 2018-12-07 23:08:11 -08:00
corrigentia 0fa68362af Fix some grammar in static_typing.rst (#1982) 2018-12-07 15:26:00 +01:00
corrigentia 674d24192b Update gdscript_format_string.rst 2018-12-06 14:11:13 +02:00
Rémi Verschelde c96dd3bb13 Merge pull request #1980 from corrigentia/patch-22
Correct idiom in gdscript_styleguide.rst
2018-12-05 16:16:18 +01:00