Commit Graph

225 Commits

Author SHA1 Message Date
Max Hilbrunner
723a9a38c8 Merge pull request #9873 from HolonProduction/sub-plugins
Document sub plugins
2024-11-17 13:09:45 +01:00
tetrapod00
f2717085dc Change warnings to dangers if data loss can occur 2024-11-12 01:15:51 -08:00
Max Hilbrunner
e78f537a33 Merge pull request #9979 from godotengine/Hilderin-documentation_add_autoload_singleton_in_plugin
Fix code sample for add_autoload_singleton in plugin
2024-10-05 13:50:04 +02:00
Kleidon
cde678c53b Fix "some times" typo
The space in "some times" is a mistake and should be removed as it should be one word, not two (as can be seen when it is used correctly further down the page at the start of the, "Running one-off scripts using EditorScript" section).
2024-10-03 18:46:30 -06:00
Hilderin
69d0d47efb Fix code sample for add_autoload_singleton in plugin
- Add documentation for issue https://github.com/godotengine/godot/issues/68285
2024-09-19 20:02:07 -04:00
HolonProduction
06d9bcd36e Document sub plugins 2024-08-31 17:38:51 +02:00
The-Cyber-Captain
a293204d03 Fix outdated method name in code sample in 3D gizmo plugins (#9695)
Addresses "Unnamed Gizmo" error when following example code;
now overriding `_get_gizmo_name` function, not `get_name`.
2024-08-02 01:41:45 +02:00
A Thousand Ships
36e2351df2 Fix invalid indentation in various files 2024-06-06 16:16:45 +02:00
Hugo Locurcio
06bd5b3ccb Fix false positives in codespell CI and fix reported typos
- Don't install codespell when building offline docs
  as it's not needed in that workflow.
2024-05-31 10:58:12 +02:00
Stefan Heinz
fdee495376 Change "Editor > Convert Icons With Editor Theme" to "Editor > Convert Colors With Editor Theme" 2024-05-05 21:46:08 +02:00
betalars
2627630b7a fixing typo 2024-04-28 19:00:17 +02:00
betalars
e6c8e512a7 Provide instructions for resource change notifications in tools (#9283) 2024-04-27 18:27:24 +02:00
skyace65
49d3e3e714 add more tool script info and add a section 2024-03-16 12:44:30 -04:00
Eric Lathrop
38f1683e7c Fix method names
Several referenced method names are missing the leading underscore.
2024-03-11 10:17:05 -04:00
Caiman
ef828fb837 Inspector plugin tutorial: update PackedScene.instance() ref
I noticed that the tutorial still says `instance()` instead of `instantiate()`, so I changed it to match the 4.x method name.
2024-01-26 04:31:24 +01:00
Max Hilbrunner
01a7b2ff94 Merge pull request #7520 from Calinou/add-page-comments
Add support for user-provided comments with Giscus
2024-01-13 22:32:30 +01:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Hugo Locurcio
e93fc9b1f2 Document importing SVG images with text
- Mention editor plugins and custom node icons should use the appropriate
  import options.
2024-01-11 00:18:50 +01:00
Hugo Locurcio
48596bc9ed Document using EditorScript in Running code in the editor
EditorScript is useful for one-off operations such as:

- Use as a playground for GDScript or C# scripting without
  having to run a project.
- Scale all light nodes in the currently edited scene.
- Replace nodes that were copy-pasted with scene instances.
2023-11-14 12:03:11 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Hugo Locurcio
049eebc6f1 Use EditorInterface singleton in Making main screen plugins
This singleton replaces the now-deprecated `get_editor_interface()`
method in Godot 4.2.
2023-11-08 00:48:43 +01:00
Matthew
b2f6169729 Merge pull request #8301 from k0T0z/fix-scenes-code-examples
Replacing `find_node()` with `get_node()` as `find_node()` doesn't exist
2023-10-21 22:27:39 -04:00
Saif Kandil
6ae3d3beec replacing find_node() with get_node() as find_node() doesnt exist anymore
Signed-off-by: Saif Kandil <74428638+k0T0z@users.noreply.github.com>
2023-10-21 19:18:21 +03:00
MannyC
3bcb5e76f3 inspector_plugins.rst: add new "wide" parameter to _parse_property
Godot 4.0 added a new parameter to EditorInspectorPlugin._parse_property.  This was updated in the C# version of the tutorial, but not the gdscript version

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-10-11 15:04:01 +01:00
Max Hilbrunner
4011dc55a6 Merge pull request #7831 from bmolyneaux/master-1
Add a note about tool script inheritance
2023-10-09 01:57:47 +02:00
Max Hilbrunner
f778048468 Merge pull request #8014 from curious-broccoli/code-editor
Fix sentence in tutorial code in the editor
2023-09-24 23:36:53 +02:00
curious-broccoli
9ba2cf2a92 Fix sentence in tutorial code in the editor 2023-09-23 12:46:50 +02:00
Mateus Elias
e77e9e8877 Fix wrong C# code examples in making plugins tutorial 2023-09-04 13:19:38 -03:00
Mateus Elias
7648846bd9 Add missing C# code in making plugins tutorial
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2023-09-01 10:20:34 -03:00
Ben
5b70a0ab92 fix typo 2023-08-21 19:17:18 -07:00
Ben
0bd9b4842b Add a note about tool script inheritance
Related proposal: https://github.com/godotengine/godot-proposals/issues/754
2023-08-21 19:12:58 -07:00
Raul Santos
c457ab79ec Update some C# examples
- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Follow our code style more closely.
- Other minor code fixes.
2023-05-18 13:14:05 +02:00
Max Hilbrunner
72c0af46b2 Snake-case .tscn, .gd and _on_* callbacks
Co-authored-by: Doug Thompson <s-git@dougthompson.co.uk>
2023-05-18 12:46:58 +02:00
The Tophat Demon
5aa58b07ce Corrected sample code in import_plugins.rst
The sample code listed the function ``get_import_options`` when it most likely meant ``_get_import_options`` (with an underscore in front). Some of the sample code also used the outdated File API instead of the FileAccess API.

Corrected more function names. Updated parameters for _get_import_options and _get_preset_name in sample code.
2023-05-09 08:29:52 -05:00
Hana - Piralein
ef3b44ef4e update images and related information 2023-05-08 21:22:06 +02:00
FeatherAntennae
58e03e3afc - Rebased on master
- Replaced the "empty string" with "empty array" in the comment about how to report no errors.
- Renamed warning variable to warnings to indicate that it can contain multiple warnings.
2023-05-04 18:05:41 -04:00
Mark Wilson
872e5ff840 Fix C# issues in inspector-plugin tutorial (#7223)
* Fixed C# EditorInspectorPlugin _CanHandle parameter type

Updated Inspector Plugin tutorial to reflect that C#'s
EditorInspectorPlugin::_CanHandle() takes a GodotObject, not a
Variant.

* Eliminated horizontal scroll in C# for inspector-plugin tutorial

Put a line-break and indentation to avoid horizontal scrolling in
the displayed code.

* Fixed _ParseProperty() method signature and undeclared variable

Changed example code for EditorInspectorPlugin::_ParseProperty():
* Fixed method signature
* Use new enum type of parameter for comparison instead of int.
* Use "name" parameter as property-identifying argument to
AddPropertyEditor() instead of undeclared variable

* Fixed override method name in EditorProperty example

Updated example to use virtual method _UpdateProperty() instead of
non-virtual method UpdateProperty().
2023-04-26 18:50:51 +02:00
Pixdigit
ef7dad0f4b Replace legacy setget in tool tutorial (#7225)
* Replace legacy setget in tool tutorial

Replace reference to legacy setget keyword and replace it with the new setter style in the "Running Code in the Editor" tutorial.

---------

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2023-04-26 12:49:37 +02:00
Mark Wilson
93922aaa8c Fixed C# file-path strings for example plugin resources
The example (tutorial) plugin resides in an addons/my_custom_node
subdirectory of its project. The C# example code uses the same
relative path structure for a custom script and icon as the
GDScript example. These paths cause errors when the user activates
the plugin, as Godot looks for the resources in the root directory
of the project. This change fixes the errors by using the fully
qualified "res://" path to the resources in the C# example code.
2023-04-20 00:42:08 -04:00
Daniel Delgado
db45a5378b Fixed 'Reporting node configuration warnings' code snippet
- Switched .size for .length
- initialized warnings as empty array
- warning.append instead of +=
- deleted new line
2023-04-10 12:13:12 +02:00
Kasper Frandsen
69e8f24fdd docs: fix for File -> FileAccess change 2023-03-21 15:17:09 +00:00
Loregret
d49e16c0c0 Update "Reporting node..." segment
Current code doesn't work with Godot 4.0

I added @ to export variables and changed update_configuration_warning() to new update_configuration_warnings().
2023-03-07 14:03:28 +03:00
Haoyu Qiu
ff5fab13f4 Fix Autoload capitalization inconsistency 2023-03-04 09:33:48 +08:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Yuri Sizov
4e9b3ab73b Merge pull request #6717 from Flavelius/patch-1
Fix wrong registration method names for 3D gizmo plugins
2023-02-04 22:17:37 +03:00
Raul Santos
b319da3f07 Update some C# examples for 4.0 (#6693)
* Update some C# examples

- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Other minor code fixes.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-04 17:03:03 +01:00
Julien Winning
0f5a516a0f Update 3d_gizmos.rst
As mentioned here https://github.com/godotengine/godot-docs/issues/6716
add/remove_node3d_gizmo_plugin is the wrong method name. But i'm not sure if it intentionally changed to add/remove_node_3d_gizmo_plugin.
Here are the adjustments anway in case it is intentional and going to stay that way.
2023-02-01 13:42:27 +01:00
Winston
9f6be55665 Use correct function names and arguments 2023-01-24 12:30:27 +01:00
Yuri Sizov
64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2023-01-14 18:49:07 +03:00
Hana
9e90766a92 update c# class examples 2023-01-12 19:38:20 +01:00