Browse Source

Add warning to making-plugins reminding about tool keyword

I've repeatedly forgotten that other scripts used in editor plugins
*also* need to have the `tool` keyword, otherwise it fails to correctly
run.
N0hbdy 5 years ago
parent
commit
e433e7a40b
1 changed files with 5 additions and 0 deletions
  1. 5 0
      tutorials/plugins/editor/making_plugins.rst

+ 5 - 0
tutorials/plugins/editor/making_plugins.rst

@@ -72,6 +72,11 @@ EditorPlugin script for you. The script has two requirements that you cannot
 change: it must be a ``tool`` script, or else it will not load properly in the
 change: it must be a ``tool`` script, or else it will not load properly in the
 editor, and it must inherit from :ref:`class_EditorPlugin`.
 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
+    will act like an empty file!
+
 It's important to deal with initialization and clean-up of resources.
 It's important to deal with initialization and clean-up of resources.
 A good practice is to use the virtual function
 A good practice is to use the virtual function
 :ref:`_enter_tree() <class_Node_method__enter_tree>` to initialize your plugin and
 :ref:`_enter_tree() <class_Node_method__enter_tree>` to initialize your plugin and