godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documented WeakRef and member functions 

(cherry picked from commit edff81c214)
This commit is contained in:
Jan Heemstra 2016-04-27 16:10:10 +02:00 committed by Rémi Verschelde
parent d183a5361f
commit 6f76eca883
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/base/classes.xml
View File

@ -41949,14 +41949,17 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="WeakRef" inherits="Reference" category="Core">
<brief_description>
Holds a [Reference] object, but does not contribute to the reference count of that reference.
</brief_description>
<description>
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.
</description>
<methods>
<method name="get_ref" qualifiers="const">
<return type="Object">
<return type="Reference">
</return>
<description>
Returns the reference this weakref is referring to.
</description>
</method>
</methods>