Documentation
¶
Overview ¶
Stores information about mouse click events. See Node.Input.
Note: On Wear OS devices, rotary input is mapped to [MouseButtonWheelUp] and [MouseButtonWheelDown]. This can be changed to [MouseButtonWheelLeft] and [MouseButtonWheelRight] with the ProjectSettings "input_devices/pointing/android/rotary_input_scroll_axis" setting.
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() InputEventMouse.Instance
- func (self *Extension[T]) AsInputEventMouseButton() 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
- type 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() Input.MouseButton
- func (self Instance) DoubleClick() bool
- func (self Instance) Factor() Float.X
- func (self Instance) ID() ID
- func (self Instance) SetButtonIndex(value Input.MouseButton)
- func (self Instance) SetCanceled(value bool)
- func (self Instance) SetDoubleClick(value bool)
- func (self Instance) SetFactor(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPressed(value bool)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
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() InputEventMouse.Instance
func (*Extension[T]) AsInputEventMouseButton ¶
func (*Extension[T]) AsInputEventWithModifiers ¶
func (self *Extension[T]) AsInputEventWithModifiers() InputEventWithModifiers.Instance
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type 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.
type Instance ¶
type Instance [1]gdclass.InputEventMouseButton
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 (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 (Instance) AsInputEventWithModifiers ¶
func (self Instance) AsInputEventWithModifiers() InputEventWithModifiers.Instance
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) ButtonIndex ¶
func (self Instance) ButtonIndex() Input.MouseButton
The mouse button identifier, one of the [MouseButton] button or button wheel constants.
func (Instance) DoubleClick ¶
If true, the mouse button's state is a double-click.
func (Instance) Factor ¶
The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be 0 if not supported.
func (Instance) SetButtonIndex ¶
func (self Instance) SetButtonIndex(value Input.MouseButton)
SetButtonIndex sets the property returned by [GetButtonIndex].
func (Instance) SetCanceled ¶
If true, the mouse button event has been canceled.
func (Instance) SetDoubleClick ¶
SetDoubleClick sets the property returned by [IsDoubleClick].
func (Instance) SetPressed ¶
If true, the mouse button's state is pressed. If false, the mouse button's state is released.
Source Files