Click or drag to resize

EditorPluginForwardCanvasGuiInput Method

Called when there is a root node in the current edited scene, Handles(Object) is implemented and an InputEvent happens in the 2D viewport. Intercepts the InputEvent, if return trueEditorPlugin consumes the event, otherwise forwards event to other Editor classes. Example:

Copy
# Prevents the InputEvent to reach other Editor classes
func forward_canvas_gui_input(event):
    var forward = true
    return forward

Must return false in order to forward the InputEvent to other Editor classes. Example:

Copy
# Consumes InputEventMouseMotion and forwards other InputEvent types
func forward_canvas_gui_input(event):
    var forward = false
    if event is InputEventMouseMotion:
        forward = true
    return forward

Namespace:  Godot
Assembly:  GodotSharpEditor (in GodotSharpEditor.dll) Version: 1.0.0
Syntax
C#
Copy
public virtual bool ForwardCanvasGuiInput(
	InputEvent event
)

Parameters

event
Type: GodotInputEvent

[Missing <param name="event"/> documentation for "M:Godot.EditorPlugin.ForwardCanvasGuiInput(Godot.InputEvent)"]

Return Value

Type: Boolean

[Missing <returns> documentation for "M:Godot.EditorPlugin.ForwardCanvasGuiInput(Godot.InputEvent)"]

See Also