| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
- .. _class_Reference:
- Reference
- =========
- **Inherits:** :ref:`Object<class_object>`
- **Inherited By:** :ref:`RegEx<class_regex>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>`, :ref:`FuncRef<class_funcref>`, :ref:`File<class_file>`, :ref:`TCP_Server<class_tcp_server>`, :ref:`Physics2DShapeQueryResult<class_physics2dshapequeryresult>`, :ref:`ConfigFile<class_configfile>`, :ref:`StreamPeer<class_streampeer>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`GDFunctionState<class_gdfunctionstate>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`EditorScript<class_editorscript>`, :ref:`Mutex<class_mutex>`, :ref:`PacketPeer<class_packetpeer>`, :ref:`Semaphore<class_semaphore>`, :ref:`XMLParser<class_xmlparser>`, :ref:`EditorImportPlugin<class_editorimportplugin>`, :ref:`Directory<class_directory>`, :ref:`Marshalls<class_marshalls>`, :ref:`AStar<class_astar>`, :ref:`SceneState<class_scenestate>`, :ref:`GDNativeClass<class_gdnativeclass>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`WeakRef<class_weakref>`, :ref:`Resource<class_resource>`, :ref:`Thread<class_thread>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`ResourceImportMetadata<class_resourceimportmetadata>`, :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>`
- **Category:** Core
- Brief Description
- -----------------
- Base class for anything that keeps a reference count.
- Member Functions
- ----------------
- +--------------------------+--------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`init_ref<class_Reference_init_ref>` **(** **)** |
- +--------------------------+--------------------------------------------------------------+
- | void | :ref:`reference<class_Reference_reference>` **(** **)** |
- +--------------------------+--------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`unreference<class_Reference_unreference>` **(** **)** |
- +--------------------------+--------------------------------------------------------------+
- Description
- -----------
- Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use.
- Member Function Description
- ---------------------------
- .. _class_Reference_init_ref:
- - :ref:`bool<class_bool>` **init_ref** **(** **)**
- .. _class_Reference_reference:
- - void **reference** **(** **)**
- Increase the internal reference counter. Use this only if you really know what you are doing.
- .. _class_Reference_unreference:
- - :ref:`bool<class_bool>` **unreference** **(** **)**
- Decrease the internal reference counter. Use this only if you really know what you are doing.
|
