ScriptEditorBase.xml 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="ScriptEditorBase" inherits="VBoxContainer" version="4.0">
  3. <brief_description>
  4. Base editor for editing scripts in the [ScriptEditor].
  5. </brief_description>
  6. <description>
  7. Base editor for editing scripts in the [ScriptEditor], this does not include documentation items.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="add_syntax_highlighter" qualifiers="virtual">
  13. <return type="void">
  14. </return>
  15. <argument index="0" name="highlighter" type="Object">
  16. </argument>
  17. <description>
  18. Adds a [EditorSyntaxHighlighter] to the open script.
  19. </description>
  20. </method>
  21. <method name="get_base_editor" qualifiers="const">
  22. <return type="Control">
  23. </return>
  24. <description>
  25. Returns the underlying [Control] used for editing scripts. This can be either [CodeEdit] (for text scripts) or [GraphEdit] (for visual scripts).
  26. </description>
  27. </method>
  28. </methods>
  29. <signals>
  30. <signal name="edited_script_changed">
  31. <description>
  32. Emitted after script validation. For visual scripts on modification.
  33. </description>
  34. </signal>
  35. <signal name="go_to_help">
  36. <argument index="0" name="what" type="String">
  37. </argument>
  38. <description>
  39. Emitted when the user requests a specific documentation page.
  40. </description>
  41. </signal>
  42. <signal name="name_changed">
  43. <description>
  44. Emitted after script validation or when the edited resource has changed. Not used by visual scripts.
  45. </description>
  46. </signal>
  47. <signal name="replace_in_files_requested">
  48. <argument index="0" name="text" type="String">
  49. </argument>
  50. <description>
  51. Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
  52. </description>
  53. </signal>
  54. <signal name="request_help">
  55. <argument index="0" name="topic" type="String">
  56. </argument>
  57. <description>
  58. Emitted when the user requests contextual help.
  59. </description>
  60. </signal>
  61. <signal name="request_open_script_at_line">
  62. <argument index="0" name="script" type="Object">
  63. </argument>
  64. <argument index="1" name="line" type="int">
  65. </argument>
  66. <description>
  67. Emitted when the user requests a script.
  68. </description>
  69. </signal>
  70. <signal name="request_save_history">
  71. <description>
  72. Emitted when the user contextual goto and the item is in the same script.
  73. </description>
  74. </signal>
  75. <signal name="search_in_files_requested">
  76. <argument index="0" name="text" type="String">
  77. </argument>
  78. <description>
  79. Emitted when the user request to search text in the file system. Not used by visual scripts.
  80. </description>
  81. </signal>
  82. </signals>
  83. <constants>
  84. </constants>
  85. </class>