godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Overhaul the top sections of the class reference (Core classes)

Browse Source
This commit is contained in:
VolTer
2023-04-28 01:35:33 +02:00
parent 5bb7d585a5
commit 04562662d3
82 changed files with 208 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/WeakRef.xml
View File

@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WeakRef" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Holds an [Object], but does not contribute to the reference count if the object is a reference.
Holds an [Object]. If the object is [RefCounted], it doesn't update the reference count.
</brief_description>
<description>
A weakref can hold a [RefCounted], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.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 each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other 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 [RefCounted] without contributing to the reference counter. A weakref can be created from an [Object] using [method @GlobalScope.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 each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released.
</description>
<tutorials>
</tutorials>