godot-docs/classes/class_reference.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Reference.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Reference:

Reference
=========

**Inherits:** :ref:`Object<class_object>`

**Inherited By:** :ref:`RegExMatch<class_regexmatch>`, :ref:`RegEx<class_regex>`, :ref:`EncodedObjectAsID<class_encodedobjectasid>`, :ref:`SpatialGizmo<class_spatialgizmo>`, :ref:`TriangleMesh<class_trianglemesh>`, :ref:`EditorScenePostImport<class_editorscenepostimport>`, :ref:`PhysicsShapeQueryResult<class_physicsshapequeryresult>`, :ref:`EditorSceneImporter<class_editorsceneimporter>`, :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:`GDScriptNativeClass<class_gdscriptnativeclass>`, :ref:`HTTPClient<class_httpclient>`, :ref:`AudioStreamPlayback<class_audiostreamplayback>`, :ref:`VisualScriptFunctionState<class_visualscriptfunctionstate>`, :ref:`Resource<class_resource>`, :ref:`KinematicCollision<class_kinematiccollision>`, :ref:`SurfaceTool<class_surfacetool>`, :ref:`JSONParseResult<class_jsonparseresult>`, :ref:`SpatialVelocityTracker<class_spatialvelocitytracker>`, :ref:`EditorResourcePreviewGenerator<class_editorresourcepreviewgenerator>`, :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>`, :ref:`EditorExportPlugin<class_editorexportplugin>`, :ref:`ARVRInterface<class_arvrinterface>`, :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:`WeakRef<class_weakref>`, :ref:`GDScriptFunctionState<class_gdscriptfunctionstate>`, :ref:`Marshalls<class_marshalls>`, :ref:`SceneState<class_scenestate>`, :ref:`PCKPacker<class_pckpacker>`, :ref:`MeshDataTool<class_meshdatatool>`, :ref:`AStar<class_astar>`, :ref:`ResourceImporter<class_resourceimporter>`, :ref:`EditorResourceConversionPlugin<class_editorresourceconversionplugin>`, :ref:`SceneTreeTimer<class_scenetreetimer>`, :ref:`Thread<class_thread>`, :ref:`ResourceInteractiveLoader<class_resourceinteractiveloader>`, :ref:`PackedDataContainerRef<class_packeddatacontainerref>`, :ref:`KinematicCollision2D<class_kinematiccollision2d>`, :ref:`GDNative<class_gdnative>`, :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>` **(** **)**       |
+--------------------------+-------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :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:

- :ref:`bool<class_bool>` **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.