diff options
| author | Jan Heemstra <heemstrajan@gmail.com> | 2016-04-27 16:10:10 +0200 |
|---|---|---|
| committer | Jan Heemstra <heemstrajan@gmail.com> | 2016-04-27 16:10:10 +0200 |
| commit | edff81c2142f75d811263dafed42fd817e407be0 (patch) | |
| tree | ca353284fc4bd12481e291c89d0c0bf8cb6735c4 /doc | |
| parent | f2a73816c2202f0f155086e451a73f76fba67c42 (diff) | |
Documented WeakRef and member functions
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 03fdfa5f6b..5d8cc40a2b 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -43298,14 +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. </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> |