Browse Source

Change comment for `s.queue_free()`

In the previous section, we document `free` as being immediate, and here
we contrast that with `queue_free`. However, each function has the same
comment implying that both `free` and `queue_free` are immediate.

I believe the point of this documentation is to point out that
`queue_free` is _not_ necessarily immediate and will wait until it is
safe to free the node.
Jon Wolski 7 years ago
parent
commit
a7a28fc06e
1 changed files with 2 additions and 2 deletions
  1. 2 2
      getting_started/step_by_step/scripting_continued.rst

+ 2 - 2
getting_started/step_by_step/scripting_continued.rst

@@ -327,13 +327,13 @@ This erases the node safely during idle.
  .. code-tab:: gdscript GDScript
  .. code-tab:: gdscript GDScript
 
 
     func _someaction():
     func _someaction():
-        s.queue_free() # Immediately removes the node from the scene and frees it.
+        s.queue_free() # Removes the node from the scene and frees it when it becomse safe to do so.
 
 
  .. code-tab:: csharp
  .. code-tab:: csharp
 
 
     public void _SomeAction()
     public void _SomeAction()
     {
     {
-        _sprite.QueueFree(); // Immediately removes the node from the scene and frees it.
+        _sprite.QueueFree(); // Removes the node from the scene and frees it when it becomse safe to do so.
     }
     }
 
 
 Instancing scenes
 Instancing scenes