asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #93190 from AThousandShips/session_doc

Browse source 
[Doc] Clarify the session-specific nature of `RID` and `ObjectID`
This commit is contained in:
Rémi Verschelde 2024-06-19 10:10:17 +02:00
commit 4541f64026
No known key found for this signature in database
GPG key ID: C3336907360768E1
2 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/Object.xml
View file

@ -693,6 +693,7 @@
<return type="int" />
<description>
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.
</description>
</method>
<method name="get_meta" qualifiers="const">

1
doc/classes/RID.xml
View file

@ -6,6 +6,7 @@
<description>
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.
</description>
<tutorials>
</tutorials>