class_scriptlanguageextension.rst 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  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/ScriptLanguageExtension.xml.
  6. .. _class_ScriptLanguageExtension:
  7. ScriptLanguageExtension
  8. =======================
  9. **Inherits:** :ref:`ScriptLanguage<class_ScriptLanguage>` **<** :ref:`Object<class_Object>`
  10. Methods
  11. -------
  12. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`_add_global_constant<class_ScriptLanguageExtension_method__add_global_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |virtual| |
  14. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`_add_named_global_constant<class_ScriptLanguageExtension_method__add_named_global_constant>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |virtual| |
  16. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void* | :ref:`_alloc_instance_binding_data<class_ScriptLanguageExtension_method__alloc_instance_binding_data>` **(** :ref:`Object<class_Object>` object **)** |virtual| |
  18. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_String>` | :ref:`_auto_indent_code<class_ScriptLanguageExtension_method__auto_indent_code>` **(** :ref:`String<class_String>` code, :ref:`int<class_int>` from_line, :ref:`int<class_int>` to_line **)** |virtual| |const| |
  20. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`_can_inherit_from_file<class_ScriptLanguageExtension_method__can_inherit_from_file>` **(** **)** |virtual| |const| |
  22. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Dictionary<class_Dictionary>` | :ref:`_complete_code<class_ScriptLanguageExtension_method__complete_code>` **(** :ref:`String<class_String>` code, :ref:`String<class_String>` path, :ref:`Object<class_Object>` owner **)** |virtual| |const| |
  24. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Object<class_Object>` | :ref:`_create_script<class_ScriptLanguageExtension_method__create_script>` **(** **)** |virtual| |const| |
  26. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_debug_get_current_stack_info<class_ScriptLanguageExtension_method__debug_get_current_stack_info>` **(** **)** |virtual| |
  28. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`String<class_String>` | :ref:`_debug_get_error<class_ScriptLanguageExtension_method__debug_get_error>` **(** **)** |virtual| |const| |
  30. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Dictionary<class_Dictionary>` | :ref:`_debug_get_globals<class_ScriptLanguageExtension_method__debug_get_globals>` **(** :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual| |
  32. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`_debug_get_stack_level_count<class_ScriptLanguageExtension_method__debug_get_stack_level_count>` **(** **)** |virtual| |const| |
  34. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`String<class_String>` | :ref:`_debug_get_stack_level_function<class_ScriptLanguageExtension_method__debug_get_stack_level_function>` **(** :ref:`int<class_int>` level **)** |virtual| |const| |
  36. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void* | :ref:`_debug_get_stack_level_instance<class_ScriptLanguageExtension_method__debug_get_stack_level_instance>` **(** :ref:`int<class_int>` level **)** |virtual| |
  38. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`_debug_get_stack_level_line<class_ScriptLanguageExtension_method__debug_get_stack_level_line>` **(** :ref:`int<class_int>` level **)** |virtual| |const| |
  40. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Dictionary<class_Dictionary>` | :ref:`_debug_get_stack_level_locals<class_ScriptLanguageExtension_method__debug_get_stack_level_locals>` **(** :ref:`int<class_int>` level, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual| |
  42. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Dictionary<class_Dictionary>` | :ref:`_debug_get_stack_level_members<class_ScriptLanguageExtension_method__debug_get_stack_level_members>` **(** :ref:`int<class_int>` level, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual| |
  44. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_String>` | :ref:`_debug_parse_stack_level_expression<class_ScriptLanguageExtension_method__debug_parse_stack_level_expression>` **(** :ref:`int<class_int>` level, :ref:`String<class_String>` expression, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual| |
  46. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`_execute_file<class_ScriptLanguageExtension_method__execute_file>` **(** :ref:`String<class_String>` path **)** |virtual| |
  48. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`int<class_int>` | :ref:`_find_function<class_ScriptLanguageExtension_method__find_function>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` function_name **)** |virtual| |const| |
  50. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`_finish<class_ScriptLanguageExtension_method__finish>` **(** **)** |virtual| |
  52. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`_frame<class_ScriptLanguageExtension_method__frame>` **(** **)** |virtual| |
  54. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`_free_instance_binding_data<class_ScriptLanguageExtension_method__free_instance_binding_data>` **(** void* data **)** |virtual| |
  56. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_built_in_templates<class_ScriptLanguageExtension_method__get_built_in_templates>` **(** :ref:`StringName<class_StringName>` object **)** |virtual| |const| |
  58. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_comment_delimiters<class_ScriptLanguageExtension_method__get_comment_delimiters>` **(** **)** |virtual| |const| |
  60. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`String<class_String>` | :ref:`_get_extension<class_ScriptLanguageExtension_method__get_extension>` **(** **)** |virtual| |const| |
  62. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`Dictionary<class_Dictionary>` | :ref:`_get_global_class_name<class_ScriptLanguageExtension_method__get_global_class_name>` **(** :ref:`String<class_String>` path **)** |virtual| |const| |
  64. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`String<class_String>` | :ref:`_get_name<class_ScriptLanguageExtension_method__get_name>` **(** **)** |virtual| |const| |
  66. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_public_annotations<class_ScriptLanguageExtension_method__get_public_annotations>` **(** **)** |virtual| |const| |
  68. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`Dictionary<class_Dictionary>` | :ref:`_get_public_constants<class_ScriptLanguageExtension_method__get_public_constants>` **(** **)** |virtual| |const| |
  70. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`_get_public_functions<class_ScriptLanguageExtension_method__get_public_functions>` **(** **)** |virtual| |const| |
  72. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_recognized_extensions<class_ScriptLanguageExtension_method__get_recognized_extensions>` **(** **)** |virtual| |const| |
  74. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_reserved_words<class_ScriptLanguageExtension_method__get_reserved_words>` **(** **)** |virtual| |const| |
  76. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_string_delimiters<class_ScriptLanguageExtension_method__get_string_delimiters>` **(** **)** |virtual| |const| |
  78. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`String<class_String>` | :ref:`_get_type<class_ScriptLanguageExtension_method__get_type>` **(** **)** |virtual| |const| |
  80. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`_handles_global_class_type<class_ScriptLanguageExtension_method__handles_global_class_type>` **(** :ref:`String<class_String>` type **)** |virtual| |const| |
  82. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`bool<class_bool>` | :ref:`_has_named_classes<class_ScriptLanguageExtension_method__has_named_classes>` **(** **)** |virtual| |const| |
  84. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`_init<class_ScriptLanguageExtension_method__init>` **(** **)** |virtual| |
  86. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`bool<class_bool>` | :ref:`_is_control_flow_keyword<class_ScriptLanguageExtension_method__is_control_flow_keyword>` **(** :ref:`String<class_String>` keyword **)** |virtual| |const| |
  88. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`bool<class_bool>` | :ref:`_is_using_templates<class_ScriptLanguageExtension_method__is_using_templates>` **(** **)** |virtual| |
  90. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`Dictionary<class_Dictionary>` | :ref:`_lookup_code<class_ScriptLanguageExtension_method__lookup_code>` **(** :ref:`String<class_String>` code, :ref:`String<class_String>` symbol, :ref:`String<class_String>` path, :ref:`Object<class_Object>` owner **)** |virtual| |const| |
  92. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`String<class_String>` | :ref:`_make_function<class_ScriptLanguageExtension_method__make_function>` **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` function_name, :ref:`PackedStringArray<class_PackedStringArray>` function_args **)** |virtual| |const| |
  94. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Script<class_Script>` | :ref:`_make_template<class_ScriptLanguageExtension_method__make_template>` **(** :ref:`String<class_String>` template, :ref:`String<class_String>` class_name, :ref:`String<class_String>` base_class_name **)** |virtual| |const| |
  96. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`_open_in_external_editor<class_ScriptLanguageExtension_method__open_in_external_editor>` **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |virtual| |
  98. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`bool<class_bool>` | :ref:`_overrides_external_editor<class_ScriptLanguageExtension_method__overrides_external_editor>` **(** **)** |virtual| |
  100. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`int<class_int>` | :ref:`_profiling_get_accumulated_data<class_ScriptLanguageExtension_method__profiling_get_accumulated_data>` **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int<class_int>` info_max **)** |virtual| |
  102. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`int<class_int>` | :ref:`_profiling_get_frame_data<class_ScriptLanguageExtension_method__profiling_get_frame_data>` **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int<class_int>` info_max **)** |virtual| |
  104. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`_profiling_start<class_ScriptLanguageExtension_method__profiling_start>` **(** **)** |virtual| |
  106. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | void | :ref:`_profiling_stop<class_ScriptLanguageExtension_method__profiling_stop>` **(** **)** |virtual| |
  108. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`bool<class_bool>` | :ref:`_refcount_decremented_instance_binding<class_ScriptLanguageExtension_method__refcount_decremented_instance_binding>` **(** :ref:`Object<class_Object>` object **)** |virtual| |
  110. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | void | :ref:`_refcount_incremented_instance_binding<class_ScriptLanguageExtension_method__refcount_incremented_instance_binding>` **(** :ref:`Object<class_Object>` object **)** |virtual| |
  112. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | void | :ref:`_reload_all_scripts<class_ScriptLanguageExtension_method__reload_all_scripts>` **(** **)** |virtual| |
  114. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | void | :ref:`_reload_tool_script<class_ScriptLanguageExtension_method__reload_tool_script>` **(** :ref:`Script<class_Script>` script, :ref:`bool<class_bool>` soft_reload **)** |virtual| |
  116. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | void | :ref:`_remove_named_global_constant<class_ScriptLanguageExtension_method__remove_named_global_constant>` **(** :ref:`StringName<class_StringName>` name **)** |virtual| |
  118. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`bool<class_bool>` | :ref:`_supports_builtin_mode<class_ScriptLanguageExtension_method__supports_builtin_mode>` **(** **)** |virtual| |const| |
  120. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`bool<class_bool>` | :ref:`_supports_documentation<class_ScriptLanguageExtension_method__supports_documentation>` **(** **)** |virtual| |const| |
  122. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | void | :ref:`_thread_enter<class_ScriptLanguageExtension_method__thread_enter>` **(** **)** |virtual| |
  124. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | void | :ref:`_thread_exit<class_ScriptLanguageExtension_method__thread_exit>` **(** **)** |virtual| |
  126. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Dictionary<class_Dictionary>` | :ref:`_validate<class_ScriptLanguageExtension_method__validate>` **(** :ref:`String<class_String>` script, :ref:`String<class_String>` path, :ref:`bool<class_bool>` validate_functions, :ref:`bool<class_bool>` validate_errors, :ref:`bool<class_bool>` validate_warnings, :ref:`bool<class_bool>` validate_safe_lines **)** |virtual| |const| |
  128. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`String<class_String>` | :ref:`_validate_path<class_ScriptLanguageExtension_method__validate_path>` **(** :ref:`String<class_String>` path **)** |virtual| |const| |
  130. +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. Enumerations
  132. ------------
  133. .. _enum_ScriptLanguageExtension_LookupResultType:
  134. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_SCRIPT_LOCATION:
  135. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS:
  136. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_CONSTANT:
  137. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_PROPERTY:
  138. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_METHOD:
  139. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_SIGNAL:
  140. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_ENUM:
  141. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE:
  142. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_CLASS_ANNOTATION:
  143. .. _class_ScriptLanguageExtension_constant_LOOKUP_RESULT_MAX:
  144. enum **LookupResultType**:
  145. - **LOOKUP_RESULT_SCRIPT_LOCATION** = **0**
  146. - **LOOKUP_RESULT_CLASS** = **1**
  147. - **LOOKUP_RESULT_CLASS_CONSTANT** = **2**
  148. - **LOOKUP_RESULT_CLASS_PROPERTY** = **3**
  149. - **LOOKUP_RESULT_CLASS_METHOD** = **4**
  150. - **LOOKUP_RESULT_CLASS_SIGNAL** = **5**
  151. - **LOOKUP_RESULT_CLASS_ENUM** = **6**
  152. - **LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE** = **7**
  153. - **LOOKUP_RESULT_CLASS_ANNOTATION** = **8**
  154. - **LOOKUP_RESULT_MAX** = **9**
  155. ----
  156. .. _enum_ScriptLanguageExtension_CodeCompletionLocation:
  157. .. _class_ScriptLanguageExtension_constant_LOCATION_LOCAL:
  158. .. _class_ScriptLanguageExtension_constant_LOCATION_PARENT_MASK:
  159. .. _class_ScriptLanguageExtension_constant_LOCATION_OTHER_USER_CODE:
  160. .. _class_ScriptLanguageExtension_constant_LOCATION_OTHER:
  161. enum **CodeCompletionLocation**:
  162. - **LOCATION_LOCAL** = **0** --- The option is local to the location of the code completion query - e.g. a local variable.
  163. - **LOCATION_PARENT_MASK** = **256** --- The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in a the class or a parent class.
  164. - **LOCATION_OTHER_USER_CODE** = **512** --- The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).
  165. - **LOCATION_OTHER** = **1024** --- The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.
  166. ----
  167. .. _enum_ScriptLanguageExtension_CodeCompletionKind:
  168. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_CLASS:
  169. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_FUNCTION:
  170. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_SIGNAL:
  171. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_VARIABLE:
  172. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_MEMBER:
  173. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_ENUM:
  174. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_CONSTANT:
  175. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_NODE_PATH:
  176. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_FILE_PATH:
  177. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_PLAIN_TEXT:
  178. .. _class_ScriptLanguageExtension_constant_CODE_COMPLETION_KIND_MAX:
  179. enum **CodeCompletionKind**:
  180. - **CODE_COMPLETION_KIND_CLASS** = **0**
  181. - **CODE_COMPLETION_KIND_FUNCTION** = **1**
  182. - **CODE_COMPLETION_KIND_SIGNAL** = **2**
  183. - **CODE_COMPLETION_KIND_VARIABLE** = **3**
  184. - **CODE_COMPLETION_KIND_MEMBER** = **4**
  185. - **CODE_COMPLETION_KIND_ENUM** = **5**
  186. - **CODE_COMPLETION_KIND_CONSTANT** = **6**
  187. - **CODE_COMPLETION_KIND_NODE_PATH** = **7**
  188. - **CODE_COMPLETION_KIND_FILE_PATH** = **8**
  189. - **CODE_COMPLETION_KIND_PLAIN_TEXT** = **9**
  190. - **CODE_COMPLETION_KIND_MAX** = **10**
  191. Method Descriptions
  192. -------------------
  193. .. _class_ScriptLanguageExtension_method__add_global_constant:
  194. - void **_add_global_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |virtual|
  195. ----
  196. .. _class_ScriptLanguageExtension_method__add_named_global_constant:
  197. - void **_add_named_global_constant** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |virtual|
  198. ----
  199. .. _class_ScriptLanguageExtension_method__alloc_instance_binding_data:
  200. - void* **_alloc_instance_binding_data** **(** :ref:`Object<class_Object>` object **)** |virtual|
  201. ----
  202. .. _class_ScriptLanguageExtension_method__auto_indent_code:
  203. - :ref:`String<class_String>` **_auto_indent_code** **(** :ref:`String<class_String>` code, :ref:`int<class_int>` from_line, :ref:`int<class_int>` to_line **)** |virtual| |const|
  204. ----
  205. .. _class_ScriptLanguageExtension_method__can_inherit_from_file:
  206. - :ref:`bool<class_bool>` **_can_inherit_from_file** **(** **)** |virtual| |const|
  207. ----
  208. .. _class_ScriptLanguageExtension_method__complete_code:
  209. - :ref:`Dictionary<class_Dictionary>` **_complete_code** **(** :ref:`String<class_String>` code, :ref:`String<class_String>` path, :ref:`Object<class_Object>` owner **)** |virtual| |const|
  210. ----
  211. .. _class_ScriptLanguageExtension_method__create_script:
  212. - :ref:`Object<class_Object>` **_create_script** **(** **)** |virtual| |const|
  213. ----
  214. .. _class_ScriptLanguageExtension_method__debug_get_current_stack_info:
  215. - :ref:`Dictionary[]<class_Dictionary>` **_debug_get_current_stack_info** **(** **)** |virtual|
  216. ----
  217. .. _class_ScriptLanguageExtension_method__debug_get_error:
  218. - :ref:`String<class_String>` **_debug_get_error** **(** **)** |virtual| |const|
  219. ----
  220. .. _class_ScriptLanguageExtension_method__debug_get_globals:
  221. - :ref:`Dictionary<class_Dictionary>` **_debug_get_globals** **(** :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual|
  222. ----
  223. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_count:
  224. - :ref:`int<class_int>` **_debug_get_stack_level_count** **(** **)** |virtual| |const|
  225. ----
  226. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_function:
  227. - :ref:`String<class_String>` **_debug_get_stack_level_function** **(** :ref:`int<class_int>` level **)** |virtual| |const|
  228. ----
  229. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_instance:
  230. - void* **_debug_get_stack_level_instance** **(** :ref:`int<class_int>` level **)** |virtual|
  231. ----
  232. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_line:
  233. - :ref:`int<class_int>` **_debug_get_stack_level_line** **(** :ref:`int<class_int>` level **)** |virtual| |const|
  234. ----
  235. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_locals:
  236. - :ref:`Dictionary<class_Dictionary>` **_debug_get_stack_level_locals** **(** :ref:`int<class_int>` level, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual|
  237. ----
  238. .. _class_ScriptLanguageExtension_method__debug_get_stack_level_members:
  239. - :ref:`Dictionary<class_Dictionary>` **_debug_get_stack_level_members** **(** :ref:`int<class_int>` level, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual|
  240. ----
  241. .. _class_ScriptLanguageExtension_method__debug_parse_stack_level_expression:
  242. - :ref:`String<class_String>` **_debug_parse_stack_level_expression** **(** :ref:`int<class_int>` level, :ref:`String<class_String>` expression, :ref:`int<class_int>` max_subitems, :ref:`int<class_int>` max_depth **)** |virtual|
  243. ----
  244. .. _class_ScriptLanguageExtension_method__execute_file:
  245. - :ref:`Error<enum_@GlobalScope_Error>` **_execute_file** **(** :ref:`String<class_String>` path **)** |virtual|
  246. ----
  247. .. _class_ScriptLanguageExtension_method__find_function:
  248. - :ref:`int<class_int>` **_find_function** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` function_name **)** |virtual| |const|
  249. ----
  250. .. _class_ScriptLanguageExtension_method__finish:
  251. - void **_finish** **(** **)** |virtual|
  252. ----
  253. .. _class_ScriptLanguageExtension_method__frame:
  254. - void **_frame** **(** **)** |virtual|
  255. ----
  256. .. _class_ScriptLanguageExtension_method__free_instance_binding_data:
  257. - void **_free_instance_binding_data** **(** void* data **)** |virtual|
  258. ----
  259. .. _class_ScriptLanguageExtension_method__get_built_in_templates:
  260. - :ref:`Dictionary[]<class_Dictionary>` **_get_built_in_templates** **(** :ref:`StringName<class_StringName>` object **)** |virtual| |const|
  261. ----
  262. .. _class_ScriptLanguageExtension_method__get_comment_delimiters:
  263. - :ref:`PackedStringArray<class_PackedStringArray>` **_get_comment_delimiters** **(** **)** |virtual| |const|
  264. ----
  265. .. _class_ScriptLanguageExtension_method__get_extension:
  266. - :ref:`String<class_String>` **_get_extension** **(** **)** |virtual| |const|
  267. ----
  268. .. _class_ScriptLanguageExtension_method__get_global_class_name:
  269. - :ref:`Dictionary<class_Dictionary>` **_get_global_class_name** **(** :ref:`String<class_String>` path **)** |virtual| |const|
  270. ----
  271. .. _class_ScriptLanguageExtension_method__get_name:
  272. - :ref:`String<class_String>` **_get_name** **(** **)** |virtual| |const|
  273. ----
  274. .. _class_ScriptLanguageExtension_method__get_public_annotations:
  275. - :ref:`Dictionary[]<class_Dictionary>` **_get_public_annotations** **(** **)** |virtual| |const|
  276. ----
  277. .. _class_ScriptLanguageExtension_method__get_public_constants:
  278. - :ref:`Dictionary<class_Dictionary>` **_get_public_constants** **(** **)** |virtual| |const|
  279. ----
  280. .. _class_ScriptLanguageExtension_method__get_public_functions:
  281. - :ref:`Dictionary[]<class_Dictionary>` **_get_public_functions** **(** **)** |virtual| |const|
  282. ----
  283. .. _class_ScriptLanguageExtension_method__get_recognized_extensions:
  284. - :ref:`PackedStringArray<class_PackedStringArray>` **_get_recognized_extensions** **(** **)** |virtual| |const|
  285. ----
  286. .. _class_ScriptLanguageExtension_method__get_reserved_words:
  287. - :ref:`PackedStringArray<class_PackedStringArray>` **_get_reserved_words** **(** **)** |virtual| |const|
  288. ----
  289. .. _class_ScriptLanguageExtension_method__get_string_delimiters:
  290. - :ref:`PackedStringArray<class_PackedStringArray>` **_get_string_delimiters** **(** **)** |virtual| |const|
  291. ----
  292. .. _class_ScriptLanguageExtension_method__get_type:
  293. - :ref:`String<class_String>` **_get_type** **(** **)** |virtual| |const|
  294. ----
  295. .. _class_ScriptLanguageExtension_method__handles_global_class_type:
  296. - :ref:`bool<class_bool>` **_handles_global_class_type** **(** :ref:`String<class_String>` type **)** |virtual| |const|
  297. ----
  298. .. _class_ScriptLanguageExtension_method__has_named_classes:
  299. - :ref:`bool<class_bool>` **_has_named_classes** **(** **)** |virtual| |const|
  300. ----
  301. .. _class_ScriptLanguageExtension_method__init:
  302. - void **_init** **(** **)** |virtual|
  303. ----
  304. .. _class_ScriptLanguageExtension_method__is_control_flow_keyword:
  305. - :ref:`bool<class_bool>` **_is_control_flow_keyword** **(** :ref:`String<class_String>` keyword **)** |virtual| |const|
  306. ----
  307. .. _class_ScriptLanguageExtension_method__is_using_templates:
  308. - :ref:`bool<class_bool>` **_is_using_templates** **(** **)** |virtual|
  309. ----
  310. .. _class_ScriptLanguageExtension_method__lookup_code:
  311. - :ref:`Dictionary<class_Dictionary>` **_lookup_code** **(** :ref:`String<class_String>` code, :ref:`String<class_String>` symbol, :ref:`String<class_String>` path, :ref:`Object<class_Object>` owner **)** |virtual| |const|
  312. ----
  313. .. _class_ScriptLanguageExtension_method__make_function:
  314. - :ref:`String<class_String>` **_make_function** **(** :ref:`String<class_String>` class_name, :ref:`String<class_String>` function_name, :ref:`PackedStringArray<class_PackedStringArray>` function_args **)** |virtual| |const|
  315. ----
  316. .. _class_ScriptLanguageExtension_method__make_template:
  317. - :ref:`Script<class_Script>` **_make_template** **(** :ref:`String<class_String>` template, :ref:`String<class_String>` class_name, :ref:`String<class_String>` base_class_name **)** |virtual| |const|
  318. ----
  319. .. _class_ScriptLanguageExtension_method__open_in_external_editor:
  320. - :ref:`Error<enum_@GlobalScope_Error>` **_open_in_external_editor** **(** :ref:`Script<class_Script>` script, :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |virtual|
  321. ----
  322. .. _class_ScriptLanguageExtension_method__overrides_external_editor:
  323. - :ref:`bool<class_bool>` **_overrides_external_editor** **(** **)** |virtual|
  324. ----
  325. .. _class_ScriptLanguageExtension_method__profiling_get_accumulated_data:
  326. - :ref:`int<class_int>` **_profiling_get_accumulated_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int<class_int>` info_max **)** |virtual|
  327. ----
  328. .. _class_ScriptLanguageExtension_method__profiling_get_frame_data:
  329. - :ref:`int<class_int>` **_profiling_get_frame_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int<class_int>` info_max **)** |virtual|
  330. ----
  331. .. _class_ScriptLanguageExtension_method__profiling_start:
  332. - void **_profiling_start** **(** **)** |virtual|
  333. ----
  334. .. _class_ScriptLanguageExtension_method__profiling_stop:
  335. - void **_profiling_stop** **(** **)** |virtual|
  336. ----
  337. .. _class_ScriptLanguageExtension_method__refcount_decremented_instance_binding:
  338. - :ref:`bool<class_bool>` **_refcount_decremented_instance_binding** **(** :ref:`Object<class_Object>` object **)** |virtual|
  339. ----
  340. .. _class_ScriptLanguageExtension_method__refcount_incremented_instance_binding:
  341. - void **_refcount_incremented_instance_binding** **(** :ref:`Object<class_Object>` object **)** |virtual|
  342. ----
  343. .. _class_ScriptLanguageExtension_method__reload_all_scripts:
  344. - void **_reload_all_scripts** **(** **)** |virtual|
  345. ----
  346. .. _class_ScriptLanguageExtension_method__reload_tool_script:
  347. - void **_reload_tool_script** **(** :ref:`Script<class_Script>` script, :ref:`bool<class_bool>` soft_reload **)** |virtual|
  348. ----
  349. .. _class_ScriptLanguageExtension_method__remove_named_global_constant:
  350. - void **_remove_named_global_constant** **(** :ref:`StringName<class_StringName>` name **)** |virtual|
  351. ----
  352. .. _class_ScriptLanguageExtension_method__supports_builtin_mode:
  353. - :ref:`bool<class_bool>` **_supports_builtin_mode** **(** **)** |virtual| |const|
  354. ----
  355. .. _class_ScriptLanguageExtension_method__supports_documentation:
  356. - :ref:`bool<class_bool>` **_supports_documentation** **(** **)** |virtual| |const|
  357. ----
  358. .. _class_ScriptLanguageExtension_method__thread_enter:
  359. - void **_thread_enter** **(** **)** |virtual|
  360. ----
  361. .. _class_ScriptLanguageExtension_method__thread_exit:
  362. - void **_thread_exit** **(** **)** |virtual|
  363. ----
  364. .. _class_ScriptLanguageExtension_method__validate:
  365. - :ref:`Dictionary<class_Dictionary>` **_validate** **(** :ref:`String<class_String>` script, :ref:`String<class_String>` path, :ref:`bool<class_bool>` validate_functions, :ref:`bool<class_bool>` validate_errors, :ref:`bool<class_bool>` validate_warnings, :ref:`bool<class_bool>` validate_safe_lines **)** |virtual| |const|
  366. ----
  367. .. _class_ScriptLanguageExtension_method__validate_path:
  368. - :ref:`String<class_String>` **_validate_path** **(** :ref:`String<class_String>` path **)** |virtual| |const|
  369. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  370. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  371. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  372. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  373. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  374. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`