InputEventScreenDrag

Documentation

Overview

Stores information about screen drag events. See Node.Input.

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]) AsInputEventScreenDrag() 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) AsInputEventScreenDrag() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) ID() ID
  • func (self Instance) Index() int
  • func (self Instance) PenInverted() bool
  • func (self Instance) Position() Vector2.XY
  • func (self Instance) Pressure() Float.X
  • func (self Instance) Relative() Vector2.XY
  • func (self Instance) ScreenRelative() Vector2.XY
  • func (self Instance) ScreenVelocity() Vector2.XY
  • func (self Instance) SetIndex(value int)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetPenInverted(value bool)
  • func (self Instance) SetPosition(value Vector2.XY)
  • func (self Instance) SetPressure(value Float.X)
  • func (self Instance) SetRelative(value Vector2.XY)
  • func (self Instance) SetScreenRelative(value Vector2.XY)
  • func (self Instance) SetScreenVelocity(value Vector2.XY)
  • func (self Instance) SetTilt(value Vector2.XY)
  • func (self Instance) SetVelocity(value Vector2.XY)
  • func (self Instance) Tilt() Vector2.XY
  • func (self Instance) Velocity() 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
	AsInputEventScreenDrag() 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]) AsInputEventScreenDrag

func (self *Extension[T]) AsInputEventScreenDrag() 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.InputEventScreenDrag

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) AsInputEventScreenDrag

func (self Instance) AsInputEventScreenDrag() 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) ID

func (self Instance) ID() ID

func (Instance) Index

func (self Instance) Index() int

The drag event index in the case of a multi-drag event.

func (Instance) PenInverted

func (self Instance) PenInverted() bool

Returns true when using the eraser end of a stylus pen.

func (Instance) Position

func (self Instance) Position() Vector2.XY

The drag position in the viewport the node is in, using the coordinate system of this viewport.

func (Instance) Pressure

func (self Instance) Pressure() Float.X

Represents the pressure the user puts on the pen. Ranges from 0.0 to 1.0.

func (Instance) Relative

func (self Instance) Relative() Vector2.XY

The drag position relative to the previous position (position at the last frame).

Note: Relative is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using Relative in a script that handles touch aiming. To avoid this, use ScreenRelative instead.

func (Instance) ScreenRelative

func (self Instance) ScreenRelative() Vector2.XY

The unscaled drag position relative to the previous position in screen coordinates (position at the last frame). This position is not scaled according to the content scale factor or calls to InputEvent.XformedBy. This should be preferred over Relative for touch aiming regardless of the project's stretch mode.

func (Instance) ScreenVelocity

func (self Instance) ScreenVelocity() Vector2.XY

The unscaled drag velocity in pixels per second in screen coordinates. This velocity is not scaled according to the content scale factor or calls to InputEvent.XformedBy. This should be preferred over Velocity for touch aiming regardless of the project's stretch mode.

func (Instance) SetIndex

func (self Instance) SetIndex(value int)

SetIndex sets the property returned by [GetIndex].

func (*Instance) SetObject

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

func (Instance) SetPenInverted

func (self Instance) SetPenInverted(value bool)

SetPenInverted sets the property returned by [GetPenInverted].

func (Instance) SetPosition

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

SetPosition sets the property returned by [GetPosition].

func (Instance) SetPressure

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

SetPressure sets the property returned by [GetPressure].

func (Instance) SetRelative

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

SetRelative sets the property returned by [GetRelative].

func (Instance) SetScreenRelative

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

SetScreenRelative sets the property returned by [GetScreenRelative].

func (Instance) SetScreenVelocity

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

SetScreenVelocity sets the property returned by [GetScreenVelocity].

func (Instance) SetTilt

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

SetTilt sets the property returned by [GetTilt].

func (Instance) SetVelocity

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

SetVelocity sets the property returned by [GetVelocity].

func (Instance) Tilt

func (self Instance) Tilt() Vector2.XY

Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from -1.0 to 1.0 for both axes.

func (Instance) Velocity

func (self Instance) Velocity() Vector2.XY

The drag velocity.

Note: Velocity is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using Velocity in a script that handles touch aiming. To avoid this, use ScreenVelocity instead.

func (Instance) Virtual

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