Doc: Clarify when LimboState::_exit is called

limbonaut · Nov 5, 2024 · ae61d55 · ae61d55
1 parent a14cc4c
commit ae61d55
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/source/classes/class_limbostate.rst b/doc/source/classes/class_limbostate.rst
@@ -234,7 +234,7 @@ Called when the state is entered.
 
 |void| **_exit**\ (\ ) |virtual| :ref:`🔗<class_LimboState_private_method__exit>`
 
-Called when the state is exited.
+Called when the state is exited. This happens on a transition to another state, and when the state machine is removed from the scene tree (e.g., when the node is freed with :ref:`Node.queue_free<class_Node_method_queue_free>` or the scene changes). Due to implementation details, :ref:`_exit<class_LimboState_private_method__exit>` will not be called on :ref:`Object.free<class_Object_method_free>`!
 
 .. rst-class:: classref-item-separator
 

diff --git a/doc_classes/LimboState.xml b/doc_classes/LimboState.xml
@@ -20,7 +20,7 @@
 		<method name="_exit" qualifiers="virtual">
 			<return type="void" />
 			<description>
-				Called when the state is exited.
+				Called when the state is exited. This happens on a transition to another state, and when the state machine is removed from the scene tree (e.g., when the node is freed with [method Node.queue_free] or the scene changes). Due to implementation details, [method _exit] will not be called on [method Object.free]!
 			</description>
 		</method>
 		<method name="_setup" qualifiers="virtual">