class_classdb.rst 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ClassDB:
  4. ClassDB
  5. =======
  6. **Inherits:** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_can_instance>` **(** :ref:`String<class_string>` class **)** const |
  14. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_class_exists>` **(** :ref:`String<class_string>` class **)** const |
  16. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`String<class_string>` | :ref:`class_get_category<class_ClassDB_class_get_category>` **(** :ref:`String<class_string>` class **)** const |
  18. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_class_get_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
  20. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`class_get_integer_constant_list<class_ClassDB_class_get_integer_constant_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
  22. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_array>` | :ref:`class_get_method_list<class_ClassDB_class_get_method_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
  24. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Variant<class_variant>` | :ref:`class_get_property<class_ClassDB_class_get_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const |
  26. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Array<class_array>` | :ref:`class_get_property_list<class_ClassDB_class_get_property_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
  28. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Dictionary<class_dictionary>` | :ref:`class_get_signal<class_ClassDB_class_get_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
  30. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Array<class_array>` | :ref:`class_get_signal_list<class_ClassDB_class_get_signal_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
  32. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_class_has_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
  34. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_class_has_method>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
  36. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
  38. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
  40. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
  42. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_string>` class **)** const |
  44. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_string>` | :ref:`get_parent_class<class_ClassDB_get_parent_class>` **(** :ref:`String<class_string>` class **)** const |
  46. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`Variant<class_variant>` | :ref:`instance<class_ClassDB_instance>` **(** :ref:`String<class_string>` class **)** const |
  48. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_is_class_enabled>` **(** :ref:`String<class_string>` class **)** const |
  50. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const |
  52. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. Member Function Description
  54. ---------------------------
  55. .. _class_ClassDB_can_instance:
  56. - :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_string>` class **)** const
  57. .. _class_ClassDB_class_exists:
  58. - :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_string>` class **)** const
  59. .. _class_ClassDB_class_get_category:
  60. - :ref:`String<class_string>` **class_get_category** **(** :ref:`String<class_string>` class **)** const
  61. .. _class_ClassDB_class_get_integer_constant:
  62. - :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
  63. .. _class_ClassDB_class_get_integer_constant_list:
  64. - :ref:`PoolStringArray<class_poolstringarray>` **class_get_integer_constant_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
  65. .. _class_ClassDB_class_get_method_list:
  66. - :ref:`Array<class_array>` **class_get_method_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
  67. .. _class_ClassDB_class_get_property:
  68. - :ref:`Variant<class_variant>` **class_get_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const
  69. .. _class_ClassDB_class_get_property_list:
  70. - :ref:`Array<class_array>` **class_get_property_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
  71. .. _class_ClassDB_class_get_signal:
  72. - :ref:`Dictionary<class_dictionary>` **class_get_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
  73. .. _class_ClassDB_class_get_signal_list:
  74. - :ref:`Array<class_array>` **class_get_signal_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
  75. .. _class_ClassDB_class_has_integer_constant:
  76. - :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
  77. .. _class_ClassDB_class_has_method:
  78. - :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
  79. .. _class_ClassDB_class_has_signal:
  80. - :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
  81. .. _class_ClassDB_class_set_property:
  82. - :ref:`int<class_int>` **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
  83. .. _class_ClassDB_get_class_list:
  84. - :ref:`PoolStringArray<class_poolstringarray>` **get_class_list** **(** **)** const
  85. .. _class_ClassDB_get_inheriters_from_class:
  86. - :ref:`PoolStringArray<class_poolstringarray>` **get_inheriters_from_class** **(** :ref:`String<class_string>` class **)** const
  87. .. _class_ClassDB_get_parent_class:
  88. - :ref:`String<class_string>` **get_parent_class** **(** :ref:`String<class_string>` class **)** const
  89. .. _class_ClassDB_instance:
  90. - :ref:`Variant<class_variant>` **instance** **(** :ref:`String<class_string>` class **)** const
  91. .. _class_ClassDB_is_class_enabled:
  92. - :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_string>` class **)** const
  93. .. _class_ClassDB_is_parent_class:
  94. - :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const