Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_reference.rst

class_reference.rst 6.4 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Reference.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Reference:
    8. 

  8. 

  9. Reference
    10. 

  10. =========
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`AESContext<class_AESContext>`, :ref:`ARVRInterface<class_ARVRInterface>`, :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`, :ref:`AStar<class_AStar>`, :ref:`AStar2D<class_AStar2D>`, :ref:`AnimationTrackEditPlugin<class_AnimationTrackEditPlugin>`, :ref:`AudioEffectInstance<class_AudioEffectInstance>`, :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, :ref:`CameraFeed<class_CameraFeed>`, :ref:`CharFXTransform<class_CharFXTransform>`, :ref:`ConfigFile<class_ConfigFile>`, :ref:`Crypto<class_Crypto>`, :ref:`DTLSServer<class_DTLSServer>`, :ref:`Directory<class_Directory>`, :ref:`EditorExportPlugin<class_EditorExportPlugin>`, :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`, :ref:`EditorResourceConversionPlugin<class_EditorResourceConversionPlugin>`, :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>`, :ref:`EditorSceneImporter<class_EditorSceneImporter>`, :ref:`EditorScenePostImport<class_EditorScenePostImport>`, :ref:`EditorScript<class_EditorScript>`, :ref:`EncodedObjectAsID<class_EncodedObjectAsID>`, :ref:`Expression<class_Expression>`, :ref:`File<class_File>`, :ref:`FuncRef<class_FuncRef>`, :ref:`GDNative<class_GDNative>`, :ref:`GDScriptFunctionState<class_GDScriptFunctionState>`, :ref:`HMACContext<class_HMACContext>`, :ref:`HTTPClient<class_HTTPClient>`, :ref:`HashingContext<class_HashingContext>`, :ref:`JSONParseResult<class_JSONParseResult>`, :ref:`JavaClass<class_JavaClass>`, :ref:`JavaScriptObject<class_JavaScriptObject>`, :ref:`KinematicCollision<class_KinematicCollision>`, :ref:`KinematicCollision2D<class_KinematicCollision2D>`, :ref:`MeshDataTool<class_MeshDataTool>`, :ref:`MultiplayerAPI<class_MultiplayerAPI>`, :ref:`Mutex<class_Mutex>`, :ref:`PCKPacker<class_PCKPacker>`, :ref:`PackedDataContainerRef<class_PackedDataContainerRef>`, :ref:`PacketPeer<class_PacketPeer>`, :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>`, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>`, :ref:`PhysicsTestMotionResult<class_PhysicsTestMotionResult>`, :ref:`RandomNumberGenerator<class_RandomNumberGenerator>`, :ref:`RegEx<class_RegEx>`, :ref:`RegExMatch<class_RegExMatch>`, :ref:`Resource<class_Resource>`, :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`, :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`, :ref:`ResourceImporter<class_ResourceImporter>`, :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>`, :ref:`SceneState<class_SceneState>`, :ref:`SceneTreeTimer<class_SceneTreeTimer>`, :ref:`Semaphore<class_Semaphore>`, :ref:`SkinReference<class_SkinReference>`, :ref:`SpatialGizmo<class_SpatialGizmo>`, :ref:`SpatialVelocityTracker<class_SpatialVelocityTracker>`, :ref:`StreamPeer<class_StreamPeer>`, :ref:`SurfaceTool<class_SurfaceTool>`, :ref:`TCP_Server<class_TCP_Server>`, :ref:`Thread<class_Thread>`, :ref:`TriangleMesh<class_TriangleMesh>`, :ref:`UDPServer<class_UDPServer>`, :ref:`UPNP<class_UPNP>`, :ref:`UPNPDevice<class_UPNPDevice>`, :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, :ref:`WeakRef<class_WeakRef>`, :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, :ref:`XMLParser<class_XMLParser>`
    15. 

  15. 

  16. Base class for reference-counted objects.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. Base class for any object that keeps a reference count. :ref:`Resource<class_Resource>` and many other helper objects inherit this class.
    22. 

  22. 

  23. Unlike other :ref:`Object<class_Object>` types, References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with :ref:`Object.free<class_Object_method_free>`.
    24. 

  24. 

  25. In the vast majority of use cases, instantiating and using ``Reference``-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused.
    26. 

  26. 

  27. **Note:** In C#, references will not be freed instantly after they are no longer in use. Instead, garbage collection will run periodically and will free references that are no longer in use. This means that unused references will linger on for a while before being removed.
    28. 

  28. 

  29. Tutorials
    30. 

  30. ---------
    31. 

  31. 

  32. - :doc:`../tutorials/best_practices/node_alternatives`
    33. 

  33. 

  34. Methods
    35. 

  35. -------
    36. 

  36. 

  37. +-------------------------+--------------------------------------------------------------------+
    38. 

  38. | :ref:`bool<class_bool>` | :ref:`init_ref<class_Reference_method_init_ref>` **(** **)**       |
    39. 

  39. +-------------------------+--------------------------------------------------------------------+
    40. 

  40. | :ref:`bool<class_bool>` | :ref:`reference<class_Reference_method_reference>` **(** **)**     |
    41. 

  41. +-------------------------+--------------------------------------------------------------------+
    42. 

  42. | :ref:`bool<class_bool>` | :ref:`unreference<class_Reference_method_unreference>` **(** **)** |
    43. 

  43. +-------------------------+--------------------------------------------------------------------+
    44. 

  44. 

  45. Method Descriptions
    46. 

  46. -------------------
    47. 

  47. 

  48. .. _class_Reference_method_init_ref:
    49. 

  49. 

  50. - :ref:`bool<class_bool>` **init_ref** **(** **)**
    51. 

  51. 

  52. Initializes the internal reference counter. Use this only if you really know what you are doing.
    53. 

  53. 

  54. Returns whether the initialization was successful.
    55. 

  55. 

  56. ----
    57. 

  57. 

  58. .. _class_Reference_method_reference:
    59. 

  59. 

  60. - :ref:`bool<class_bool>` **reference** **(** **)**
    61. 

  61. 

  62. Increments the internal reference counter. Use this only if you really know what you are doing.
    63. 

  63. 

  64. Returns ``true`` if the increment was successful, ``false`` otherwise.
    65. 

  65. 

  66. ----
    67. 

  67. 

  68. .. _class_Reference_method_unreference:
    69. 

  69. 

  70. - :ref:`bool<class_bool>` **unreference** **(** **)**
    71. 

  71. 

  72. Decrements the internal reference counter. Use this only if you really know what you are doing.
    73. 

  73. 

  74. Returns ``true`` if the decrement was successful, ``false`` otherwise.
    75. 

  75. 

  76. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    77. 

  77. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    78. 

  78. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    79. 

  79.