summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBoris The Brave <boris@boristhebrave.com>2023-09-26 22:25:45 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-11-01 10:43:41 +0100
commita390996a61a645cc3d2f9a99ac4f7f786c416ce3 (patch)
tree01ede20c7094e10dd1288866bbd1f7e855bb5496
parent6afd320984cf14198368cc6c53752813a02169e3 (diff)
downloadredot-engine-a390996a61a645cc3d2f9a99ac4f7f786c416ce3.tar.gz
Document that `resource_name` is not always supported
Closes #82333. Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
-rw-r--r--doc/classes/Resource.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml
index 75c258253d..c8146bb48f 100644
--- a/doc/classes/Resource.xml
+++ b/doc/classes/Resource.xml
@@ -92,6 +92,7 @@
</member>
<member name="resource_name" type="String" setter="set_name" getter="get_name" default="&quot;&quot;">
An optional name for this resource. When defined, its value is displayed to represent the resource in the Inspector dock. For built-in scripts, the name is displayed as part of the tab name in the script editor.
+ [b]Note:[/b] Some resource formats do not support resource names. You can still set the name in the editor or via code, but it will be lost when the resource is reloaded. For example, only built-in scripts can have a resource name, while scripts stored in separate files cannot.
</member>
<member name="resource_path" type="String" setter="set_path" getter="get_path" default="&quot;&quot;">
The unique path to this resource. If it has been saved to disk, the value will be its filepath. If the resource is exclusively contained within a scene, the value will be the [PackedScene]'s filepath, followed by a unique identifier.