From 6f76eca8831dc48a145c712f45670aa76edfdac6 Mon Sep 17 00:00:00 2001 From: Jan Heemstra Date: Wed, 27 Apr 2016 16:10:10 +0200 Subject: [PATCH] Documented WeakRef and member functions (cherry picked from commit edff81c2142f75d811263dafed42fd817e407be0) --- doc/base/classes.xml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7b372c17271..dab806d3412 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -41949,14 +41949,17 @@ This method controls whether the position between two cached points is interpola + Holds a [Reference] object, but does not contribute to the reference count of that reference. + A weakref holds a [Reference], without contributing to it's reference counter. A weakref can be created from a reference using [method @GDScript.weakref]. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. - + + Returns the reference this weakref is referring to.