asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #43433 from HaSa1002/docs-examples-43356

Browse source 
[Docs] Add C# example for EditorPlugin::forward_canvas_draw_over_viewport
This commit is contained in:
Rémi Verschelde 2020-11-10 10:43:37 +01:00 committed by GitHub
commit cb5d5ff413
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/classes/EditorPlugin.xml
View file

@ -211,7 +211,8 @@
</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]
[codeblocks]
[gdscript]
func forward_canvas_draw_over_viewport(overlay):
# Draw a circle at cursor position.
overlay.draw_circle(overlay.get_local_mouse_position(), 64)
@ -220,7 +221,27 @@
if event is InputEventMouseMotion:
# Redraw viewport when cursor is moved.
update_overlays()
[/codeblock]
return true
return false
[/gdscript]
[csharp]
public override void ForwardCanvasDrawOverViewport(Godot.Control overlay)
{
// Draw a circle at cursor position.
overlay.DrawCircle(overlay.GetLocalMousePosition(), 64, Colors.White);
}
public override bool ForwardCanvasGuiInput(InputEvent @event)
{
if (@event is InputEventMouseMotion)
{
// Redraw viewport when cursor is moved.
UpdateOverlays();
return true;
}
return false;
[/csharp]
[/codeblocks]
</description>
</method>
<method name="forward_canvas_force_draw_over_viewport" qualifiers="virtual">