diff options
| author | Remi Rampin <r@remirampin.com> | 2020-05-16 12:32:41 -0400 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-05-18 09:11:22 +0200 |
| commit | 55bad664479663a691a684256cc2a98670712c7b (patch) | |
| tree | d34ceffbf7cc15ebf331641e0b838f8c728dddf6 | |
| parent | d4599fff68c96e8a4f25927d1786491098a18d4e (diff) | |
| download | redot-engine-55bad664479663a691a684256cc2a98670712c7b.tar.gz | |
Update description of Object.free() method
Clarify that variables pointing to an object don't become `null` when that object is freed, it just makes them invalid.
(cherry picked from commit ccf5703568ab7c33723f322088c83a7d9ebcf5a8)
| -rw-r--r-- | doc/classes/Object.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 35e87d1a2a..87bcab25db 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -192,7 +192,7 @@ <return type="void"> </return> <description> - Deletes the object from memory. Any pre-existing reference to the freed object will now return [code]null[/code]. + Deletes the object from memory. Any pre-existing reference to the freed object will become invalid, e.g. [code]is_instance_valid(object)[/code] will return [code]false[/code]. </description> </method> <method name="get" qualifiers="const"> |