Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

WeakRef

Inherits: RefCounted < Object

Holds an Object, but does not contribute to the reference count if the object is a reference.

Description

A weakref can hold a RefCounted, without contributing to the reference counter. A weakref can be created from an Object using @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.

Methods

Variant

get_ref ( ) const

---

Method Descriptions

Variant get_ref ( ) const

Returns the Object this weakref is referring to. Returns null if that object no longer exists.