From 6ab303cd7613e5fde9dd46278ed7e50c43f78302 Mon Sep 17 00:00:00 2001
From: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Date: Sat, 15 Jun 2024 13:15:15 +0200
Subject: [PATCH] [Doc] Clarify the session-specific nature of `RID` and
`ObjectID`
---
doc/classes/Object.xml | 1 +
doc/classes/RID.xml | 1 +
2 files changed, 2 insertions(+)
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml
index b0dec2d00a5..eecb3ca525f 100644
--- a/doc/classes/Object.xml
+++ b/doc/classes/Object.xml
@@ -693,6 +693,7 @@
Returns the object's unique instance ID. This ID can be saved in [EncodedObjectAsID], and can be used to retrieve this object instance with [method @GlobalScope.instance_from_id].
+ [b]Note:[/b] This ID is only useful during the current session. It won't correspond to a similar object if the ID is sent over a network, or loaded from a file at a later time.
diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml
index 8fd93d00b90..323ac3b0ec2 100644
--- a/doc/classes/RID.xml
+++ b/doc/classes/RID.xml
@@ -6,6 +6,7 @@
The RID [Variant] type is used to access a low-level resource by its unique ID. RIDs are opaque, which means they do not grant access to the resource by themselves. They are used by the low-level server classes, such as [DisplayServer], [RenderingServer], [TextServer], etc.
A low-level resource may correspond to a high-level [Resource], such as [Texture] or [Mesh].
+ [b]Note:[/b] RIDs are only useful during the current session. It won't correspond to a similar resource if sent over a network, or loaded from a file at a later time.