From 9706b78a3fd5cb71b4cda01f3953992cd05577bc Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 23 Nov 2020 14:01:50 +0100 Subject: [PATCH] Document C# garbage collection caveats in Reference and Resource (cherry picked from commit 0565c76e8ba7e31f6e0d16a7c3a7c0463b861f09) --- doc/classes/Reference.xml | 1 + doc/classes/Resource.xml | 1 + 2 files changed, 2 insertions(+) diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index db9f17a5da5..57eda437c40 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/Reference.xml @@ -7,6 +7,7 @@ Base class for any object that keeps a reference count. [Resource] and many other helper objects inherit this class. Unlike [Object]s, References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with [method Object.free]. In the vast majority of use cases, instantiating and using [Reference]-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused. + [b]Note:[/b] In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed. https://docs.godotengine.org/en/3.2/getting_started/workflow/best_practices/node_alternatives.html diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 4efeebf609f..0cf704ca549 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -5,6 +5,7 @@ Resource is the base class for all Godot-specific resource types, serving primarily as data containers. Unlike [Object]s, they are reference-counted and freed when no longer in use. They are also cached once loaded from disk, so that any further attempts to load a resource from a given path will return the same reference (all this in contrast to a [Node], which is not reference-counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + [b]Note:[/b] In C#, resources will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free resources that are no longer in use. This means that unused resources will linger on for a while before being removed. https://docs.godotengine.org/en/3.2/getting_started/step_by_step/resources.html