Accueil Explorer Aide
Connexion
Godot
/
godot-docs
miroir de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: 2f06d055e3
Branches Tags
godot-docs
/
classes
/
class_editorplugin.rst

class_editorplugin.rst 11 KB
Historique Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126 
  1. .. _class_EditorPlugin:
    2. 

  2. 

  3. EditorPlugin
    4. 

  4. ============
    5. 

  5. 

  6. **Inherits:** :ref:`Node<class_node>`
    7. 

  7. 

  8. **Category:** Core
    9. 

  9. 

  10. 

  11. 

  12. Member Functions
    13. 

  13. ----------------
    14. 

  14. 

  15. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    16. 

  16. | void                                   | :ref:`apply_changes<class_EditorPlugin_apply_changes>`  **(** **)** virtual                                                                                                                                         |
    17. 

  17. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    18. 

  18. | void                                   | :ref:`clear<class_EditorPlugin_clear>`  **(** **)** virtual                                                                                                                                                         |
    19. 

  19. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    20. 

  20. | void                                   | :ref:`edit<class_EditorPlugin_edit>`  **(** :ref:`Object<class_object>` object  **)** virtual                                                                                                                       |
    21. 

  21. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | :ref:`bool<class_bool>`                | :ref:`forward_input_event<class_EditorPlugin_forward_input_event>`  **(** :ref:`InputEvent<class_inputevent>` event  **)** virtual                                                                                  |
    23. 

  23. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`bool<class_bool>`                | :ref:`forward_spatial_input_event<class_EditorPlugin_forward_spatial_input_event>`  **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event  **)** virtual                              |
    25. 

  25. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`StringArray<class_stringarray>`  | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>`  **(** **)** virtual                                                                                                                                     |
    27. 

  27. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`String<class_string>`            | :ref:`get_name<class_EditorPlugin_get_name>`  **(** **)** virtual                                                                                                                                                   |
    29. 

  29. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`Dictionary<class_dictionary>`    | :ref:`get_state<class_EditorPlugin_get_state>`  **(** **)** virtual                                                                                                                                                 |
    31. 

  31. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`bool<class_bool>`                | :ref:`handles<class_EditorPlugin_handles>`  **(** :ref:`Object<class_object>` object  **)** virtual                                                                                                                 |
    33. 

  33. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`bool<class_bool>`                | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>`  **(** **)** virtual                                                                                                                                     |
    35. 

  35. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | void                                   | :ref:`make_visible<class_EditorPlugin_make_visible>`  **(** :ref:`bool<class_bool>` visible  **)** virtual                                                                                                          |
    37. 

  37. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                                   | :ref:`set_state<class_EditorPlugin_set_state>`  **(** :ref:`Dictionary<class_dictionary>` state  **)** virtual                                                                                                      |
    39. 

  39. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Object<class_object>`            | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>`  **(** **)**                                                                                                                                                 |
    41. 

  41. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                                   | :ref:`add_custom_control<class_EditorPlugin_add_custom_control>`  **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control  **)**                                                                 |
    43. 

  43. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                                   | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>`  **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon  **)** |
    45. 

  45. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                                   | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>`  **(** :ref:`String<class_string>` type  **)**                                                                                                     |
    47. 

  47. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. 

  49. Numeric Constants
    50. 

  50. -----------------
    51. 

  51. 

  52. - **CONTAINER_TOOLBAR** = **0**
    53. 

  53. - **CONTAINER_SPATIAL_EDITOR_MENU** = **1**
    54. 

  54. - **CONTAINER_SPATIAL_EDITOR_SIDE** = **2**
    55. 

  55. - **CONTAINER_SPATIAL_EDITOR_BOTTOM** = **3**
    56. 

  56. - **CONTAINER_CANVAS_EDITOR_MENU** = **4**
    57. 

  57. - **CONTAINER_CANVAS_EDITOR_SIDE** = **5**
    58. 

  58. 

  59. Member Function Description
    60. 

  60. ---------------------------
    61. 

  61. 

  62. .. _class_EditorPlugin_apply_changes:
    63. 

  63. 

  64. - void  **apply_changes**  **(** **)** virtual
    65. 

  65. 

  66. .. _class_EditorPlugin_clear:
    67. 

  67. 

  68. - void  **clear**  **(** **)** virtual
    69. 

  69. 

  70. .. _class_EditorPlugin_edit:
    71. 

  71. 

  72. - void  **edit**  **(** :ref:`Object<class_object>` object  **)** virtual
    73. 

  73. 

  74. .. _class_EditorPlugin_forward_input_event:
    75. 

  75. 

  76. - :ref:`bool<class_bool>`  **forward_input_event**  **(** :ref:`InputEvent<class_inputevent>` event  **)** virtual
    77. 

  77. 

  78. .. _class_EditorPlugin_forward_spatial_input_event:
    79. 

  79. 

  80. - :ref:`bool<class_bool>`  **forward_spatial_input_event**  **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event  **)** virtual
    81. 

  81. 

  82. .. _class_EditorPlugin_get_breakpoints:
    83. 

  83. 

  84. - :ref:`StringArray<class_stringarray>`  **get_breakpoints**  **(** **)** virtual
    85. 

  85. 

  86. .. _class_EditorPlugin_get_name:
    87. 

  87. 

  88. - :ref:`String<class_string>`  **get_name**  **(** **)** virtual
    89. 

  89. 

  90. .. _class_EditorPlugin_get_state:
    91. 

  91. 

  92. - :ref:`Dictionary<class_dictionary>`  **get_state**  **(** **)** virtual
    93. 

  93. 

  94. .. _class_EditorPlugin_handles:
    95. 

  95. 

  96. - :ref:`bool<class_bool>`  **handles**  **(** :ref:`Object<class_object>` object  **)** virtual
    97. 

  97. 

  98. .. _class_EditorPlugin_has_main_screen:
    99. 

  99. 

  100. - :ref:`bool<class_bool>`  **has_main_screen**  **(** **)** virtual
    101. 

  101. 

  102. .. _class_EditorPlugin_make_visible:
    103. 

  103. 

  104. - void  **make_visible**  **(** :ref:`bool<class_bool>` visible  **)** virtual
    105. 

  105. 

  106. .. _class_EditorPlugin_set_state:
    107. 

  107. 

  108. - void  **set_state**  **(** :ref:`Dictionary<class_dictionary>` state  **)** virtual
    109. 

  109. 

  110. .. _class_EditorPlugin_get_undo_redo:
    111. 

  111. 

  112. - :ref:`Object<class_object>`  **get_undo_redo**  **(** **)**
    113. 

  113. 

  114. .. _class_EditorPlugin_add_custom_control:
    115. 

  115. 

  116. - void  **add_custom_control**  **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control  **)**
    117. 

  117. 

  118. .. _class_EditorPlugin_add_custom_type:
    119. 

  119. 

  120. - void  **add_custom_type**  **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon  **)**
    121. 

  121. 

  122. .. _class_EditorPlugin_remove_custom_type:
    123. 

  123. 

  124. - void  **remove_custom_type**  **(** :ref:`String<class_string>` type  **)**
    125. 

  125. 

  126.