From ae61d551c01cc334182d26b6d0d568c1aceec890 Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Tue, 5 Nov 2024 19:41:16 +0100 Subject: [PATCH] Doc: Clarify when `LimboState::_exit` is called --- doc/source/classes/class_limbostate.rst | 2 +- doc_classes/LimboState.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/classes/class_limbostate.rst b/doc/source/classes/class_limbostate.rst index d2f621f..8629a0e 100644 --- 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:`🔗` -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` or the scene changes). Due to implementation details, :ref:`_exit` will not be called on :ref:`Object.free`! .. rst-class:: classref-item-separator diff --git a/doc_classes/LimboState.xml b/doc_classes/LimboState.xml index 34550c6..29d7b9c 100644 --- a/doc_classes/LimboState.xml +++ b/doc_classes/LimboState.xml @@ -20,7 +20,7 @@ - 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]!