Ver código fonte

Merge pull request #4597 from skyace65/weakref

Add code example for weakref
Rémi Verschelde 4 anos atrás
pai
commit
ca41df2fd0
1 arquivos alterados com 16 adições e 2 exclusões
  1. 16 2
      tutorials/scripting/gdscript/gdscript_basics.rst

+ 16 - 2
tutorials/scripting/gdscript/gdscript_basics.rst

@@ -1508,8 +1508,22 @@ freed when no longer in use. No garbage collector exists, just
 reference counting. By default, all classes that don't define
 inheritance extend **Reference**. If this is not desired, then a class
 must inherit :ref:`class_Object` manually and must call ``instance.free()``. To
-avoid reference cycles that can't be freed, a ``weakref`` function is
-provided for creating weak references.
+avoid reference cycles that can't be freed, a :ref:`class_WeakRef` function is
+provided for creating weak references. Here is an example:
+
+::
+
+    extends Node
+
+    var my_node_ref
+
+    func _ready():
+        my_node_ref = weakref(get_node("MyNode"))
+
+    func _this_is_called_later():
+        var my_node = my_node_ref.get_ref()
+        if my_node:
+            my_node.do_something()
 
 Alternatively, when not using references, the
 ``is_instance_valid(instance)`` can be used to check if an object has been