Commit Graph

279 Commits

Author SHA1 Message Date
Lexyth
7b7952ae71 Clarify type-safety of as
Changed the statement about the as keyword's type-safety to clarify that it is less type-safe than type hints.
2025-03-19 00:37:10 +01:00
RazerTexz
820fdbe6b7 String.format() wrong placeholder syntax
From: `var string = "I have {} cats.".format([3])`
To: `var string = "I have {0} cats.".format([3])`
2025-03-04 11:21:22 +05:00
Matthew
b12476f595 Merge pull request #10625 from Vocco/update-bound-signal-args
Update binding Signal connection args docs
2025-03-02 14:33:13 -05:00
Matthew
59a53252ec Merge pull request #10659 from tetrapod00/doc-not-toc
Update links to C# and GDScript sections
2025-02-22 08:13:44 -05:00
Hugo Locurcio
8d9085ae7c Add guidelines on inline comments in GDScript style guide (#9433)
* Add guidelines on inline comments in GDScript style guide
2025-02-15 23:03:26 -05:00
Thibault J.
70def630be Clarify the global registration of named_classes (#10679)
* Add a clarification about named class registry
2025-02-15 15:24:53 -05:00
tetrapod00
048bb2775e Update links to C# and GDScript sections
- Change all links to '_doc' anchors instead of 'toc's.
- Move 'doc_c_sharp' and 'doc_gdscript' to the index pages.
- Add 'doc_gdscript_reference' anchor.
- Update all existing links to point to the right place,
updating grammar if needed.
2025-02-09 16:16:43 -08:00
Vojtech Krajnansky
4421c6226c Update binding Signal connection args docs 2025-02-06 18:34:43 +01:00
Sai Nane
98ce9b570b Briefly document Vector<> variations
`Packed*Array` aliases seem universally preferred where available, so
a link to the list of types seems appropriate.

`LocalVector` is used sparingly, so mentioning the intent and rough
tradeoff involved seems right for an overview.
2025-01-29 12:20:45 +00:00
Emily
99b1f86d53 Update list of advantages and disadvantages to more accurately refle… (#8736)
* Updated list of advantages and disadvantages
2025-01-25 15:15:26 -05:00
Martin Beaussart
d18c89ba71 Update code order with static annotation on gdscript_styleguide.rst (#8920)
* Update code order with static annotation on gdscript_styleguide.rst

Update code order on gdscript_styleguide.rst
by inserting static variables and methods on the code order as a proposal
2025-01-25 12:06:20 -05:00
Billy Guzik
42ac7c8431 Update gdscript_exports.rst (#9327)
* Update gdscript_exports.rst

Added hyperlinks for each export type that lead to annotation documentation further explaining each export type, as requested in issue#9281
2025-01-25 11:32:33 -05:00
tetrapod00
8d1a93f2ff Add links from GDScript keywords table to relevant sections 2025-01-21 15:29:51 -08:00
Hugo Locurcio
265397c5fc Add @icon ordering to the GDScript style guide 2025-01-13 17:25:42 +01:00
Amaral Krichman
65da706a85 Update gdscript_basics.rst 2025-01-03 00:19:39 -03:00
lena
63cec69b30 Add a paragraph about self (#8928)
Adds a paragraph about the self keyword and documents that
it can be used to refer to variables defined in subclasses of
current class.

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: RedMser <5117197+RedMser@users.noreply.github.com>
Co-authored-by: Danil Alexeev <dalexeev12@yandex.ru>
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-12-26 15:30:42 -08:00
Danil Alexeev
d610bfdf23 GDScript: Document @warning_ignore_start and @warning_ignore_restore 2024-12-23 23:58:46 +03:00
Max Hilbrunner
47d39d9048 Merge pull request #10413 from tetrapod00/be-nice-to-c
Rephrase dictionary description in Advanced GDScript
2024-12-16 19:11:59 +01:00
tetrapod00
fdfa3ea66e Rephrase dictionary description in Advanced GDScript 2024-12-15 13:58:40 -08:00
tetrapod00
bd25f5813a Simply remove some words 2024-12-14 20:36:17 -08:00
Hugo Locurcio
806a4fccfd Add a page on the Output bottom panel 2024-12-07 08:40:44 +01:00
52SW
e05cebecdb Document GDScript @export_tool_button (#10338)
* Add @export_tool_button to the documention
2024-11-29 15:18:08 -05:00
Quinn
6292c86298 Replace mentions of Reference with RefCounted 2024-11-29 22:13:27 +10:00
mechalynx
0f8c24b071 Update PackedArray explanation to match Godot 4.0 behavior (#10304)
Add paragraphs describing the differences between PackedArray and
normal or typed Array.

---------

Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-22 10:03:47 +01:00
tetrapod00
c1310e6009 Add GDScript naming convention summary table
Co-Authored-By: Edwin <60202421+emarino135@users.noreply.github.com>
Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-11-20 14:40:36 -08:00
tetrapod00
09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
Max Hilbrunner
9a886ec4af Merge pull request #10276 from mhilbrunner/cherry-pick-10242
Cherrypick #10242 (Add info about layer mask exporting to physics_introduction) to master
2024-11-17 11:36:07 +01:00
Max Hilbrunner
ff46ea4407 Merge pull request #9777 from 0stam/is-not-conversion
Use the newly introduced ``is not`` operator
2024-11-17 11:34:55 +01:00
notPelf
00221436f4 Add info about layer mask exporting to physics_introduction.rst (#10242)
* Update physics_introduction.rst

The docs page for raycasting provides a link to the physics introduction page for how to set a collision mask on a raycast created in code. The physics introduction page does not mention export annotations for exporting a collision mask. This pull request adds a brief bit about exporting layer masks, and links to the export annotation docs.

---------

Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-17 11:30:23 +01:00
Hugo Locurcio
4c3020b775 Document @export_custom and additional range hints in GDScript exports
This also adds a hint suffix example to C# exports.

Co-authored-by: Shawn Hardern <126725649+ShawnHardern@users.noreply.github.com>
2024-11-11 17:22:44 +01:00
Max Hilbrunner
396fc8fd08 Merge pull request #10227 from tetrapod00/integral-integer
Improve GDScript format strings tutorial
2024-11-08 00:18:03 +01:00
tetrapod00
5606be5c75 Improve GDScript format strings tutorial
Remove usages of "integral".
Add section on string concatenation.
Improve organization.
Fix incorrect examples.
2024-11-07 14:45:21 -08:00
tetrapod00
5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00
0stam
6ef6ad8a4c Use the newly introduced `is not` operator 2024-11-06 23:06:58 +01:00
Max Hilbrunner
eee29a2911 Merge pull request #10075 from KleidonBD/patch-1
Fix "or_greater"/"or_less" code example
2024-11-05 22:42:32 +01:00
Andrey Solomatin
832e85d38a Made edits to match GDScript code order
Updated gdscript_documentation_comments.rst
2024-10-31 12:36:54 +03:00
Max Hilbrunner
cc48adbf4e Merge pull request #10080 from tetrapod00/gdscript-sidebar
Improve GDScript Basics sidebar navigation by changing header levels
2024-10-28 23:22:36 +01:00
tetrapod00
3bc5ea85af Remove references to 3.x minor versions
Removes notes about features being introduced in 3.x minor versions. In 4.x, these
details are no longer relevant.
2024-10-20 15:35:32 -07:00
tetrapod00
a6484f9841 Fix docstring written as comment 2024-10-19 11:31:59 -07:00
Max Hilbrunner
8d28f0fc82 Merge pull request #10097 from Calinou/gdscript-basics-documentation-comments
Mention documentation comments in GDScript basics
2024-10-18 05:33:23 +02:00
Max Hilbrunner
be9be7fb28 Merge pull request #10093 from Calinou/variant-not-null
Document Variant not being nullable
2024-10-18 05:32:34 +02:00
Hugo Locurcio
cbf61b3f02 Document Variant not being nullable 2024-10-17 15:28:24 +02:00
Hugo Locurcio
594a1d6cbc Mention documentation comments in GDScript basics 2024-10-17 15:12:35 +02:00
Hugo Locurcio
a878406e8d Clarify restrictions on nested array types in Static typing in GDScript 2024-10-16 16:23:32 +02:00
tetrapod00
4a24e7553b Improve GDScript Basics sidebar navigation by changing header levels
Promotes many headers up one level, so they appear in the sidebar.
Removes the redundant Language header, since the whole page is about the language.
2024-10-13 13:30:41 -07:00
Kleidon
198625efea Fix "or_greater"/"or_less" code example
The code example demonstrating the usage of the "or_greater" and "or_less" hints for the export_range annotation does not declare a variable after the annotation, which is inconsistent with the previous three code examples in the section.
Also, giving the export_range a step of 1 does not create a slider for the property in the editor, like the text suggests, but it instead creates a spin box. The step should be changed to a float so the property can appear as a slider.
2024-10-11 18:56:18 -06:00
Aaron Franke
a74060b969 Add a note about GDScript format strings in C++ (#10061) 2024-10-08 13:23:56 +02:00
Junwan Park
e01a998069 Fix builtin_types link in tutorial gdscript_basics page
It's linked to a wrong position.
2024-09-27 01:43:04 +09:00
Hugo Locurcio
960125f576 Fix Code order section saying it's the first section in GDScript style guide
It's not the first section of the page anymore.
2024-09-23 23:58:39 +02:00
Hugo Locurcio
4726e131db Document PackedVector4Array
This type was added in Godot 4.3.
2024-09-02 22:21:50 +02:00