class_gdextension.rst 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/GDExtension.xml.
  6. .. _class_GDExtension:
  7. GDExtension
  8. ===========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-reftable-group
  13. Methods
  14. -------
  15. .. table::
  16. :widths: auto
  17. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`close_library<class_GDExtension_method_close_library>` **(** **)** |
  19. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` | :ref:`get_minimum_library_initialization_level<class_GDExtension_method_get_minimum_library_initialization_level>` **(** **)** |const| |
  21. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`initialize_library<class_GDExtension_method_initialize_library>` **(** :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` level **)** |
  23. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`is_library_open<class_GDExtension_method_is_library_open>` **(** **)** |const| |
  25. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`open_library<class_GDExtension_method_open_library>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` entry_symbol **)** |
  27. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. .. rst-class:: classref-section-separator
  29. ----
  30. .. rst-class:: classref-descriptions-group
  31. Enumerations
  32. ------------
  33. .. _enum_GDExtension_InitializationLevel:
  34. .. rst-class:: classref-enumeration
  35. enum **InitializationLevel**:
  36. .. _class_GDExtension_constant_INITIALIZATION_LEVEL_CORE:
  37. .. rst-class:: classref-enumeration-constant
  38. :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` **INITIALIZATION_LEVEL_CORE** = ``0``
  39. .. _class_GDExtension_constant_INITIALIZATION_LEVEL_SERVERS:
  40. .. rst-class:: classref-enumeration-constant
  41. :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` **INITIALIZATION_LEVEL_SERVERS** = ``1``
  42. .. _class_GDExtension_constant_INITIALIZATION_LEVEL_SCENE:
  43. .. rst-class:: classref-enumeration-constant
  44. :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` **INITIALIZATION_LEVEL_SCENE** = ``2``
  45. .. _class_GDExtension_constant_INITIALIZATION_LEVEL_EDITOR:
  46. .. rst-class:: classref-enumeration-constant
  47. :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` **INITIALIZATION_LEVEL_EDITOR** = ``3``
  48. .. rst-class:: classref-section-separator
  49. ----
  50. .. rst-class:: classref-descriptions-group
  51. Method Descriptions
  52. -------------------
  53. .. _class_GDExtension_method_close_library:
  54. .. rst-class:: classref-method
  55. void **close_library** **(** **)**
  56. .. container:: contribute
  57. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  58. .. rst-class:: classref-item-separator
  59. ----
  60. .. _class_GDExtension_method_get_minimum_library_initialization_level:
  61. .. rst-class:: classref-method
  62. :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` **get_minimum_library_initialization_level** **(** **)** |const|
  63. .. container:: contribute
  64. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  65. .. rst-class:: classref-item-separator
  66. ----
  67. .. _class_GDExtension_method_initialize_library:
  68. .. rst-class:: classref-method
  69. void **initialize_library** **(** :ref:`InitializationLevel<enum_GDExtension_InitializationLevel>` level **)**
  70. .. container:: contribute
  71. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  72. .. rst-class:: classref-item-separator
  73. ----
  74. .. _class_GDExtension_method_is_library_open:
  75. .. rst-class:: classref-method
  76. :ref:`bool<class_bool>` **is_library_open** **(** **)** |const|
  77. .. container:: contribute
  78. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  79. .. rst-class:: classref-item-separator
  80. ----
  81. .. _class_GDExtension_method_open_library:
  82. .. rst-class:: classref-method
  83. :ref:`Error<enum_@GlobalScope_Error>` **open_library** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` entry_symbol **)**
  84. .. container:: contribute
  85. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  86. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  87. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  88. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  89. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  90. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  91. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  92. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`