f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
28 lines
938 B
XML
28 lines
938 B
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="RID" version="3.4">
|
|
<brief_description>
|
|
Handle for a [Resource]'s unique ID.
|
|
</brief_description>
|
|
<description>
|
|
The RID type is used to access the unique integer ID of a resource. They are opaque, which means they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [VisualServer].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="RID">
|
|
<return type="RID" />
|
|
<argument index="0" name="from" type="Object" />
|
|
<description>
|
|
Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
|
|
</description>
|
|
</method>
|
|
<method name="get_id">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the ID of the referenced resource.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|