mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
48 lines
1.9 KiB
ReStructuredText
48 lines
1.9 KiB
ReStructuredText
|
:github_url: hide
|
||
|
|
|
||
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||
|
|
.. DO NOT EDIT THIS FILE, but the RID.xml source instead.
|
||
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
|
|
||
|
|
.. _class_RID:
|
||
|
|
|
||
|
|
RID
|
||
|
|
===
|
||
|
|
|
||
|
|
Handle for a :ref:`Resource<class_Resource>`'s unique ID.
|
||
|
|
|
||
|
|
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 :ref:`VisualServer<class_VisualServer>`.
|
||
|
|
|
||
|
|
Methods
|
||
|
|
-------
|
||
|
|
|
||
|
|
+-----------------------+-------------------------------------------------------------------------------+
|
||
|
|
| :ref:`RID<class_RID>` | :ref:`RID<class_RID_method_RID>` **(** :ref:`Object<class_Object>` from **)** |
|
||
|
|
+-----------------------+-------------------------------------------------------------------------------+
|
||
|
|
| :ref:`int<class_int>` | :ref:`get_id<class_RID_method_get_id>` **(** **)** |
|
||
|
|
+-----------------------+-------------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_RID_method_RID:
|
||
|
|
|
||
|
|
- :ref:`RID<class_RID>` **RID** **(** :ref:`Object<class_Object>` from **)**
|
||
|
|
|
||
|
|
Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0.
|
||
|
|
|
||
|
|
----
|
||
|
|
|
||
|
|
.. _class_RID_method_get_id:
|
||
|
|
|
||
|
|
- :ref:`int<class_int>` **get_id** **(** **)**
|
||
|
|
|
||
|
|
Returns the ID of the referenced resource.
|
||
|
|
|
||
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|