From e38666b76aa643f55d8edcb16c9d4e91a6b74c78 Mon Sep 17 00:00:00 2001 From: Jan Heemstra Date: Wed, 27 Apr 2016 17:27:01 +0200 Subject: [PATCH] fixed some mistakes in WeakRef documentation (cherry picked from commit e301ca35447ef568d2773ab0bf90b0d0fdf9748e) --- doc/base/classes.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index dab806d3412..b47ac9d3873 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -41949,17 +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. + Holds an [Object], but does not contribute to the reference count if the object is a 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. + A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. 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. + Returns the [Object] this weakref is referring to.