Commit Graph

249 Commits

Author SHA1 Message Date
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
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
A Thousand Ships
0686612e82 [GDScript] Clarify initialization of enum values 2024-08-31 14:41:33 +02:00
Max Hilbrunner
ff66473d3d Merge pull request #9787 from tetrapod00/gdscript-when
Document GDScript "when" and clarify pattern guard docs
2024-08-29 21:38:01 +02:00
tetrapod00
443d5e9be5 Add documentation for GDScript when statement 2024-08-26 09:39:41 -07:00
Matthew
f31489be83 Merge pull request #9713 from esainane/dancestors
Fix description of typed resource exports
2024-08-20 21:42:29 -04:00
MajorGonzo
1d05bdd9f1 Corrected typo in gdscript_basics.rst
beging -> begin
2024-08-20 08:38:57 -05:00
DDoop
e9035f7cf0 Add warnings for classes named "Editor" in GDscript and C# pages, class_name keyword/global class attribute (#9548)
* Added warning about Editor hiding class_names beginning with Editor prefix

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-08-14 19:42:36 +02:00
Sai Nane
f10b322c27 Fix description of typed resource exports
`AnimationNode`'s inherited classes are `Resource`, `RefCounted`, and `Object`.

I assume it meant to say "derived classes", or something along the lines of
"and all classes which inherit it".
2024-08-06 14:49:08 +00:00
Jace Bennest
d71c24c699 Update gdscript_styleguide.rst
fixes typo
2024-08-04 10:48:19 -07:00
Muller-Castro
a36ff907f9 Add typed loop variable example in GDScript reference (#9388) 2024-08-02 02:30:20 +02:00
Danil Alexeev
67be15e905 GDScript: Update lambda documentation 2024-06-29 14:51:46 +03:00
Hana - Piralein
3e2a8f6f7c Update outdated annotation and setget syntax
Co-Authored-By: PoolloverNathan <24194027+PoolloverNathan@users.noreply.github.com>
Co-Authored-By: Solor Vox <1246172+solorvox@users.noreply.github.com>
2024-06-27 22:13:37 +02:00
Hakunamawatta
eb14a4adae Typo in gdscript_basics.rst 2024-06-19 22:32:32 +10:00
A Thousand Ships
36e2351df2 Fix invalid indentation in various files 2024-06-06 16:16:45 +02:00
Matthew
194685b65d Merge pull request #9407 from ceejbro/patch-1
Remove Note from Constants
2024-06-04 21:20:34 -04:00
Hugo Locurcio
71cdbdd055 Tweak guidelines on dictionary and enum formatting in GDScript style guide
- Recommend writing each enum item on its own line, similar to C++.
- Recommend using spaces around inline dictionary declarations
  to make them easier to distinguish from arrays (due to similar-looking
  `[]` and `{}` characters in most fonts). This is commonly found
  in Python or JavaScript style guides.
2024-05-29 17:52:29 +02:00
CJ Brown
7b91dffc22 Remove Note from Constants
PR #71051
Documentation not updated to reflect deep read-only change to const Array and const Dictionary
2024-05-21 14:37:23 -04:00
Max Hilbrunner
4e216fc5fc Merge pull request #9313 from dalexeev/update-doc-markup-docs
Update class reference and doc comment markup documentation
2024-05-07 11:27:26 +02:00
Yuri Rubinsky
3e05334189 Add a super keyword to the table of keywords 2024-05-02 18:35:10 +03:00
Danil Alexeev
c89b0e6ab3 Update class reference and doc comment markup documentation 2024-05-02 13:14:02 +03:00
Max Hilbrunner
160034a4ac Merge pull request #9188 from allenwp/annotation-improvements
Improve description of annotations
2024-04-30 04:19:10 +02:00
Allen Pestaluky
8dd09aa962 Improved description of annotations
Removes an unnecessary and potentially confusing comparison of annotations to keywords and generally improves wording in the GDScript Basics tutorial. A new page to the Contributing section has been added for scripting development guidelines. This new page hosts suggestions on when annotations should be implemented in GDScript.
2024-04-29 13:18:30 -04:00
NormPlum
94b33fc106 Update gdscript_basics.rst
Fix grammar re. 'await/awaiting'.
2024-04-27 03:13:09 +00:00
JP
4ae3064699 Fixed out of date binding syntax for Signal.connect
fixes godotengine/godot-docs#9236
2024-04-23 13:33:09 +02:00
Danil Alexeev
60befd7527 GDScript: Clarify raw string literals documentation 2024-04-09 16:25:03 +03:00
lena
2925c83390 docs: Clarify associativity of operators. (#9170)
* docs: Clarify associativity of operators.
2024-04-06 19:28:25 +02:00
Abel Toy
bd7bc61e9e Document new feature allowing @exported Arrays to set property hints for their elements (#9061)
* Document export variations for arrays

* Update tutorials/scripting/gdscript/gdscript_exports.rst

Co-authored-by: Raul Santos <raulsntos@gmail.com>

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-03-25 17:34:38 +01:00
444B
3d441150b1 Update gdscript_styleguide.rst - clarified sentence and grammar (#9110)
* Update gdscript_styleguide.rst - clarified sentence and grammar

- Clarified the statement on "One statement per line"
- Removed unclear sentence with incorrect grammar

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-03-21 11:49:25 +01:00
Danil Alexeev
88ec4c294b GDScript: Document @export_storage annotation 2024-03-01 22:28:32 +03:00
Danil Alexeev
200c91b679 GDScript: Update deprecated/experimental docs 2024-02-16 12:00:18 +03:00
Danil Alexeev
46e69f0d1e GDScript: Document is not operator 2024-02-07 13:25:33 +03:00