Commit Graph

247 Commits

Author SHA1 Message Date
Rageking8
2df068f087 Add some button roles (#11257)
* Add some `button` roles
2025-09-07 12:55:33 -04:00
Kai Liao
a6defa7ae8 Update running_code_in_the_editor.rst to fix misplaced method defs in C# example
OnResourceSet() and OnResourceChanged() were invalidly defined outside of the class examples
2025-08-05 17:18:15 -07:00
AtelierFerrofell
edebaa4fb7 Update running_code_in_the_editor.rst to fix error in example code
Example was potentially trying to connect a signal from a null reference
2025-08-05 02:34:48 -07:00
Matthew
90fc3e7915 Merge pull request #10820 from ryevdokimov/autoload-nodes-can-be-accessed-with-tool-scripts
Autoload nodes can be accessed in the editor if they're using tool scripts
2025-07-27 14:41:39 -04:00
Matthew
3f65fd4614 Merge pull request #10888 from Calinou/running-code-in-the-editor-static-context
Clarify rules around which scripts require `@tool` in Running code in the editor
2025-07-18 07:54:13 -04:00
A Thousand Ships
92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
Matthew
3dbb51b86c Merge pull request #10889 from Calinou/running-code-in-the-editor-no-debugger
Mention the lack of debugger support in Running code in the editor
2025-04-23 10:01:08 -04:00
Hugo Locurcio
ab7c43c899 Clarify rules around which scripts require @tool in Running code in the editor
- Mention that static methods work, but not static variables.
- Emphasize the use of version control due to the lack of undo/redo.
2025-04-22 14:47:20 +02:00
Hugo Locurcio
c737b30d5d Mention the lack of debugger support in Running code in the editor 2025-04-22 14:38:51 +02:00
Hugo Locurcio
72834c31a3 Fix typo in C# example in Running code in the editor 2025-04-22 14:14:59 +02:00
Robert Yevdokimov
0c64741bba Autoload nodes can be accessed in the editor if they're using tool scripts 2025-03-30 23:57:23 +04:00
lordstickman543
ff50eb0a00 Update making_main_screen_plugins.rst 2025-03-16 11:21:09 -06:00
Adriaan
f0f13fcdbb Clarify that EditorScript can only run using the internal script editor (#8623)
* Add note that _run() can only be called from Godot's internal script editor
2025-03-02 11:50:21 -05:00
betalars
f766bad7db Add link to original issue
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2025-01-23 23:44:31 +01:00
betalars
76d10dc3f5 replace danger with warning
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2025-01-23 23:43:41 +01:00
betalars
8d14299b06 fixes #7184: adding warning about tool scripts needing editor restart 2025-01-23 11:05:25 +01:00
Max Hilbrunner
c477a8ef60 Merge pull request #10282 from tetrapod00/expand-project-settings
Overhaul Project Settings page
2025-01-03 10:42:08 +01:00
tetrapod00
c4d3aa134a Standardize RST header syntax 2024-12-29 13:44:09 -08:00
tetrapod
a64084d491 Merge pull request #9743 from vgezer/scripteditor
Text editor documentation
2024-12-18 14:03:58 -08:00
Volkan Gezer
c8be8497af Text editor documentation 2024-12-13 12:03:17 +01:00
easterNday
f967e9e135 Fix C# main screen plugin example and document C# EditorInterface singleton (#9399)
* 🐞 fix(plugins): fix syntax errors

Correct the syntax errors in the plugin development section, specifically by modifying 'EditorInterface' to 'EditorInterface.Singleton' in the C# portion. It is imperative to utilize the singleton pattern here to ensure the plugin successfully compiles.

* 🐞 fix(different): ADD exceptions

Provide explanations for Singleton exceptions of `EditorInterface`
2024-12-10 11:08:19 -08:00
tetrapod00
42abf26423 Update Project Settings page
- Add screenshots
- Document reading and writing settings
- Document manually editing project.godot
- Note that most settings are changed in different
classes at runtime
2024-11-17 22:29:44 -08:00
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