ClassDB.xml 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="ClassDB" inherits="Object" version="3.3">
  3. <brief_description>
  4. Class information repository.
  5. </brief_description>
  6. <description>
  7. Provides access to metadata stored for every available class.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="can_instance" qualifiers="const">
  13. <return type="bool" />
  14. <argument index="0" name="class" type="String" />
  15. <description>
  16. Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
  17. </description>
  18. </method>
  19. <method name="class_exists" qualifiers="const">
  20. <return type="bool" />
  21. <argument index="0" name="class" type="String" />
  22. <description>
  23. Returns whether the specified [code]class[/code] is available or not.
  24. </description>
  25. </method>
  26. <method name="class_get_category" qualifiers="const">
  27. <return type="String" />
  28. <argument index="0" name="class" type="String" />
  29. <description>
  30. Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
  31. </description>
  32. </method>
  33. <method name="class_get_integer_constant" qualifiers="const">
  34. <return type="int" />
  35. <argument index="0" name="class" type="String" />
  36. <argument index="1" name="name" type="String" />
  37. <description>
  38. Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found.
  39. </description>
  40. </method>
  41. <method name="class_get_integer_constant_list" qualifiers="const">
  42. <return type="PoolStringArray" />
  43. <argument index="0" name="class" type="String" />
  44. <argument index="1" name="no_inheritance" type="bool" default="false" />
  45. <description>
  46. Returns an array with the names all the integer constants of [code]class[/code] or its ancestry.
  47. </description>
  48. </method>
  49. <method name="class_get_method_list" qualifiers="const">
  50. <return type="Array" />
  51. <argument index="0" name="class" type="String" />
  52. <argument index="1" name="no_inheritance" type="bool" default="false" />
  53. <description>
  54. Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
  55. [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
  56. </description>
  57. </method>
  58. <method name="class_get_property" qualifiers="const">
  59. <return type="Variant" />
  60. <argument index="0" name="object" type="Object" />
  61. <argument index="1" name="property" type="String" />
  62. <description>
  63. Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
  64. </description>
  65. </method>
  66. <method name="class_get_property_list" qualifiers="const">
  67. <return type="Array" />
  68. <argument index="0" name="class" type="String" />
  69. <argument index="1" name="no_inheritance" type="bool" default="false" />
  70. <description>
  71. Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code].
  72. </description>
  73. </method>
  74. <method name="class_get_signal" qualifiers="const">
  75. <return type="Dictionary" />
  76. <argument index="0" name="class" type="String" />
  77. <argument index="1" name="signal" type="String" />
  78. <description>
  79. Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
  80. </description>
  81. </method>
  82. <method name="class_get_signal_list" qualifiers="const">
  83. <return type="Array" />
  84. <argument index="0" name="class" type="String" />
  85. <argument index="1" name="no_inheritance" type="bool" default="false" />
  86. <description>
  87. Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal].
  88. </description>
  89. </method>
  90. <method name="class_has_integer_constant" qualifiers="const">
  91. <return type="bool" />
  92. <argument index="0" name="class" type="String" />
  93. <argument index="1" name="name" type="String" />
  94. <description>
  95. Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
  96. </description>
  97. </method>
  98. <method name="class_has_method" qualifiers="const">
  99. <return type="bool" />
  100. <argument index="0" name="class" type="String" />
  101. <argument index="1" name="method" type="String" />
  102. <argument index="2" name="no_inheritance" type="bool" default="false" />
  103. <description>
  104. Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not.
  105. </description>
  106. </method>
  107. <method name="class_has_signal" qualifiers="const">
  108. <return type="bool" />
  109. <argument index="0" name="class" type="String" />
  110. <argument index="1" name="signal" type="String" />
  111. <description>
  112. Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
  113. </description>
  114. </method>
  115. <method name="class_set_property" qualifiers="const">
  116. <return type="int" enum="Error" />
  117. <argument index="0" name="object" type="Object" />
  118. <argument index="1" name="property" type="String" />
  119. <argument index="2" name="value" type="Variant" />
  120. <description>
  121. Sets [code]property[/code] value of [code]class[/code] to [code]value[/code].
  122. </description>
  123. </method>
  124. <method name="get_class_list" qualifiers="const">
  125. <return type="PoolStringArray" />
  126. <description>
  127. Returns the names of all the classes available.
  128. </description>
  129. </method>
  130. <method name="get_inheriters_from_class" qualifiers="const">
  131. <return type="PoolStringArray" />
  132. <argument index="0" name="class" type="String" />
  133. <description>
  134. Returns the names of all the classes that directly or indirectly inherit from [code]class[/code].
  135. </description>
  136. </method>
  137. <method name="get_parent_class" qualifiers="const">
  138. <return type="String" />
  139. <argument index="0" name="class" type="String" />
  140. <description>
  141. Returns the parent class of [code]class[/code].
  142. </description>
  143. </method>
  144. <method name="instance" qualifiers="const">
  145. <return type="Variant" />
  146. <argument index="0" name="class" type="String" />
  147. <description>
  148. Creates an instance of [code]class[/code].
  149. </description>
  150. </method>
  151. <method name="is_class_enabled" qualifiers="const">
  152. <return type="bool" />
  153. <argument index="0" name="class" type="String" />
  154. <description>
  155. Returns whether this [code]class[/code] is enabled or not.
  156. </description>
  157. </method>
  158. <method name="is_parent_class" qualifiers="const">
  159. <return type="bool" />
  160. <argument index="0" name="class" type="String" />
  161. <argument index="1" name="inherits" type="String" />
  162. <description>
  163. Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.
  164. </description>
  165. </method>
  166. </methods>
  167. <constants>
  168. </constants>
  169. </class>