211 Commits

Author SHA1 Message Date
Andrew Kim
07bdedd7af Fix void typed function code sample in GDScript basics (#5281) 2021-09-25 19:48:48 +02:00
Vladislav Vorobev
d52655bae0 Fixed class_name keyword ordering in GDScript style guide 2021-07-12 23:06:54 +02:00
DeeJayLSP
ff7961167d Change text to avoid use of first person in Static typing in GDScript (#4953) 2021-06-04 00:25:42 +02:00
Hugo Locurcio
e6f40bde7a Add a "see also" link to the GDScript grammar in the GDScript section
The page is in the Development section, but it's not easy to discover.

(cherry picked from commit ea7814b25c)
2021-04-26 16:57:09 +02:00
skyace65
db822fbf39 Add code example for weakref
(cherry picked from commit 4f19eea5c9)
2021-03-19 13:17:01 +01:00
Matthew
226b44d3a7 Add information on onready annotation to C# differences page (#4565)
(cherry picked from commit 2a4dcc40d6)
2021-03-19 12:50:26 +01:00
Evgeniy Vasilyev
af4d5675e2 Fix code formatting in GDScript style guide (#4755) 2021-03-15 14:11:08 +01:00
Hugo Locurcio
4b6c9c4c61 Document that addons/ class_name is only visible if part of a plugin
See https://github.com/godotengine/godot/issues/30048.
2021-02-22 20:09:32 +01:00
Karl
047ffb9673 Fix emit_signal() call in GDScript basics' coroutine example (#4559)
The first argument of emit_signal be the signal name.
2021-01-19 02:04:59 +01:00
Nathan Lovato
7e133868f5 Merge pull request #3955 from HaSa1002/yield-multiple-arguments
Add yield with multiple arguments example to GDSCript Basics
2020-10-10 12:07:26 -06:00
Rémi Verschelde
973cf89f94 Merge branch 'master' into 3.2 2020-09-22 08:59:08 +02:00
Nathan Lovato
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
Adrien
4fc9a12e11 Update Keywords to include class_name
Includes `class_name` in the keywords list, and updates the definition of `class`.
2020-09-15 16:16:35 +08:00
Rémi Verschelde
6d8c7b1d1a Merge branch 'master' into 3.2 2020-09-11 09:15:57 +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
Rémi Verschelde
e337af304f Merge branch 'master' into 3.2 2020-09-09 13:02:26 +02:00
Hugo Locurcio
e27d64924f Apply suggestions from code review 2020-09-02 15:49:10 +02:00
HaSa1002
5df18b894f Add yield with multiple arguments example to GDSCript Basics 2020-09-02 14:09:06 +02: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
Rémi Verschelde
2c4db3ba10 Merge branch 'master' into 3.2 2020-08-11 13:30:27 +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
Rémi Verschelde
76cf11c890 Merge branch 'master' into 3.2 2020-07-30 17:14:54 +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
d48ff2b0a1 Merge branch 'master' into 3.2 2020-07-06 14:30:28 +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
Rémi Verschelde
223570eb13 Merge branch 'master' into 3.2 2020-06-26 13:29:38 +02:00
Meriipu
fbaff8f5c9 Dictionary: use the potentially clearer word "key" instead of "index" (#3724) 2020-06-23 10:22:47 +02:00
Rémi Verschelde
80957b8581 Merge branch 'master' into 3.2 2020-06-22 13:05:41 +02:00
skyace65
eb5d5cc90f Clarify GDScript match 2020-06-06 20:58:16 -04:00
Rémi Verschelde
f3d374ebf1 Merge branch 'master' into 3.2 2020-06-05 17:15:28 +02: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
Rémi Verschelde
8f6b4a2ace Merge branch 'master' into 3.2 2020-05-27 13:45:21 +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
Rémi Verschelde
10f20b00cb Merge branch 'master' into 3.2 2020-05-20 15:08:42 +02: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