Commit Graph
164 Commits
Author SHA1 Message Date
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 aa646a74f3 Merge pull request #2849 from KellyThomas/csharp-export-docs
Document using PropertyHint with [Export]
2019-10-29 10:01:18 +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
Kelly Thomas babcca5b28 Document using PropertyHint with [Export] 2019-10-13 01:03:03 +08: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
Keelar be828e34de Fix odd/confusing wording in c_sharp_basics.rst 2019-07-15 05:41:20 -04:00
Rodrigo Matos eb17706cd9 [Minor] Getting Started corrections (#2611)
* Update gdscript_basics.rst

* Small typo
2019-07-14 15:33:56 -07:00
Aaron Franke ff18e047e6 Clarify inserting space after commas 2019-07-04 10:09:30 -04: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
Rémi Verschelde 5a9024fdbc Merge pull request #2572 from Calinou/improve-csharp-style-guide
Improve the C# style guide and mention C# 7.0 as minimum version
2019-07-02 13:34:47 +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
Hugo Locurcio 7d86b8553f Improve the C# style guide and mention C# 7.0 as minimum version
This closes #2540.
2019-06-28 22:53:41 +02:00
Rémi Verschelde c35a57d8bd Merge pull request #2521 from GDquest/gdscript-styleguide-updates
Update the GDScript styleguide
2019-06-16 20:47:09 +02: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
a e 7e9123000c Link to Built-in GDScript functions (#2515)
Replaced hard-coded link with cross-reference as per comment above and examples given in
http://www.sphinx-doc.org/en/stable/usage/restructuredtext/roles.html#cross-referencing-arbitrary-locations
2019-06-10 14:30:54 +09:00
Aaron Franke 034c8c36e7 Explicit C# line formatting
Have newlines at the end of each file and use LF over CRLF
2019-06-04 18:02:17 -04:00
BLaDoM 23ba9e895f Update outdated namespaces
Updated Array and Dictionary namespaces from Godot to Godot.Collections
2019-06-03 21:55:39 -03: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
Rémi Verschelde 31d91849fd Merge pull request #2273 from cbscribe/kcc_31_fixes
Minor tutorial fixes for 3.1
2019-03-21 23:18:35 -07:00
Chris Bradfield 41b67909fe Minor tutorial fixes for 3.1 2019-03-20 18:35:40 -07:00
Arman 3be6802503 C# external editor guide rewrite
- Auto-completion -> autocompletion
- Choose -> select (Otherwise it was "Choose your editor of choice")
- Edit for conciseness
2019-03-16 22:01:06 -07:00
FabiánLC c7f96232be Updated c_sharp_basics.rst
Added some extra information about setting up C# for Godot in Windows.
2019-03-05 00:22:40 -03:00
Ignacio Etcheverry 4d4593e454 Fix and improve C# API differences page (#2201) 2019-03-01 13:25:19 +01:00
Chaosus 5497c12709 Removed deleted gdscript keywords 2019-02-21 08:46:00 +03:00
Ignacio Etcheverry a129652342 Fixes and improvements of C# code examples 2019-02-18 22:08:01 +01:00
Rémi Verschelde e039f2ee69 Merge pull request #2181 from Calinou/improve-csharp-basics
Improve and update the C# basics page for 3.1 beta 3
2019-02-18 09:37:37 +01:00
Hugo Locurcio 83e40d23dc Improve and update the C# basics page for 3.1 beta 3 2019-02-13 22:46:14 +01:00
Rémi Verschelde c344f8d801 Misc style fixes 2019-02-10 13:38:13 +01:00