InputEventMouse

Documentation

Overview

Stores general information about mouse events.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsInputEvent() InputEvent.Instance
  • func (self *Extension[T]) AsInputEventFromWindow() InputEventFromWindow.Instance
  • func (self *Extension[T]) AsInputEventMouse() Instance
  • func (self *Extension[T]) AsInputEventWithModifiers() InputEventWithModifiers.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
  • func (self *Extension[T]) AsResource() Resource.Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsInputEvent() InputEvent.Instance
  • func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
  • func (self Instance) AsInputEventMouse() Instance
  • func (self Instance) AsInputEventWithModifiers() InputEventWithModifiers.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) ButtonMask() Input.MouseButtonMask
  • func (self Instance) GlobalPosition() Vector2.XY
  • func (self Instance) ID() ID
  • func (self Instance) Position() Vector2.XY
  • func (self Instance) SetButtonMask(value Input.MouseButtonMask)
  • func (self Instance) SetGlobalPosition(value Vector2.XY)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetPosition(value Vector2.XY)
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsInputEventMouse() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsInputEvent

func (self *Extension[T]) AsInputEvent() InputEvent.Instance

func (*Extension[T]) AsInputEventFromWindow

func (self *Extension[T]) AsInputEventFromWindow() InputEventFromWindow.Instance

func (*Extension[T]) AsInputEventMouse

func (self *Extension[T]) AsInputEventMouse() Instance

func (*Extension[T]) AsInputEventWithModifiers

func (self *Extension[T]) AsInputEventWithModifiers() InputEventWithModifiers.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.InputEventMouse

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsInputEvent

func (self Instance) AsInputEvent() InputEvent.Instance

func (Instance) AsInputEventFromWindow

func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance

func (Instance) AsInputEventMouse

func (self Instance) AsInputEventMouse() Instance

func (Instance) AsInputEventWithModifiers

func (self Instance) AsInputEventWithModifiers() InputEventWithModifiers.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) ButtonMask

func (self Instance) ButtonMask() Input.MouseButtonMask

The mouse button mask identifier, one of or a bitwise combination of the [MouseButton] button masks.

func (Instance) GlobalPosition

func (self Instance) GlobalPosition() Vector2.XY

When received in Node.Input or Node.UnhandledInput, returns the mouse's position in the root Viewport using the coordinate system of the root Viewport.

When received in Control.GuiInput, returns the mouse's position in the CanvasLayer that the Control is in using the coordinate system of the CanvasLayer.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Position

func (self Instance) Position() Vector2.XY

When received in Node.Input or Node.UnhandledInput, returns the mouse's position in the Viewport this Node is in using the coordinate system of this Viewport.

When received in Control.GuiInput, returns the mouse's position in the Control using the local coordinate system of the Control.

func (Instance) SetButtonMask

func (self Instance) SetButtonMask(value Input.MouseButtonMask)

SetButtonMask sets the property returned by [GetButtonMask].

func (Instance) SetGlobalPosition

func (self Instance) SetGlobalPosition(value Vector2.XY)

SetGlobalPosition sets the property returned by [GetGlobalPosition].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPosition

func (self Instance) SetPosition(value Vector2.XY)

SetPosition sets the property returned by [GetPosition].

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value