Commit Graph
689 Commits
Author SHA1 Message Date
Thaddeus Crews f70686cdbe CI: Integrate pre-commit for style checks 2024-11-14 14:08:49 -06:00
Hugo LocurcioandShawn Hardern 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
Matthew 8daa3af406 Merge pull request #10233 from tetrapod00/debug-tools-outdated
Update list of debugging settings
2024-11-08 20:53:35 -05:00
tetrapod00 6a11d113e7 Update list of debugging settings 2024-11-08 16:15:27 -08: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
Matthew 8db59234ae Merge pull request #10214 from tetrapod00/project-settings-links
Link to project settings when mentioning them
2024-11-06 19:15:41 -05: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
tetrapod00 a8667ffddf Add links to project setting mentions 2024-11-05 11:55:14 -08:00
Max Hilbrunner af6ab3db67 Merge pull request #10098 from TheSecondReal0/csharp-signal-parameters
Add C# documentation for connecting to GDScript signals with parameters
2024-11-05 00:44:28 +01:00
tetrapod00 2f634c7acb Improve display of rubric fake headers with heading-level option 2024-11-02 09:42:55 -07:00
Andrey Solomatin 832e85d38a Made edits to match GDScript code order
Updated gdscript_documentation_comments.rst
2024-10-31 12:36:54 +03:00
Anaclecio Brederodes e01f00f069 Correctly name enum type
Previously the example defined a "MyEnum" enum, but used a "SpellElements" type export. I've changed so it now defines a "SpellElements" enum.
2024-10-29 18:36:16 -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
Max Hilbrunner 18092b00e2 Merge pull request #10151 from adamscott/add-caption-filename
Add filenames as captions for code blocks
2024-10-28 23:21:39 +01:00
Max Hilbrunner 830fa18c79 Merge pull request #10150 from tetrapod00/csharp-diagnostic-nesting
Fix unreachable pages in sidebar under C# Diagnostics
2024-10-28 14:31:38 +01:00
Hugo Locurcio 748775370a Use negative index for get_child() in Singletons (Autoload) 2024-10-27 22:24:28 +01:00
Adam Scott 44dfb3a390 Add filenames as captions for code blocks 2024-10-27 16:18:36 -04:00
tetrapod00 9a5507829e Fix unreachable pages in sidebar under C# Diagnostics 2024-10-27 12:46:48 -07: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 7f27fd7f16 Merge pull request #10078 from Calinou/csharp-global-classes-filename
Document filename requirements in C# global classes
2024-10-18 05:38:32 +02: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
Asa Sprow a4c0b37464 add C# documentation for connecting to gdscript signal with parameters 2024-10-17 09:45:30 -06: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 30eebc4bb7 Document filename requirements in C# global classes
- Flesh out the introduction.
2024-10-17 10:45:46 +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
3ed0339c87 Add a gdextension online documentation guide. (#9966)
* Add a gdextension online documentation guide.

---------

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-authored-by: Patrick Exner (FlameLizard) <patrick.exner1@web.de>
2024-10-08 16:56:39 +02:00
Aaron Franke a74060b969 Add a note about GDScript format strings in C++ (#10061) 2024-10-08 13:23:56 +02:00
Hugo Locurcio 36bb7e5ac5 Document expression evaluator in Debugger panel 2024-10-05 00:35:05 +02:00
Max Hilbrunner c689e0e618 Merge pull request #9996 from Ivorforce/patch-2
Fix kbd description in gdextension docs system.
2024-09-28 14:12:08 +02:00
Max Hilbrunner ddb3df40c8 Merge pull request #9989 from tetrapod00/sidebar
Fix unreachable pages in sidebar by using fake headers in index pages
2024-09-28 13:32:11 +02:00
Lukas Tenbrink 252b2fd47e Fix kbd description in gdextension docs system. 2024-09-26 22:27:09 +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
tetrapod00 283fe11715 Improve sidebar navigation by removing headers
- Ensure most pages are reachable through the sidebar, by removing headers on pages that are mostly indexes.
- This also means that some pages now have navigable headers again.
2024-09-23 01:32:56 -07:00
Hugo Locurcio 89508cdc98 Fix outdated reference to register_class function in GDExtension C++ example
This was replaced by the `GDREGISTER_CLASS` macro in Godot 4.0.
2024-09-19 01:33:41 +02:00
Hugo Locurcio be34108636 Document profiler autostart functionality 2024-09-16 23:33:41 +02:00
Hugo Locurcio 8f320d5e54 Fix incorrect statement in node_type being case-insensitive in Creating script templates
On case-sensitive filesystems, the case must match the actual node name,
so the folder will most likely need to use uppercase characters in its name
(e.g. `MeshInstance3D`).
2024-09-15 16:00:05 +02:00
Hugo Locurcio fe80ff22df Fix ADD_PROPERTY() calls in GDExtension C++ example to use correct syntax
This matches how properties are declared in core Godot.
2024-09-06 22:25:59 +02:00
RedStainedInk c855ff7811 Removed outdated information about Mono SDK beeing necessary
Mono SDK isn't necessary any more for Godot .NET to work properly on Linux. All functionality that was needed from Mono back then is now provided by .NET proper.

I fear Mono SDK might even cause some conflict with up-to-date .NET.
2024-09-05 22:42:33 +02:00
Hugo Locurcio b95f46f078 Fix incorrect setup instructions in The profiler 2024-09-05 02:19:27 +02:00
Hugo Locurcio 4726e131db Document PackedVector4Array
This type was added in Godot 4.3.
2024-09-02 22:21:50 +02:00
Max Hilbrunner 2d792b4aa8 Merge pull request #9872 from AThousandShips/enum_doc_improve
[GDScript] Clarify initialization of enum values
2024-09-02 00:00:12 +02:00
gachipan a2c22b4a3f Remove confusing end of sentence from the_profiler.rst documentation
Cut off the end of a sentence that doesn't make sense:

"You can also start profiling at any time before or during gameplay, depending on if you want."

It seems like removing the "depending on if you want." improves clarity of the documentation.
2024-08-31 13:51:54 -07:00