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

fixed some mistakes in WeakRef documentation

This commit is contained in:
Jan Heemstra 2016-04-27 17:27:01 +02:00
parent edff81c214
commit e301ca3544
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/base/classes.xml
View File

@ -43298,17 +43298,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.
Holds an [Object], but does not contribute to the reference count if the object is a 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.
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.
</description>
<methods>
<method name="get_ref" qualifiers="const">
<return type="Reference">
<return type="Object">
</return>
<description>
Returns the reference this weakref is referring to.
Returns the [Object] this weakref is referring to.
</description>
</method>
</methods>