Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_scriptextension.rst

class_scriptextension.rst 19 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptExtension.xml.
    7. 

  7. 

  8. .. _class_ScriptExtension:
    9. 

  9. 

  10. ScriptExtension
    11. 

  11. ===============
    12. 

  12. 

  13. **Inherits:** :ref:`Script<class_Script>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. 

  16. 

  17. Methods
    18. 

  18. -------
    19. 

  19. 

  20. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    21. 

  21. | :ref:`bool<class_bool>`                     | :ref:`_can_instantiate<class_ScriptExtension_method__can_instantiate>` **(** **)** |virtual| |const|                                                                    |
    22. 

  22. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`bool<class_bool>`                     | :ref:`_editor_can_reload_from_file<class_ScriptExtension_method__editor_can_reload_from_file>` **(** **)** |virtual|                                                    |
    24. 

  24. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`Script<class_Script>`                 | :ref:`_get_base_script<class_ScriptExtension_method__get_base_script>` **(** **)** |virtual| |const|                                                                    |
    26. 

  26. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`Dictionary<class_Dictionary>`         | :ref:`_get_constants<class_ScriptExtension_method__get_constants>` **(** **)** |virtual| |const|                                                                        |
    28. 

  28. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`Dictionary[]<class_Dictionary>`       | :ref:`_get_documentation<class_ScriptExtension_method__get_documentation>` **(** **)** |virtual| |const|                                                                |
    30. 

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

  31. | :ref:`StringName<class_StringName>`         | :ref:`_get_instance_base_type<class_ScriptExtension_method__get_instance_base_type>` **(** **)** |virtual| |const|                                                      |
    32. 

  32. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`ScriptLanguage<class_ScriptLanguage>` | :ref:`_get_language<class_ScriptExtension_method__get_language>` **(** **)** |virtual| |const|                                                                          |
    34. 

  34. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`int<class_int>`                       | :ref:`_get_member_line<class_ScriptExtension_method__get_member_line>` **(** :ref:`StringName<class_StringName>` member **)** |virtual| |const|                         |
    36. 

  36. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`StringName[]<class_StringName>`       | :ref:`_get_members<class_ScriptExtension_method__get_members>` **(** **)** |virtual| |const|                                                                            |
    38. 

  38. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Dictionary<class_Dictionary>`         | :ref:`_get_method_info<class_ScriptExtension_method__get_method_info>` **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|                         |
    40. 

  40. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Variant<class_Variant>`               | :ref:`_get_property_default_value<class_ScriptExtension_method__get_property_default_value>` **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const| |
    42. 

  42. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`Dictionary[]<class_Dictionary>`       | :ref:`_get_rpc_methods<class_ScriptExtension_method__get_rpc_methods>` **(** **)** |virtual| |const|                                                                    |
    44. 

  44. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`Dictionary[]<class_Dictionary>`       | :ref:`_get_script_method_list<class_ScriptExtension_method__get_script_method_list>` **(** **)** |virtual| |const|                                                      |
    46. 

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

  47. | :ref:`Dictionary[]<class_Dictionary>`       | :ref:`_get_script_property_list<class_ScriptExtension_method__get_script_property_list>` **(** **)** |virtual| |const|                                                  |
    48. 

  48. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`Dictionary[]<class_Dictionary>`       | :ref:`_get_script_signal_list<class_ScriptExtension_method__get_script_signal_list>` **(** **)** |virtual| |const|                                                      |
    50. 

  50. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`String<class_String>`                 | :ref:`_get_source_code<class_ScriptExtension_method__get_source_code>` **(** **)** |virtual| |const|                                                                    |
    52. 

  52. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`bool<class_bool>`                     | :ref:`_has_method<class_ScriptExtension_method__has_method>` **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|                                   |
    54. 

  54. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`bool<class_bool>`                     | :ref:`_has_script_signal<class_ScriptExtension_method__has_script_signal>` **(** :ref:`StringName<class_StringName>` signal **)** |virtual| |const|                     |
    56. 

  56. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`bool<class_bool>`                     | :ref:`_has_source_code<class_ScriptExtension_method__has_source_code>` **(** **)** |virtual| |const|                                                                    |
    58. 

  58. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`bool<class_bool>`                     | :ref:`_inherits_script<class_ScriptExtension_method__inherits_script>` **(** :ref:`Script<class_Script>` script **)** |virtual| |const|                                 |
    60. 

  60. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. | void*                                       | :ref:`_instance_create<class_ScriptExtension_method__instance_create>` **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|                             |
    62. 

  62. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. | :ref:`bool<class_bool>`                     | :ref:`_instance_has<class_ScriptExtension_method__instance_has>` **(** :ref:`Object<class_Object>` object **)** |virtual| |const|                                       |
    64. 

  64. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65. | :ref:`bool<class_bool>`                     | :ref:`_is_placeholder_fallback_enabled<class_ScriptExtension_method__is_placeholder_fallback_enabled>` **(** **)** |virtual| |const|                                    |
    66. 

  66. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. | :ref:`bool<class_bool>`                     | :ref:`_is_tool<class_ScriptExtension_method__is_tool>` **(** **)** |virtual| |const|                                                                                    |
    68. 

  68. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69. | :ref:`bool<class_bool>`                     | :ref:`_is_valid<class_ScriptExtension_method__is_valid>` **(** **)** |virtual| |const|                                                                                  |
    70. 

  70. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71. | void                                        | :ref:`_placeholder_erased<class_ScriptExtension_method__placeholder_erased>` **(** void* placeholder **)** |virtual|                                                    |
    72. 

  72. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73. | void*                                       | :ref:`_placeholder_instance_create<class_ScriptExtension_method__placeholder_instance_create>` **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|     |
    74. 

  74. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75. | :ref:`Error<enum_@GlobalScope_Error>`       | :ref:`_reload<class_ScriptExtension_method__reload>` **(** :ref:`bool<class_bool>` keep_state **)** |virtual|                                                           |
    76. 

  76. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77. | void                                        | :ref:`_set_source_code<class_ScriptExtension_method__set_source_code>` **(** :ref:`String<class_String>` code **)** |virtual|                                           |
    78. 

  78. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79. | void                                        | :ref:`_update_exports<class_ScriptExtension_method__update_exports>` **(** **)** |virtual|                                                                              |
    80. 

  80. +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81. 

  82. Method Descriptions
    83. 

  83. -------------------
    84. 

  84. 

  85. .. _class_ScriptExtension_method__can_instantiate:
    86. 

  86. 

  87. - :ref:`bool<class_bool>` **_can_instantiate** **(** **)** |virtual| |const|
    88. 

  88. 

  89. ----
    90. 

  90. 

  91. .. _class_ScriptExtension_method__editor_can_reload_from_file:
    92. 

  92. 

  93. - :ref:`bool<class_bool>` **_editor_can_reload_from_file** **(** **)** |virtual|
    94. 

  94. 

  95. ----
    96. 

  96. 

  97. .. _class_ScriptExtension_method__get_base_script:
    98. 

  98. 

  99. - :ref:`Script<class_Script>` **_get_base_script** **(** **)** |virtual| |const|
    100. 

  100. 

  101. ----
    102. 

  102. 

  103. .. _class_ScriptExtension_method__get_constants:
    104. 

  104. 

  105. - :ref:`Dictionary<class_Dictionary>` **_get_constants** **(** **)** |virtual| |const|
    106. 

  106. 

  107. ----
    108. 

  108. 

  109. .. _class_ScriptExtension_method__get_documentation:
    110. 

  110. 

  111. - :ref:`Dictionary[]<class_Dictionary>` **_get_documentation** **(** **)** |virtual| |const|
    112. 

  112. 

  113. ----
    114. 

  114. 

  115. .. _class_ScriptExtension_method__get_instance_base_type:
    116. 

  116. 

  117. - :ref:`StringName<class_StringName>` **_get_instance_base_type** **(** **)** |virtual| |const|
    118. 

  118. 

  119. ----
    120. 

  120. 

  121. .. _class_ScriptExtension_method__get_language:
    122. 

  122. 

  123. - :ref:`ScriptLanguage<class_ScriptLanguage>` **_get_language** **(** **)** |virtual| |const|
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_ScriptExtension_method__get_member_line:
    128. 

  128. 

  129. - :ref:`int<class_int>` **_get_member_line** **(** :ref:`StringName<class_StringName>` member **)** |virtual| |const|
    130. 

  130. 

  131. ----
    132. 

  132. 

  133. .. _class_ScriptExtension_method__get_members:
    134. 

  134. 

  135. - :ref:`StringName[]<class_StringName>` **_get_members** **(** **)** |virtual| |const|
    136. 

  136. 

  137. ----
    138. 

  138. 

  139. .. _class_ScriptExtension_method__get_method_info:
    140. 

  140. 

  141. - :ref:`Dictionary<class_Dictionary>` **_get_method_info** **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|
    142. 

  142. 

  143. ----
    144. 

  144. 

  145. .. _class_ScriptExtension_method__get_property_default_value:
    146. 

  146. 

  147. - :ref:`Variant<class_Variant>` **_get_property_default_value** **(** :ref:`StringName<class_StringName>` property **)** |virtual| |const|
    148. 

  148. 

  149. ----
    150. 

  150. 

  151. .. _class_ScriptExtension_method__get_rpc_methods:
    152. 

  152. 

  153. - :ref:`Dictionary[]<class_Dictionary>` **_get_rpc_methods** **(** **)** |virtual| |const|
    154. 

  154. 

  155. ----
    156. 

  156. 

  157. .. _class_ScriptExtension_method__get_script_method_list:
    158. 

  158. 

  159. - :ref:`Dictionary[]<class_Dictionary>` **_get_script_method_list** **(** **)** |virtual| |const|
    160. 

  160. 

  161. ----
    162. 

  162. 

  163. .. _class_ScriptExtension_method__get_script_property_list:
    164. 

  164. 

  165. - :ref:`Dictionary[]<class_Dictionary>` **_get_script_property_list** **(** **)** |virtual| |const|
    166. 

  166. 

  167. ----
    168. 

  168. 

  169. .. _class_ScriptExtension_method__get_script_signal_list:
    170. 

  170. 

  171. - :ref:`Dictionary[]<class_Dictionary>` **_get_script_signal_list** **(** **)** |virtual| |const|
    172. 

  172. 

  173. ----
    174. 

  174. 

  175. .. _class_ScriptExtension_method__get_source_code:
    176. 

  176. 

  177. - :ref:`String<class_String>` **_get_source_code** **(** **)** |virtual| |const|
    178. 

  178. 

  179. ----
    180. 

  180. 

  181. .. _class_ScriptExtension_method__has_method:
    182. 

  182. 

  183. - :ref:`bool<class_bool>` **_has_method** **(** :ref:`StringName<class_StringName>` method **)** |virtual| |const|
    184. 

  184. 

  185. ----
    186. 

  186. 

  187. .. _class_ScriptExtension_method__has_script_signal:
    188. 

  188. 

  189. - :ref:`bool<class_bool>` **_has_script_signal** **(** :ref:`StringName<class_StringName>` signal **)** |virtual| |const|
    190. 

  190. 

  191. ----
    192. 

  192. 

  193. .. _class_ScriptExtension_method__has_source_code:
    194. 

  194. 

  195. - :ref:`bool<class_bool>` **_has_source_code** **(** **)** |virtual| |const|
    196. 

  196. 

  197. ----
    198. 

  198. 

  199. .. _class_ScriptExtension_method__inherits_script:
    200. 

  200. 

  201. - :ref:`bool<class_bool>` **_inherits_script** **(** :ref:`Script<class_Script>` script **)** |virtual| |const|
    202. 

  202. 

  203. ----
    204. 

  204. 

  205. .. _class_ScriptExtension_method__instance_create:
    206. 

  206. 

  207. - void* **_instance_create** **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|
    208. 

  208. 

  209. ----
    210. 

  210. 

  211. .. _class_ScriptExtension_method__instance_has:
    212. 

  212. 

  213. - :ref:`bool<class_bool>` **_instance_has** **(** :ref:`Object<class_Object>` object **)** |virtual| |const|
    214. 

  214. 

  215. ----
    216. 

  216. 

  217. .. _class_ScriptExtension_method__is_placeholder_fallback_enabled:
    218. 

  218. 

  219. - :ref:`bool<class_bool>` **_is_placeholder_fallback_enabled** **(** **)** |virtual| |const|
    220. 

  220. 

  221. ----
    222. 

  222. 

  223. .. _class_ScriptExtension_method__is_tool:
    224. 

  224. 

  225. - :ref:`bool<class_bool>` **_is_tool** **(** **)** |virtual| |const|
    226. 

  226. 

  227. ----
    228. 

  228. 

  229. .. _class_ScriptExtension_method__is_valid:
    230. 

  230. 

  231. - :ref:`bool<class_bool>` **_is_valid** **(** **)** |virtual| |const|
    232. 

  232. 

  233. ----
    234. 

  234. 

  235. .. _class_ScriptExtension_method__placeholder_erased:
    236. 

  236. 

  237. - void **_placeholder_erased** **(** void* placeholder **)** |virtual|
    238. 

  238. 

  239. ----
    240. 

  240. 

  241. .. _class_ScriptExtension_method__placeholder_instance_create:
    242. 

  242. 

  243. - void* **_placeholder_instance_create** **(** :ref:`Object<class_Object>` for_object **)** |virtual| |const|
    244. 

  244. 

  245. ----
    246. 

  246. 

  247. .. _class_ScriptExtension_method__reload:
    248. 

  248. 

  249. - :ref:`Error<enum_@GlobalScope_Error>` **_reload** **(** :ref:`bool<class_bool>` keep_state **)** |virtual|
    250. 

  250. 

  251. ----
    252. 

  252. 

  253. .. _class_ScriptExtension_method__set_source_code:
    254. 

  254. 

  255. - void **_set_source_code** **(** :ref:`String<class_String>` code **)** |virtual|
    256. 

  256. 

  257. ----
    258. 

  258. 

  259. .. _class_ScriptExtension_method__update_exports:
    260. 

  260. 

  261. - void **_update_exports** **(** **)** |virtual|
    262. 

  262. 

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

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

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

  266. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    267. 

  267. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    268. 

  268. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    269.