Commit Graph

865 Commits

Author SHA1 Message Date
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
Lukas Tenbrink
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
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
Hana - Piralein
82292025d9 Update codespell path and fix spelling errors 2024-08-26 07:50:50 +02:00
Kongfa Waroros
f27d12979d Update certain example code snippets to use the new syntax 2024-08-23 14:16:54 +07:00
Max Hilbrunner
b6e3e5b2f9 Merge pull request #9790 from bruvzg/gde_ios
[GDExtension] Add missing iOS instructions and build/config example code.
2024-08-21 13:53:38 +02:00
Matthew
be8e0d52cc Merge pull request #9773 from darkstarworks/master
Update 07.killing_player.rst
2024-08-20 21:54:57 -04:00
Matthew
f31489be83 Merge pull request #9713 from esainane/dancestors
Fix description of typed resource exports
2024-08-20 21:42:29 -04:00
Matthew
58f0770650 Merge pull request #9791 from MajorGonzo/master
Corrected typo in gdscript_basics.rst
2024-08-20 21:21:32 -04:00
Matthew
ce997a0ec7 Merge pull request #9793 from raulsntos/dotnet/defines
C#: Remove references to `GODOT_SERVER` and `GODOT_HTML5` defines
2024-08-20 21:14:13 -04:00
Raul Santos
c138ee01eb C#: Remove references to GODOT_SERVER and GODOT_HTML5 defines
- The `GODOT_SERVER` preprocessor define is no longer available in Godot 4, since the dedicated server platform was removed.
- Replaced a reference to `GODOT_HTML5` with `GODOT_WEB` since that platform was also renamed in Godot 4.
- Remove note about `<DefineConstants>` that only really applies to Godot 3.
2024-08-20 16:53:10 +02:00
MajorGonzo
1d05bdd9f1 Corrected typo in gdscript_basics.rst
beging -> begin
2024-08-20 08:38:57 -05:00
bruvzg
3414754a36 [GDExtension] Add missing iOS instructions and build/config example code. 2024-08-20 10:59:23 +03:00
Dark Star
4664e7ab19 Updated images to match docs
Fixing issues/9775
2024-08-17 22:16:10 +02:00
Patrick Exner
03f966ab73 Fix project structure diagram in gdextension docs system docs 2024-08-15 19:11:25 +02: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
Balázs Kalydi
91717ff234 Update GDExtension tutorial with the hot reload feature (#9618)
Although the tutorial assumed the hot reload feature, it wasn't enabled in the example config file. Also it didn't mention that it only works if it's compiled in debug mode.
2024-08-14 19:31:17 +02:00
Patrick Exner (FlameLizard)
b21addcf51 Add page about gdextension docs generation (#9667)
* Adding page about gdextension docs generation

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-08-14 19:27:31 +02:00
skyace65
f15784d14b Add info in instancing for opening the demo project 2024-08-11 22:45:27 -04: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
Max Hilbrunner
083f7589b9 Merge pull request #9708 from thejacer87/patch-1
Update gdscript_styleguide.rst
2024-08-06 05:58:39 +02:00
Jace Bennest
d71c24c699 Update gdscript_styleguide.rst
fixes typo
2024-08-04 10:48:19 -07:00
Tristan A.
a2d29557ed CSharp example missing return type 2024-08-02 22:34:28 +02:00
Muller-Castro
a36ff907f9 Add typed loop variable example in GDScript reference (#9388) 2024-08-02 02:30:20 +02:00
A Thousand Ships
0c9eaf14c3 Merge pull request #9644 from Incognito357/Incognito357-update-docs-change_scenes_manually
Update change_scenes_manually.rst
2024-07-30 07:32:08 -09:00