InputEventMouseButton

Documentation

Overview

Package InputEventMouseButton provides methods for working with InputEventMouseButton object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsInputEvent() InputEvent.Instance
  • func (self Instance) AsInputEventFromWindow() InputEventFromWindow.Instance
  • func (self Instance) AsInputEventMouse() InputEventMouse.Instance
  • func (self Instance) AsInputEventMouseButton() 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) ButtonIndex() MouseButton
  • func (self Instance) DoubleClick() bool
  • func (self Instance) Factor() Float.X
  • func (self Instance) SetButtonIndex(value MouseButton)
  • func (self Instance) SetCanceled(value bool)
  • func (self Instance) SetDoubleClick(value bool)
  • func (self Instance) SetFactor(value Float.X)
  • func (self Instance) SetPressed(value bool)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type MouseButton

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
	AsInputEventMouseButton() Instance
}

type Instance

type Instance [1]gdclass.InputEventMouseButton

Stores information about mouse click events. See [method Node._input]. [b]Note:[/b] On Wear OS devices, rotary input is mapped to [constant MOUSE_BUTTON_WHEEL_UP] and [constant MOUSE_BUTTON_WHEEL_DOWN]. This can be changed to [constant MOUSE_BUTTON_WHEEL_LEFT] and [constant MOUSE_BUTTON_WHEEL_RIGHT] with the [member ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis] setting.

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() InputEventMouse.Instance

func (Instance) AsInputEventMouseButton

func (self Instance) AsInputEventMouseButton() 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) ButtonIndex

func (self Instance) ButtonIndex() MouseButton

func (Instance) DoubleClick

func (self Instance) DoubleClick() bool

func (Instance) Factor

func (self Instance) Factor() Float.X

func (Instance) SetButtonIndex

func (self Instance) SetButtonIndex(value MouseButton)

func (Instance) SetCanceled

func (self Instance) SetCanceled(value bool)

func (Instance) SetDoubleClick

func (self Instance) SetDoubleClick(value bool)

func (Instance) SetFactor

func (self Instance) SetFactor(value Float.X)

func (Instance) SetPressed

func (self Instance) SetPressed(value bool)

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type MouseButton

type MouseButton int

const (
	/*Enum value which doesn't correspond to any mouse button. This is used to initialize [enum MouseButton] properties with a generic state.*/
	MouseButtonNone MouseButton = 0
	/*Primary mouse button, usually assigned to the left button.*/
	MouseButtonLeft MouseButton = 1
	/*Secondary mouse button, usually assigned to the right button.*/
	MouseButtonRight MouseButton = 2
	/*Middle mouse button.*/
	MouseButtonMiddle MouseButton = 3
	/*Mouse wheel scrolling up.*/
	MouseButtonWheelUp MouseButton = 4
	/*Mouse wheel scrolling down.*/
	MouseButtonWheelDown MouseButton = 5
	/*Mouse wheel left button (only present on some mice).*/
	MouseButtonWheelLeft MouseButton = 6
	/*Mouse wheel right button (only present on some mice).*/
	MouseButtonWheelRight MouseButton = 7
	/*Extra mouse button 1. This is sometimes present, usually to the sides of the mouse.*/
	MouseButtonXbutton1 MouseButton = 8
	/*Extra mouse button 2. This is sometimes present, usually to the sides of the mouse.*/
	MouseButtonXbutton2 MouseButton = 9
)