ScriptLanguageExtension.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="ScriptLanguageExtension" inherits="ScriptLanguage" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. </brief_description>
  5. <description>
  6. </description>
  7. <tutorials>
  8. </tutorials>
  9. <methods>
  10. <method name="_add_global_constant" qualifiers="virtual">
  11. <return type="void" />
  12. <param index="0" name="name" type="StringName" />
  13. <param index="1" name="value" type="Variant" />
  14. <description>
  15. </description>
  16. </method>
  17. <method name="_add_named_global_constant" qualifiers="virtual">
  18. <return type="void" />
  19. <param index="0" name="name" type="StringName" />
  20. <param index="1" name="value" type="Variant" />
  21. <description>
  22. </description>
  23. </method>
  24. <method name="_auto_indent_code" qualifiers="virtual const">
  25. <return type="String" />
  26. <param index="0" name="code" type="String" />
  27. <param index="1" name="from_line" type="int" />
  28. <param index="2" name="to_line" type="int" />
  29. <description>
  30. </description>
  31. </method>
  32. <method name="_can_inherit_from_file" qualifiers="virtual const">
  33. <return type="bool" />
  34. <description>
  35. </description>
  36. </method>
  37. <method name="_complete_code" qualifiers="virtual const">
  38. <return type="Dictionary" />
  39. <param index="0" name="code" type="String" />
  40. <param index="1" name="path" type="String" />
  41. <param index="2" name="owner" type="Object" />
  42. <description>
  43. </description>
  44. </method>
  45. <method name="_create_script" qualifiers="virtual const">
  46. <return type="Object" />
  47. <description>
  48. </description>
  49. </method>
  50. <method name="_debug_get_current_stack_info" qualifiers="virtual">
  51. <return type="Dictionary[]" />
  52. <description>
  53. </description>
  54. </method>
  55. <method name="_debug_get_error" qualifiers="virtual const">
  56. <return type="String" />
  57. <description>
  58. </description>
  59. </method>
  60. <method name="_debug_get_globals" qualifiers="virtual">
  61. <return type="Dictionary" />
  62. <param index="0" name="max_subitems" type="int" />
  63. <param index="1" name="max_depth" type="int" />
  64. <description>
  65. </description>
  66. </method>
  67. <method name="_debug_get_stack_level_count" qualifiers="virtual const">
  68. <return type="int" />
  69. <description>
  70. </description>
  71. </method>
  72. <method name="_debug_get_stack_level_function" qualifiers="virtual const">
  73. <return type="String" />
  74. <param index="0" name="level" type="int" />
  75. <description>
  76. </description>
  77. </method>
  78. <method name="_debug_get_stack_level_instance" qualifiers="virtual">
  79. <return type="void*" />
  80. <param index="0" name="level" type="int" />
  81. <description>
  82. </description>
  83. </method>
  84. <method name="_debug_get_stack_level_line" qualifiers="virtual const">
  85. <return type="int" />
  86. <param index="0" name="level" type="int" />
  87. <description>
  88. </description>
  89. </method>
  90. <method name="_debug_get_stack_level_locals" qualifiers="virtual">
  91. <return type="Dictionary" />
  92. <param index="0" name="level" type="int" />
  93. <param index="1" name="max_subitems" type="int" />
  94. <param index="2" name="max_depth" type="int" />
  95. <description>
  96. </description>
  97. </method>
  98. <method name="_debug_get_stack_level_members" qualifiers="virtual">
  99. <return type="Dictionary" />
  100. <param index="0" name="level" type="int" />
  101. <param index="1" name="max_subitems" type="int" />
  102. <param index="2" name="max_depth" type="int" />
  103. <description>
  104. </description>
  105. </method>
  106. <method name="_debug_parse_stack_level_expression" qualifiers="virtual">
  107. <return type="String" />
  108. <param index="0" name="level" type="int" />
  109. <param index="1" name="expression" type="String" />
  110. <param index="2" name="max_subitems" type="int" />
  111. <param index="3" name="max_depth" type="int" />
  112. <description>
  113. </description>
  114. </method>
  115. <method name="_find_function" qualifiers="virtual const">
  116. <return type="int" />
  117. <param index="0" name="class_name" type="String" />
  118. <param index="1" name="function_name" type="String" />
  119. <description>
  120. </description>
  121. </method>
  122. <method name="_finish" qualifiers="virtual">
  123. <return type="void" />
  124. <description>
  125. </description>
  126. </method>
  127. <method name="_frame" qualifiers="virtual">
  128. <return type="void" />
  129. <description>
  130. </description>
  131. </method>
  132. <method name="_get_built_in_templates" qualifiers="virtual const">
  133. <return type="Dictionary[]" />
  134. <param index="0" name="object" type="StringName" />
  135. <description>
  136. </description>
  137. </method>
  138. <method name="_get_comment_delimiters" qualifiers="virtual const">
  139. <return type="PackedStringArray" />
  140. <description>
  141. </description>
  142. </method>
  143. <method name="_get_doc_comment_delimiters" qualifiers="virtual const">
  144. <return type="PackedStringArray" />
  145. <description>
  146. </description>
  147. </method>
  148. <method name="_get_extension" qualifiers="virtual const">
  149. <return type="String" />
  150. <description>
  151. </description>
  152. </method>
  153. <method name="_get_global_class_name" qualifiers="virtual const">
  154. <return type="Dictionary" />
  155. <param index="0" name="path" type="String" />
  156. <description>
  157. </description>
  158. </method>
  159. <method name="_get_name" qualifiers="virtual const">
  160. <return type="String" />
  161. <description>
  162. </description>
  163. </method>
  164. <method name="_get_public_annotations" qualifiers="virtual const">
  165. <return type="Dictionary[]" />
  166. <description>
  167. </description>
  168. </method>
  169. <method name="_get_public_constants" qualifiers="virtual const">
  170. <return type="Dictionary" />
  171. <description>
  172. </description>
  173. </method>
  174. <method name="_get_public_functions" qualifiers="virtual const">
  175. <return type="Dictionary[]" />
  176. <description>
  177. </description>
  178. </method>
  179. <method name="_get_recognized_extensions" qualifiers="virtual const">
  180. <return type="PackedStringArray" />
  181. <description>
  182. </description>
  183. </method>
  184. <method name="_get_reserved_words" qualifiers="virtual const">
  185. <return type="PackedStringArray" />
  186. <description>
  187. </description>
  188. </method>
  189. <method name="_get_string_delimiters" qualifiers="virtual const">
  190. <return type="PackedStringArray" />
  191. <description>
  192. </description>
  193. </method>
  194. <method name="_get_type" qualifiers="virtual const">
  195. <return type="String" />
  196. <description>
  197. </description>
  198. </method>
  199. <method name="_handles_global_class_type" qualifiers="virtual const">
  200. <return type="bool" />
  201. <param index="0" name="type" type="String" />
  202. <description>
  203. </description>
  204. </method>
  205. <method name="_has_named_classes" qualifiers="virtual const" is_deprecated="true">
  206. <return type="bool" />
  207. <description>
  208. [i]Deprecated.[/i] This method is not called by the engine.
  209. </description>
  210. </method>
  211. <method name="_init" qualifiers="virtual">
  212. <return type="void" />
  213. <description>
  214. </description>
  215. </method>
  216. <method name="_is_control_flow_keyword" qualifiers="virtual const">
  217. <return type="bool" />
  218. <param index="0" name="keyword" type="String" />
  219. <description>
  220. </description>
  221. </method>
  222. <method name="_is_using_templates" qualifiers="virtual">
  223. <return type="bool" />
  224. <description>
  225. </description>
  226. </method>
  227. <method name="_lookup_code" qualifiers="virtual const">
  228. <return type="Dictionary" />
  229. <param index="0" name="code" type="String" />
  230. <param index="1" name="symbol" type="String" />
  231. <param index="2" name="path" type="String" />
  232. <param index="3" name="owner" type="Object" />
  233. <description>
  234. </description>
  235. </method>
  236. <method name="_make_function" qualifiers="virtual const">
  237. <return type="String" />
  238. <param index="0" name="class_name" type="String" />
  239. <param index="1" name="function_name" type="String" />
  240. <param index="2" name="function_args" type="PackedStringArray" />
  241. <description>
  242. </description>
  243. </method>
  244. <method name="_make_template" qualifiers="virtual const">
  245. <return type="Script" />
  246. <param index="0" name="template" type="String" />
  247. <param index="1" name="class_name" type="String" />
  248. <param index="2" name="base_class_name" type="String" />
  249. <description>
  250. </description>
  251. </method>
  252. <method name="_open_in_external_editor" qualifiers="virtual">
  253. <return type="int" enum="Error" />
  254. <param index="0" name="script" type="Script" />
  255. <param index="1" name="line" type="int" />
  256. <param index="2" name="column" type="int" />
  257. <description>
  258. </description>
  259. </method>
  260. <method name="_overrides_external_editor" qualifiers="virtual">
  261. <return type="bool" />
  262. <description>
  263. </description>
  264. </method>
  265. <method name="_profiling_get_accumulated_data" qualifiers="virtual">
  266. <return type="int" />
  267. <param index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" />
  268. <param index="1" name="info_max" type="int" />
  269. <description>
  270. </description>
  271. </method>
  272. <method name="_profiling_get_frame_data" qualifiers="virtual">
  273. <return type="int" />
  274. <param index="0" name="info_array" type="ScriptLanguageExtensionProfilingInfo*" />
  275. <param index="1" name="info_max" type="int" />
  276. <description>
  277. </description>
  278. </method>
  279. <method name="_profiling_start" qualifiers="virtual">
  280. <return type="void" />
  281. <description>
  282. </description>
  283. </method>
  284. <method name="_profiling_stop" qualifiers="virtual">
  285. <return type="void" />
  286. <description>
  287. </description>
  288. </method>
  289. <method name="_reload_all_scripts" qualifiers="virtual">
  290. <return type="void" />
  291. <description>
  292. </description>
  293. </method>
  294. <method name="_reload_tool_script" qualifiers="virtual">
  295. <return type="void" />
  296. <param index="0" name="script" type="Script" />
  297. <param index="1" name="soft_reload" type="bool" />
  298. <description>
  299. </description>
  300. </method>
  301. <method name="_remove_named_global_constant" qualifiers="virtual">
  302. <return type="void" />
  303. <param index="0" name="name" type="StringName" />
  304. <description>
  305. </description>
  306. </method>
  307. <method name="_supports_builtin_mode" qualifiers="virtual const">
  308. <return type="bool" />
  309. <description>
  310. </description>
  311. </method>
  312. <method name="_supports_documentation" qualifiers="virtual const">
  313. <return type="bool" />
  314. <description>
  315. </description>
  316. </method>
  317. <method name="_thread_enter" qualifiers="virtual">
  318. <return type="void" />
  319. <description>
  320. </description>
  321. </method>
  322. <method name="_thread_exit" qualifiers="virtual">
  323. <return type="void" />
  324. <description>
  325. </description>
  326. </method>
  327. <method name="_validate" qualifiers="virtual const">
  328. <return type="Dictionary" />
  329. <param index="0" name="script" type="String" />
  330. <param index="1" name="path" type="String" />
  331. <param index="2" name="validate_functions" type="bool" />
  332. <param index="3" name="validate_errors" type="bool" />
  333. <param index="4" name="validate_warnings" type="bool" />
  334. <param index="5" name="validate_safe_lines" type="bool" />
  335. <description>
  336. </description>
  337. </method>
  338. <method name="_validate_path" qualifiers="virtual const">
  339. <return type="String" />
  340. <param index="0" name="path" type="String" />
  341. <description>
  342. </description>
  343. </method>
  344. </methods>
  345. <constants>
  346. <constant name="LOOKUP_RESULT_SCRIPT_LOCATION" value="0" enum="LookupResultType">
  347. </constant>
  348. <constant name="LOOKUP_RESULT_CLASS" value="1" enum="LookupResultType">
  349. </constant>
  350. <constant name="LOOKUP_RESULT_CLASS_CONSTANT" value="2" enum="LookupResultType">
  351. </constant>
  352. <constant name="LOOKUP_RESULT_CLASS_PROPERTY" value="3" enum="LookupResultType">
  353. </constant>
  354. <constant name="LOOKUP_RESULT_CLASS_METHOD" value="4" enum="LookupResultType">
  355. </constant>
  356. <constant name="LOOKUP_RESULT_CLASS_SIGNAL" value="5" enum="LookupResultType">
  357. </constant>
  358. <constant name="LOOKUP_RESULT_CLASS_ENUM" value="6" enum="LookupResultType">
  359. </constant>
  360. <constant name="LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE" value="7" enum="LookupResultType">
  361. </constant>
  362. <constant name="LOOKUP_RESULT_CLASS_ANNOTATION" value="8" enum="LookupResultType">
  363. </constant>
  364. <constant name="LOOKUP_RESULT_MAX" value="9" enum="LookupResultType">
  365. </constant>
  366. <constant name="LOCATION_LOCAL" value="0" enum="CodeCompletionLocation">
  367. The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes).
  368. </constant>
  369. <constant name="LOCATION_PARENT_MASK" value="256" enum="CodeCompletionLocation">
  370. 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 the class or a parent class.
  371. </constant>
  372. <constant name="LOCATION_OTHER_USER_CODE" value="512" enum="CodeCompletionLocation">
  373. The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).
  374. </constant>
  375. <constant name="LOCATION_OTHER" value="1024" enum="CodeCompletionLocation">
  376. The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.
  377. </constant>
  378. <constant name="CODE_COMPLETION_KIND_CLASS" value="0" enum="CodeCompletionKind">
  379. </constant>
  380. <constant name="CODE_COMPLETION_KIND_FUNCTION" value="1" enum="CodeCompletionKind">
  381. </constant>
  382. <constant name="CODE_COMPLETION_KIND_SIGNAL" value="2" enum="CodeCompletionKind">
  383. </constant>
  384. <constant name="CODE_COMPLETION_KIND_VARIABLE" value="3" enum="CodeCompletionKind">
  385. </constant>
  386. <constant name="CODE_COMPLETION_KIND_MEMBER" value="4" enum="CodeCompletionKind">
  387. </constant>
  388. <constant name="CODE_COMPLETION_KIND_ENUM" value="5" enum="CodeCompletionKind">
  389. </constant>
  390. <constant name="CODE_COMPLETION_KIND_CONSTANT" value="6" enum="CodeCompletionKind">
  391. </constant>
  392. <constant name="CODE_COMPLETION_KIND_NODE_PATH" value="7" enum="CodeCompletionKind">
  393. </constant>
  394. <constant name="CODE_COMPLETION_KIND_FILE_PATH" value="8" enum="CodeCompletionKind">
  395. </constant>
  396. <constant name="CODE_COMPLETION_KIND_PLAIN_TEXT" value="9" enum="CodeCompletionKind">
  397. </constant>
  398. <constant name="CODE_COMPLETION_KIND_MAX" value="10" enum="CodeCompletionKind">
  399. </constant>
  400. </constants>
  401. </class>