stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-09 14:29:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
4,397 Commits 21 Branches 0 Tags
419cf72a92f2af92a092ee4a3f2c4842df92e093
Commit Graph
181 Commits
Author SHA1 Message Date
Nathan LovatoandHugo Locurcio 3f0a2830dc Improve phrasing of constants in GDScript basics (#4036) 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
 2020-09-18 22:21:24 +02:00
Rémi Verschelde 08fcc85422 Fix title case 2020-09-11 09:13:16 +02:00
Nathan Leiby 97384fd5ee styleguide: clarify "static typing" syntax (#3687) 
* styleguide: clarify "static typing" syntax

I first explored making an update here because I felt the current docs were confusing:

1. I could not tell if everything below "bad" was actually bad... It seemed like some of it was "good".
2. The examples involving ` var health := 0  # The compiler will use the int type.` seemed redundant, and re: (1) it was confusing to see one in "good" and one in "bad".

Do you agree whether a change is merited or did I misunderstand the docs as written?

---

While writing this proposed update, I realize that my explanation is less focused on style, but instead also explaining how declared and inferred types work. Is that what we expect in the style guide, or is the intent to be laser-focused it on syntax and code clarity? If so, perhaps we should avoid explanation and use the linked static typing guide as the source of truth for a rich explanation: https://docs.godotengine.org/en/stable/getting_started/scripting/gdscript/static_typing.html#doc-gdscript-static-typing).

Thanks for the awesome game engine!

* clarify why it doesn't work in the get_node() case
 2020-09-09 19:05:35 -06:00
Nathan Lovato 2be83bc743 Merge pull request #3908 from Calinou/gdscript-basics-underscore-literals 
Document support for underscores in number literals in GDScript basics
 2020-08-21 10:18:44 -06:00
Hugo Locurcio f0d0ef0ce3 Add recommendations for numbers in the GDScript style guide 2020-08-19 14:04:25 +02:00
Hugo Locurcio 9e699409d3 Document support for underscores in number literals in GDScript basics 
This also uses lowercase for hexadecimal numbers, which is the
recommended approach as it's more readable.

This closes #3907.
 2020-08-18 15:07:23 +02:00
Marcin Sędłak-Jakubowski 8197cfa051 Add missing code formatting to function name in GDScript basics (#3885) 2020-08-09 20:20:35 +02:00
Leonardo Jeanteur 428106f910 Correct grammar, formatting and add download link (#3860) 
Add a link to Godot Engine's download page.
 2020-08-02 22:02:32 +02:00
Manuel 'TheDuriel' Fischer a5f313fbe6 Update gdscript_exports.rst 
Remove bogus information.
Just tested it. No form of declaration causes an array to be shared across instances.

Godot 3.2.2
 2020-07-16 17:14:24 +02:00
Hugo Locurcio 81890d5120 Mention GDScript escape sequences direclty in GDScript basics 
Many C escape sequences aren't valid in GDScript, so it's better to
document them directly in a table.

See https://github.com/godotengine/godot/issues/38716.
 2020-07-15 11:43:17 +02:00
Hugo Locurcio 0ea1d1832b Update exporting bit flags documentation for Godot 3.1 and later 
This closes #1709.
 2020-07-13 11:59:51 +02:00
Rémi Verschelde 5f88d911a9 Merge pull request #3742 from Calinou/gdscript-flat-constants 
Document constants being flat in GDScript
 2020-06-30 00:01:40 +02:00
jcoombes f46d8b7233 irregardless -> regardless. 2020-06-29 22:56:05 +01:00
Hugo Locurcio bb143bc497 Document constants being flat in GDScript 
See https://github.com/godotengine/godot/issues/30212.
 2020-06-29 10:06:59 +02:00
Meriipu fbaff8f5c9 Dictionary: use the potentially clearer word "key" instead of "index" (#3724) 2020-06-23 10:22:47 +02:00
skyace65 eb5d5cc90f Clarify GDScript match 2020-06-06 20:58:16 -04:00
Rémi Verschelde ce7a9a6eab Images: Remove unused images (no 'image::' or 'figure::' reference) 2020-06-05 14:43:20 +02:00
Rémi Verschelde 39dbbb29e1 Images: always use relative 'img/' paths, without './' prefix 
Move some files from root '/img' folder to the location where they are
actually used.
 2020-06-05 14:38:25 +02:00
Simon J. Larsen b3585cdd6b Document export hint for physics and render layers 2020-05-27 21:07:00 +02:00
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 HilbrunnerandJacob Gray 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 DoroshenkoandMax Hilbrunner 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 MHugo LocurcioMax Hilbrunner
 		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