godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add DANGER admonition about freeing nodes in tool scripts

Browse Source 
Closes godotengine/godot#35422 and many similar misunderstandings.
This commit is contained in:
Rémi Verschelde
2020-01-22 09:51:01 +01:00
parent 4a3472449f
commit 2e68d271fe
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
tutorials/misc/running_code_in_the_editor.rst
View File

@@ -14,6 +14,16 @@ You can use it for doing many things, but it is mostly useful in level design fo
- If you have jumppads with varying jump heights, you can draw the maximum jump height a player would reach if it jumped on one, also making level design easier. - If you have jumppads with varying jump heights, you can draw the maximum jump height a player would reach if it jumped on one, also making level design easier.
- If your player doesn't use a sprite, but draws itself using code, you can make that drawing code execute in the editor to see your player. - If your player doesn't use a sprite, but draws itself using code, you can make that drawing code execute in the editor to see your player.
.. DANGER::
``tool`` scripts run inside the editor, and let you access the scene tree
of the currently edited scene. This is a powerful feature which also comes
with caveats, as the editor does not include protections for potential
misuse of ``tool`` scripts.
Be **extremely** cautious when manipulating the scene tree, especially via
:ref:`Node.queue_free<class_Node_method_queue_free>`, as it can cause
crashes if you free a node while the editor runs logic involving it.
How to use it How to use it
------------- -------------