Merge pull request #9101 from skyace65/Tool-Info

Add more tool script info and add a section
This commit is contained in:
Max Hilbrunner
2024-03-17 05:43:41 +01:00
committed by GitHub
2 changed files with 12 additions and 10 deletions

View File

@@ -96,7 +96,7 @@ editor, and it must inherit from :ref:`class_EditorPlugin`.
.. warning::
In addition to the EditorPlugin script, any other GDScript that your plugin uses
must *also* be a tool. Any GDScript without ``@tool`` imported into the editor
must *also* be a tool. Any GDScript without ``@tool`` used by the editor
will act like an empty file!
It's important to deal with initialization and clean-up of resources.

View File

@@ -105,18 +105,20 @@ Here is how a ``_process()`` function might look for you:
// Code to execute both in editor and in game.
}
.. note::
Important information
---------------------
Modifications in the editor are permanent. For example, in the following
case, when we remove the script, the node will keep its rotation. Be careful
to avoid making unwanted modifications.
Any other GDScript that your tool script uses must *also* be a tool. Any
GDScript without ``@tool`` used by the editor will act like an empty file!
.. note::
Extending a ``@tool`` script does not automatically make the extending script
a ``@tool``. Omitting ``@tool`` from the extending script will disable tool
behavior from the super class. Therefore the extending script should also
specify the ``@tool`` annotation.
Extending a ``@tool`` script does not automatically make the extending script
a ``@tool``. Omitting ``@tool`` from the extending script will disable tool
behavior from the super class. Therefore the extending script should also
specify the ``@tool`` annotation.
Modifications in the editor are permanent. For example, in the next
section when we remove the script, the node will keep its rotation. Be careful
to avoid making unwanted modifications.
Try ``@tool`` out
-----------------