class_scriptextension.rst 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535
  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/ScriptExtension.xml.
  6. .. _class_ScriptExtension:
  7. ScriptExtension
  8. ===============
  9. **Inherits:** :ref:`Script<class_Script>` **<** :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. | :ref:`bool<class_bool>` | :ref:`_can_instantiate<class_ScriptExtension_method__can_instantiate>` **(** **)** |virtual| |const| |
  19. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`_editor_can_reload_from_file<class_ScriptExtension_method__editor_can_reload_from_file>` **(** **)** |virtual| |
  21. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Script<class_Script>` | :ref:`_get_base_script<class_ScriptExtension_method__get_base_script>` **(** **)** |virtual| |const| |
  23. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`Dictionary<class_Dictionary>` | :ref:`_get_constants<class_ScriptExtension_method__get_constants>` **(** **)** |virtual| |const| |
  25. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_documentation<class_ScriptExtension_method__get_documentation>` **(** **)** |virtual| |const| |
  27. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`StringName<class_StringName>` | :ref:`_get_instance_base_type<class_ScriptExtension_method__get_instance_base_type>` **(** **)** |virtual| |const| |
  29. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`ScriptLanguage<class_ScriptLanguage>` | :ref:`_get_language<class_ScriptExtension_method__get_language>` **(** **)** |virtual| |const| |
  31. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`_get_member_line<class_ScriptExtension_method__get_member_line>` **(** :ref:`StringName<class_StringName>` member **)** |virtual| |const| |
  33. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`StringName[]<class_StringName>` | :ref:`_get_members<class_ScriptExtension_method__get_members>` **(** **)** |virtual| |const| |
  35. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`Dictionary<class_Dictionary>` | :ref:`_get_method_info<class_ScriptExtension_method__get_method_info>` **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const| |
  37. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`Variant<class_Variant>` | :ref:`_get_property_default_value<class_ScriptExtension_method__get_property_default_value>` **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const| |
  39. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`Variant<class_Variant>` | :ref:`_get_rpc_config<class_ScriptExtension_method__get_rpc_config>` **(** **)** |virtual| |const| |
  41. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_script_method_list<class_ScriptExtension_method__get_script_method_list>` **(** **)** |virtual| |const| |
  43. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_script_property_list<class_ScriptExtension_method__get_script_property_list>` **(** **)** |virtual| |const| |
  45. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_script_signal_list<class_ScriptExtension_method__get_script_signal_list>` **(** **)** |virtual| |const| |
  47. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`String<class_String>` | :ref:`_get_source_code<class_ScriptExtension_method__get_source_code>` **(** **)** |virtual| |const| |
  49. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`bool<class_bool>` | :ref:`_has_method<class_ScriptExtension_method__has_method>` **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const| |
  51. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`bool<class_bool>` | :ref:`_has_property_default_value<class_ScriptExtension_method__has_property_default_value>` **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const| |
  53. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`_has_script_signal<class_ScriptExtension_method__has_script_signal>` **(** :ref:`StringName<class_StringName>` signal **)** |virtual| |const| |
  55. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`_has_source_code<class_ScriptExtension_method__has_source_code>` **(** **)** |virtual| |const| |
  57. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`_inherits_script<class_ScriptExtension_method__inherits_script>` **(** :ref:`Script<class_Script>` script **)** |virtual| |const| |
  59. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | void* | :ref:`_instance_create<class_ScriptExtension_method__instance_create>` **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const| |
  61. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`_instance_has<class_ScriptExtension_method__instance_has>` **(** :ref:`Object<class_Object>` object **)** |virtual| |const| |
  63. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`_is_placeholder_fallback_enabled<class_ScriptExtension_method__is_placeholder_fallback_enabled>` **(** **)** |virtual| |const| |
  65. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`bool<class_bool>` | :ref:`_is_tool<class_ScriptExtension_method__is_tool>` **(** **)** |virtual| |const| |
  67. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`bool<class_bool>` | :ref:`_is_valid<class_ScriptExtension_method__is_valid>` **(** **)** |virtual| |const| |
  69. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | void | :ref:`_placeholder_erased<class_ScriptExtension_method__placeholder_erased>` **(** void* placeholder **)** |virtual| |
  71. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | void* | :ref:`_placeholder_instance_create<class_ScriptExtension_method__placeholder_instance_create>` **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const| |
  73. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`_reload<class_ScriptExtension_method__reload>` **(** :ref:`bool<class_bool>` keep_state **)** |virtual| |
  75. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | void | :ref:`_set_source_code<class_ScriptExtension_method__set_source_code>` **(** :ref:`String<class_String>` code **)** |virtual| |
  77. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | void | :ref:`_update_exports<class_ScriptExtension_method__update_exports>` **(** **)** |virtual| |
  79. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. .. rst-class:: classref-section-separator
  81. ----
  82. .. rst-class:: classref-descriptions-group
  83. Method Descriptions
  84. -------------------
  85. .. _class_ScriptExtension_method__can_instantiate:
  86. .. rst-class:: classref-method
  87. :ref:`bool<class_bool>` **_can_instantiate** **(** **)** |virtual| |const|
  88. .. container:: contribute
  89. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  90. .. rst-class:: classref-item-separator
  91. ----
  92. .. _class_ScriptExtension_method__editor_can_reload_from_file:
  93. .. rst-class:: classref-method
  94. :ref:`bool<class_bool>` **_editor_can_reload_from_file** **(** **)** |virtual|
  95. .. container:: contribute
  96. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  97. .. rst-class:: classref-item-separator
  98. ----
  99. .. _class_ScriptExtension_method__get_base_script:
  100. .. rst-class:: classref-method
  101. :ref:`Script<class_Script>` **_get_base_script** **(** **)** |virtual| |const|
  102. .. container:: contribute
  103. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  104. .. rst-class:: classref-item-separator
  105. ----
  106. .. _class_ScriptExtension_method__get_constants:
  107. .. rst-class:: classref-method
  108. :ref:`Dictionary<class_Dictionary>` **_get_constants** **(** **)** |virtual| |const|
  109. .. container:: contribute
  110. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  111. .. rst-class:: classref-item-separator
  112. ----
  113. .. _class_ScriptExtension_method__get_documentation:
  114. .. rst-class:: classref-method
  115. :ref:`Dictionary[]<class_Dictionary>` **_get_documentation** **(** **)** |virtual| |const|
  116. .. container:: contribute
  117. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  118. .. rst-class:: classref-item-separator
  119. ----
  120. .. _class_ScriptExtension_method__get_instance_base_type:
  121. .. rst-class:: classref-method
  122. :ref:`StringName<class_StringName>` **_get_instance_base_type** **(** **)** |virtual| |const|
  123. .. container:: contribute
  124. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  125. .. rst-class:: classref-item-separator
  126. ----
  127. .. _class_ScriptExtension_method__get_language:
  128. .. rst-class:: classref-method
  129. :ref:`ScriptLanguage<class_ScriptLanguage>` **_get_language** **(** **)** |virtual| |const|
  130. .. container:: contribute
  131. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  132. .. rst-class:: classref-item-separator
  133. ----
  134. .. _class_ScriptExtension_method__get_member_line:
  135. .. rst-class:: classref-method
  136. :ref:`int<class_int>` **_get_member_line** **(** :ref:`StringName<class_StringName>` member **)** |virtual| |const|
  137. .. container:: contribute
  138. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  139. .. rst-class:: classref-item-separator
  140. ----
  141. .. _class_ScriptExtension_method__get_members:
  142. .. rst-class:: classref-method
  143. :ref:`StringName[]<class_StringName>` **_get_members** **(** **)** |virtual| |const|
  144. .. container:: contribute
  145. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  146. .. rst-class:: classref-item-separator
  147. ----
  148. .. _class_ScriptExtension_method__get_method_info:
  149. .. rst-class:: classref-method
  150. :ref:`Dictionary<class_Dictionary>` **_get_method_info** **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|
  151. .. container:: contribute
  152. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  153. .. rst-class:: classref-item-separator
  154. ----
  155. .. _class_ScriptExtension_method__get_property_default_value:
  156. .. rst-class:: classref-method
  157. :ref:`Variant<class_Variant>` **_get_property_default_value** **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const|
  158. .. container:: contribute
  159. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  160. .. rst-class:: classref-item-separator
  161. ----
  162. .. _class_ScriptExtension_method__get_rpc_config:
  163. .. rst-class:: classref-method
  164. :ref:`Variant<class_Variant>` **_get_rpc_config** **(** **)** |virtual| |const|
  165. .. container:: contribute
  166. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  167. .. rst-class:: classref-item-separator
  168. ----
  169. .. _class_ScriptExtension_method__get_script_method_list:
  170. .. rst-class:: classref-method
  171. :ref:`Dictionary[]<class_Dictionary>` **_get_script_method_list** **(** **)** |virtual| |const|
  172. .. container:: contribute
  173. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  174. .. rst-class:: classref-item-separator
  175. ----
  176. .. _class_ScriptExtension_method__get_script_property_list:
  177. .. rst-class:: classref-method
  178. :ref:`Dictionary[]<class_Dictionary>` **_get_script_property_list** **(** **)** |virtual| |const|
  179. .. container:: contribute
  180. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  181. .. rst-class:: classref-item-separator
  182. ----
  183. .. _class_ScriptExtension_method__get_script_signal_list:
  184. .. rst-class:: classref-method
  185. :ref:`Dictionary[]<class_Dictionary>` **_get_script_signal_list** **(** **)** |virtual| |const|
  186. .. container:: contribute
  187. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  188. .. rst-class:: classref-item-separator
  189. ----
  190. .. _class_ScriptExtension_method__get_source_code:
  191. .. rst-class:: classref-method
  192. :ref:`String<class_String>` **_get_source_code** **(** **)** |virtual| |const|
  193. .. container:: contribute
  194. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  195. .. rst-class:: classref-item-separator
  196. ----
  197. .. _class_ScriptExtension_method__has_method:
  198. .. rst-class:: classref-method
  199. :ref:`bool<class_bool>` **_has_method** **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|
  200. .. container:: contribute
  201. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  202. .. rst-class:: classref-item-separator
  203. ----
  204. .. _class_ScriptExtension_method__has_property_default_value:
  205. .. rst-class:: classref-method
  206. :ref:`bool<class_bool>` **_has_property_default_value** **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const|
  207. .. container:: contribute
  208. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  209. .. rst-class:: classref-item-separator
  210. ----
  211. .. _class_ScriptExtension_method__has_script_signal:
  212. .. rst-class:: classref-method
  213. :ref:`bool<class_bool>` **_has_script_signal** **(** :ref:`StringName<class_StringName>` signal **)** |virtual| |const|
  214. .. container:: contribute
  215. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  216. .. rst-class:: classref-item-separator
  217. ----
  218. .. _class_ScriptExtension_method__has_source_code:
  219. .. rst-class:: classref-method
  220. :ref:`bool<class_bool>` **_has_source_code** **(** **)** |virtual| |const|
  221. .. container:: contribute
  222. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  223. .. rst-class:: classref-item-separator
  224. ----
  225. .. _class_ScriptExtension_method__inherits_script:
  226. .. rst-class:: classref-method
  227. :ref:`bool<class_bool>` **_inherits_script** **(** :ref:`Script<class_Script>` script **)** |virtual| |const|
  228. .. container:: contribute
  229. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  230. .. rst-class:: classref-item-separator
  231. ----
  232. .. _class_ScriptExtension_method__instance_create:
  233. .. rst-class:: classref-method
  234. void* **_instance_create** **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|
  235. .. container:: contribute
  236. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  237. .. rst-class:: classref-item-separator
  238. ----
  239. .. _class_ScriptExtension_method__instance_has:
  240. .. rst-class:: classref-method
  241. :ref:`bool<class_bool>` **_instance_has** **(** :ref:`Object<class_Object>` object **)** |virtual| |const|
  242. .. container:: contribute
  243. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  244. .. rst-class:: classref-item-separator
  245. ----
  246. .. _class_ScriptExtension_method__is_placeholder_fallback_enabled:
  247. .. rst-class:: classref-method
  248. :ref:`bool<class_bool>` **_is_placeholder_fallback_enabled** **(** **)** |virtual| |const|
  249. .. container:: contribute
  250. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  251. .. rst-class:: classref-item-separator
  252. ----
  253. .. _class_ScriptExtension_method__is_tool:
  254. .. rst-class:: classref-method
  255. :ref:`bool<class_bool>` **_is_tool** **(** **)** |virtual| |const|
  256. .. container:: contribute
  257. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  258. .. rst-class:: classref-item-separator
  259. ----
  260. .. _class_ScriptExtension_method__is_valid:
  261. .. rst-class:: classref-method
  262. :ref:`bool<class_bool>` **_is_valid** **(** **)** |virtual| |const|
  263. .. container:: contribute
  264. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  265. .. rst-class:: classref-item-separator
  266. ----
  267. .. _class_ScriptExtension_method__placeholder_erased:
  268. .. rst-class:: classref-method
  269. void **_placeholder_erased** **(** void* placeholder **)** |virtual|
  270. .. container:: contribute
  271. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  272. .. rst-class:: classref-item-separator
  273. ----
  274. .. _class_ScriptExtension_method__placeholder_instance_create:
  275. .. rst-class:: classref-method
  276. void* **_placeholder_instance_create** **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|
  277. .. container:: contribute
  278. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  279. .. rst-class:: classref-item-separator
  280. ----
  281. .. _class_ScriptExtension_method__reload:
  282. .. rst-class:: classref-method
  283. :ref:`Error<enum_@GlobalScope_Error>` **_reload** **(** :ref:`bool<class_bool>` keep_state **)** |virtual|
  284. .. container:: contribute
  285. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  286. .. rst-class:: classref-item-separator
  287. ----
  288. .. _class_ScriptExtension_method__set_source_code:
  289. .. rst-class:: classref-method
  290. void **_set_source_code** **(** :ref:`String<class_String>` code **)** |virtual|
  291. .. container:: contribute
  292. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  293. .. rst-class:: classref-item-separator
  294. ----
  295. .. _class_ScriptExtension_method__update_exports:
  296. .. rst-class:: classref-method
  297. void **_update_exports** **(** **)** |virtual|
  298. .. container:: contribute
  299. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  300. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  301. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  302. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  303. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  304. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  305. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`