ScriptEditorBase.xml 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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. </methods>
  22. <signals>
  23. <signal name="edited_script_changed">
  24. <description>
  25. Emitted after script validation. For visual scripts on modification.
  26. </description>
  27. </signal>
  28. <signal name="go_to_help">
  29. <argument index="0" name="what" type="String">
  30. </argument>
  31. <description>
  32. Emitted when the user requests a specific documentation page.
  33. </description>
  34. </signal>
  35. <signal name="name_changed">
  36. <description>
  37. Emitted after script validation or when the edited resource has changed. Not used by visual scripts.
  38. </description>
  39. </signal>
  40. <signal name="replace_in_files_requested">
  41. <argument index="0" name="text" type="String">
  42. </argument>
  43. <description>
  44. Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
  45. </description>
  46. </signal>
  47. <signal name="request_help">
  48. <argument index="0" name="topic" type="String">
  49. </argument>
  50. <description>
  51. Emitted when the user requests contextual help.
  52. </description>
  53. </signal>
  54. <signal name="request_open_script_at_line">
  55. <argument index="0" name="script" type="Object">
  56. </argument>
  57. <argument index="1" name="line" type="int">
  58. </argument>
  59. <description>
  60. Emitted when the user requests a script.
  61. </description>
  62. </signal>
  63. <signal name="request_save_history">
  64. <description>
  65. Emitted when the user contextual goto and the item is in the same script.
  66. </description>
  67. </signal>
  68. <signal name="search_in_files_requested">
  69. <argument index="0" name="text" type="String">
  70. </argument>
  71. <description>
  72. Emitted when the user request to search text in the file system. Not used by visual scripts.
  73. </description>
  74. </signal>
  75. </signals>
  76. <constants>
  77. </constants>
  78. </class>