Commit Graph

307 Commits

Author SHA1 Message Date
Aaron Franke
370f936922 GDScript style guide: Improve type inference section (#6661) 2023-02-05 16:33:38 +03:00
Jonathan Deiss
bec737cb75 Update gdscript_styleguide.rst (#6379)
Adds two changes:
- makes it clear where subclasses should go (at the bottom of the script)
- put the `_enter_tree()` method before `_ready()` but after `_init()` since that's the order in which the methods are executed
2023-02-05 16:19:27 +03:00
Danil Alexeev
aa271f3aab Clarify @export_enum docs (#6704) 2023-02-04 23:13:33 +03:00
notPelf
beb5f02422 Clarify ternary operator in the style guide
In the current style guide, the example for ternary operators includes a "not" in the conditional which is the same text color as the preceding "if" giving the impression that the format for a ternary operation is "[some_value] if not [condition] else [other_value]" which is incorrect, and may be confusing to figure out. I'm new to Godot and I've never used python (which I understand GDScript is based on). My only experience is with c# which I don't believe has a "not" keyword so I was quite confused by this.

This change would remove "not" from the condition to eliminate confusion, and rearrange the values to keep the meaning of the example code the same. Any alternative that removes the "not" would also work.
2023-02-01 18:41:48 -05:00
Mach565
d089a504e9 Continue no longer works in a match statement (#6674) 2023-01-28 23:33:30 +03:00
mara
2b271ba33e tutorials/scripting: Mention % literal syntax
It was unclear to me what that '%' literal syntax does, add
examples in the appropriate places.
2023-01-25 20:16:48 +01:00
BlueStag
135ad68cab Use 4.0 method of connecting to and emitting signals (#6311)
Change docs to use the new method of connecting and emitting signals
2023-01-22 22:01:34 -05:00
Max Hilbrunner
7b21d5c293 GDScript basics: expand upon continue explanation (#6650)
Co-authored-by: DavidVereb <davidvereb@users.noreply.github.com>
2023-01-22 17:19:56 +01:00
Matthew
eb25278373 Merge pull request #6534 from thiagola92/single_quote
Update string literal example
2023-01-18 21:09:26 -05:00
Adam Scott
9ab272f94b Update icon annotation references in the documentation 2023-01-18 08:12:59 -05:00
J.M. de Jong
6485c97491 link to appropriate Object._get() and Object._set() sections 2023-01-15 11:12:30 +01:00
Anthony Cossins
f994d270f8 Update references to Color constants for Godot 4 (#6602) 2023-01-14 00:19:09 +01:00
Piyush Mulatkar
dea8e1c94a Removed repetitive reference to NodePath
Removed repetitive mentions of NodePath 
Fixes #6554 
URL to the documentation page:
https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_basics.html#nodepath
https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_basics.html#id1
2023-01-07 01:50:30 +05:30
Thiago Lages de Alencar
591296ceb3 Update in description (#6526)
* Update `in` description

It can be used without the `if` keyword
It appears as keyword in gdscript tokenizer: 0103af1ddd/modules/gdscript/gdscript_tokenizer.cpp (L474)
2023-01-06 01:00:57 +01:00
Thiago Lages de Alencar
f2d0428c0c Update string literal example
Both examples were using double quotes, this change the second example to single quotes
2022-12-30 06:37:25 -03:00
Yuri Sizov
97e69ebc72 Merge pull request #6481 from Piralein/gd-export
Update GDScript Export Docs
2022-12-30 02:17:59 +03:00
Hana
74804eb8e9 update gdscript export docs 2022-12-29 22:20:33 +01:00
Mara Huldra
66c620583f static_typing: Cyclic type dependencies and enums as types are now possible 2022-12-18 18:24:22 +01:00
Hugo Locurcio
01cc64412c Document node property exports now being possible in GDScript 2022-12-08 14:32:39 +01:00
Hugo Locurcio
d46c17f8ff Improve the Upgrading to Godot 4 page
- Mention various caveats of upgrading, such as unavailable features.
- Mention external shaders not being updated by the conversion tool.
- List optional things to do before upgrading to make the process smoother.
2022-12-05 13:15:52 +01:00
FeralBytes
fad177f9b0 Change match typeof() example from REAL to FLOAT in GDScript reference (#6384)
TYPE_REAL no longer exists, changed to TYPE_FLOAT
2022-11-14 14:46:40 +01:00
Max Hilbrunner
4bdf16e6fe Merge pull request #6336 from opl-/fix/tool-mode-anchor
Fix tool mode section reference position
2022-10-24 02:42:55 +02:00
opl-
e0757940cf Fix tool mode section reference position 2022-10-23 21:52:52 +02:00
atn
eb60c8968c small correction
Removed an additional notify in the function's name
2022-10-20 09:27:51 +02:00
Max Hilbrunner
99d3d0be12 Renames / fixes for Godot 4 2022-10-17 00:35:07 +02:00
Max Hilbrunner
6c13f5ba58 More Godot 4 renames and fixes (#6317)
* Move ImmediateGeometry -> ImmediateMesh

* More Godot 3 -> Godot 4 renames
2022-10-15 23:12:48 +02:00
Max Hilbrunner
198393eec7 More Godot 4 rename fixes (#6315)
* Spatial -> 3D, Transform, Quaternion

* File -> FileAccess

* Camera -> Camera3D

* Update references to MeshInstance and MultiMeshInstance

* ImmediateGeometry -> ImmediateMesh, misc renames
2022-10-15 20:54:47 +02:00
Max Hilbrunner
024fedb0f3 Kinematic -> Character 2022-10-15 17:55:24 +02:00
Max Hilbrunner
1fffab8cf2 Formatting, syntax and URL fixes 2022-10-11 10:14:37 +02:00
NationalityNZ
24770fd215 Update gdscript_basics.rst (#5873)
* Update gdscript_basics.rst

Added some pragmatic advice for for-loops

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2022-10-11 09:32:13 +02:00
Max Hilbrunner
0f77b03a42 Merge pull request #6276 from HolonProduction/master
Add explanation of lambdas to GDScript basics.
2022-10-11 08:08:32 +02:00
HolonProduction
bd27c031a8 Add explanation of lambdas to GDScript basics.
Some examples and wordings were copied from the original proposal godotengine/godot-proposals#2431.

This also contains notion of one line functions.
2022-10-08 08:58:50 +02:00
HolonProduction
b0001380c0 Improve description of range function.
Fixes #5763

The description from before did not take negative `s` into account.
2022-10-07 23:30:45 +02:00
Evanaellio
3cb674285e Fix references to the @tool annotation 2022-09-21 22:48:04 +02:00
Hugo Locurcio
696f746dff Fix nested typed arrays being claimed as supported in GDScript reference 2022-09-04 19:41:53 +02:00
0xF812
b08b95d4f5 Fix missing quote in GDScript reference (#6123) 2022-08-30 16:39:44 +02:00
seanfy
1273f4a490 Fix typo in GDScript reference: 'user' -> 'use' (#6033) 2022-08-05 09:51:04 +02:00
Vladislav Vorobev
3dd5afca78 Fix missing code blocks in GDScript exports (#5998) 2022-07-28 23:08:51 +02:00
Jaime Crespo
33caaf6535 Fix misc syntax/style errors/warnings on documentation head (#5977) 2022-07-23 18:29:56 +02:00
kkoang
ffd84fa9a0 Fix inline code display in GDScript reference (#5907) 2022-07-03 21:02:15 +02:00
Spencer Kotys
22f820a036 Improved documentation for GDScript in keyword (#5883)
* Improve 'in' operator description

* Apply syntax suggestions from code review

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-06-22 18:48:29 +02:00
Danil Alexeev
e161f86cf5 Update docs about doc comments (@desc: replaced with blank line) (#5838) 2022-05-26 19:40:34 +02:00
Yuri Rubinsky
239c49cc8a Add pow operator to GDScript operators list 2022-05-12 11:10:14 +03:00
Haoyu Qiu
1c71b31210 Document zero padding and left alignment in format string (#5790) 2022-05-01 19:08:22 +02:00
Hugo Locurcio
b54e6e4ec8 Update syntax for GDScript 2.0 in GDScript exports 2022-04-10 01:55:11 +02:00
Micky
1d6c90a434 Change remaining "export" to "@export"
This PR changes the "export"s in the Array section of the GDScript Exports documentation to the "@export" annotation to be in line with 4.0.

Also slightly touches up the wording when referring to default null assignment and Packed*Arrays.
2022-02-27 14:30:15 +01:00
Zshandi Krahn
66305cf83b Fixed grammar in "Awaiting for signals" end note (#5586)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-02-24 14:54:09 +01:00
Rémi Verschelde
9621bed314 Merge pull request #5579 from Sauermann/fix-onready-annotations 2022-02-24 14:13:07 +01:00
skyace65
0b4017d519 Document line continuation in GDScript 2022-02-22 20:34:32 -05:00
Markus Sauermann
aaf6b3e504 Update tutorials: Rename Transform to Transform3D (#5603) 2022-02-14 13:27:37 +01:00