2
0

ScriptEditorBase.xml 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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">
  13. <return type="void" />
  14. <argument index="0" name="highlighter" type="EditorSyntaxHighlighter" />
  15. <description>
  16. Adds a [EditorSyntaxHighlighter] to the open script.
  17. </description>
  18. </method>
  19. <method name="get_base_editor" qualifiers="const">
  20. <return type="Control" />
  21. <description>
  22. Returns the underlying [Control] used for editing scripts. This can be either [CodeEdit] (for text scripts) or [GraphEdit] (for visual scripts).
  23. </description>
  24. </method>
  25. </methods>
  26. <signals>
  27. <signal name="edited_script_changed">
  28. <description>
  29. Emitted after script validation. For visual scripts on modification.
  30. </description>
  31. </signal>
  32. <signal name="go_to_help">
  33. <argument index="0" name="what" type="String" />
  34. <description>
  35. Emitted when the user requests a specific documentation page.
  36. </description>
  37. </signal>
  38. <signal name="name_changed">
  39. <description>
  40. Emitted after script validation or when the edited resource has changed. Not used by visual scripts.
  41. </description>
  42. </signal>
  43. <signal name="replace_in_files_requested">
  44. <argument index="0" name="text" type="String" />
  45. <description>
  46. Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
  47. </description>
  48. </signal>
  49. <signal name="request_help">
  50. <argument index="0" name="topic" type="String" />
  51. <description>
  52. Emitted when the user requests contextual help.
  53. </description>
  54. </signal>
  55. <signal name="request_open_script_at_line">
  56. <argument index="0" name="script" type="Object" />
  57. <argument index="1" name="line" type="int" />
  58. <description>
  59. Emitted when the user requests a script.
  60. </description>
  61. </signal>
  62. <signal name="request_save_history">
  63. <description>
  64. Emitted when the user contextual goto and the item is in the same script.
  65. </description>
  66. </signal>
  67. <signal name="search_in_files_requested">
  68. <argument index="0" name="text" type="String" />
  69. <description>
  70. Emitted when the user request to search text in the file system. Not used by visual scripts.
  71. </description>
  72. </signal>
  73. </signals>
  74. </class>