diff options
| author | Tomasz Chabora <kobewi4e@gmail.com> | 2020-11-06 13:24:51 +0100 |
|---|---|---|
| committer | Tomasz Chabora <kobewi4e@gmail.com> | 2020-11-06 16:42:40 +0100 |
| commit | 5d8b60ac3d3c6df22f4d29642c4139b51bd22e81 (patch) | |
| tree | d378f99bae77438f8676f17ad8284b32ef94b142 /doc/classes | |
| parent | df2abc55be9c8b9f419a1b99cbad94024d150a09 (diff) | |
Add docs for editor viewport drawing methods
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/EditorPlugin.xml | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 95d88e86a6..77045345f6 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -210,6 +210,17 @@ <argument index="0" name="overlay" type="Control"> </argument> <description> + Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. + [codeblock] + func forward_canvas_draw_over_viewport(overlay): + # Draw a circle at cursor position. + overlay.draw_circle(overlay.get_local_mouse_position(), 64) + + func forward_canvas_gui_input(event): + if event is InputEventMouseMotion: + # Redraw viewport when cursor is moved. + update_overlays() + [/codeblock] </description> </method> <method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual"> @@ -218,6 +229,8 @@ <argument index="0" name="overlay" type="Control"> </argument> <description> + This method is the same as [method forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. + You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. </description> </method> <method name="forward_canvas_gui_input" qualifiers="virtual"> @@ -511,6 +524,7 @@ <return type="void"> </return> <description> + Enables calling of [method forward_canvas_force_draw_over_viewport] when the 2D editor's viewport is updated. You need to call this method only once and it will work permanently for this plugin. </description> </method> <method name="set_input_event_forwarding_always_enabled"> @@ -542,7 +556,7 @@ <return type="int"> </return> <description> - Updates the overlays of the editor (2D/3D) viewport. + Updates the overlays of the 2D and 3D editor viewport. Causes [method forward_canvas_draw_over_viewport] and [method forward_canvas_force_draw_over_viewport] to be called. </description> </method> </methods> |