getDragInput :function

function getDragInput(Scope: Scope): (props: DragInputProperties) -> (Value<Vector2>, Computed<Vector2>, Value<boolean>)

Initializes the utility component and returns a new function to create values from that component, which are used to get dragging input from a certain area on the screen.

Default Syntax

local getDragInputUtility = require(StudioComponents.Util.getDragInput)
local getDragInput = getDragInputUtility(Scope)

Shorthand

local getDragInput = require(StudioComponents.Util.getDragInput)(Scope)

---

Parameters

Scope: Scope

The Scope the utility function will be initialized in.

Returns Function

Parameters

props: DragInputProperties

The table which contains the properties of the component that will be created.

Returns

(Value<Vector2>, Computed<Vector2>, Value<boolean>)