class_scriptlanguageextension.rst 61 KB

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