DragDetector

Sets the cursor icon to display when the mouse is activated over the parent of this DragDetector. If this property is left blank, the detector will use the default icon.

To change the activated cursor icon, set this property to the asset ID of the image you'd like to use.

When false (default), constraint force is applied at the point the user clicks on. When true, force is applied at the object's center of mass. Only relevant if ResponseStyle is Physical and the parent object is unanchored.

The primary axis of motion, expressed relative to the reference frame. For a DragStyle of TranslateLine, the direction of translation; for TranslatePlane, the normal to the plane of motion; for RotateAxis, the axis of 1D rotation. Changing this value automatically updates Orientation and vice versa.

If ReferenceInstance is set, the CFrame of the pivot relative to the reference frame; otherwise, the CFrame of the pivot relative to its frame at the beginning of the drag.

The paradigm used to generate proposed motion, given a stream of cursor rays. See Enum.DragDetectorDragStyle for options.

If true, the DragDetector responds to user input; if false, it does not.

During gamepad input, the Enum.KeyCode for toggling the secondary mode of motion. Only applies if the drag detector's DragStyle has both primary and secondary modes of motion.

During keyboard input, the Enum.KeyCode for toggling the secondary mode of motion. Only applies if the drag detector's DragStyle has both primary and secondary modes of motion.

If this is greater than MinDragAngle, translation will be clamped within that range. This is not a constraint; it merely impedes the drag detector's attempts to generate motion in order to remain within limits. Only relevant if DragStyle is RotateAxis.

In any dimension, if this is greater than MinDragTranslation, translation will be clamped within that range. This is not a constraint; it merely impedes the drag detector's attempts to generate motion in order to remain within limits.

Maximum force applied for the object to reach its goal. Only relevant if ResponseStyle is Physical and the parent object is unanchored.

Maximum torque applied for the object to reach its goal. Only relevant if ResponseStyle is Physical and the parent object is unanchored.

If this is less than MaxDragAngle, translation will be clamped within that range. This is not a constraint; it merely impedes the drag detector's attempts to generate motion in order to remain within limits. Only relevant if DragStyle is RotateAxis.

In any dimension, if this is less than MaxDragTranslation, translation will be clamped within that range. This is not a constraint; it merely impedes the drag detector's attempts to generate motion in order to remain within limits.

Specifies the YXZ rotation of axes of motion relative to the reference frame (does not change the orientation of the reference frame itself). Linear translation and axial rotation will be on this reoriented Y axis, and planar translation in the XZ plane. Changing this value automatically updates Axis and vice versa.

Controls the permission level for which players can interact with the DragDetector. Default is Enum.DragDetectorPermissionPolicy.Everybody.

An instance whose CFrame is the reference frame for the drag detector. The DragFrame is expressed relative to this CFrame which may be retrieved via the GetReferenceFrame() method.

If this instance is a PVInstance, the reference frame will be its pivot; if an Attachment, then its world CFrame. If it is nil or neither of the former, the reference frame will be based on the pivot of the drag detector's parent BasePart or Model.

Once the proposed motion has been computed and potentially constrained, this is the paradigm used to move, or not move, the objects affected by the DragDetector. See Enum.DragDetectorResponseStyle for options.

Higher values cause the object to reach its goal more rapidly. Only relevant if ResponseStyle is Physical and the parent object is unanchored.

If false (default), the client sends replicated signals (DragStart, DragContinue, DragEnd) to the server which processes cursor rays, makes changes to the data model, and replicates them onwards to clients.

If true, the client processes those signals itself and does not replicate them to the server. Client LocalScripts may be used to respond to these events and RemoteEvents may be used to send any resulting changes that should be replicated to the server.

The secondary axis of the motion. Relates to orientation using the same paradigm as Attachments.

When the cursor is outside the trackball, the DragDetector can apply a radial pull rotation that turns the ball as if it were trying to roll out toward the cursor. This property is a 0 to 1 multiplier for adding that rotation as a contribution to the total. Only relevant if DragStyle is RotateTrackball.

When the cursor is outside the trackball, the DragDetector can apply a roll rotation that turns the ball as if it were mounted on a vinyl record facing the viewer. This property is a 0 to 1 multiplier for adding that roll rotation to the total. Only relevant if DragStyle is RotateTrackball.

During VR input, the Enum.KeyCode for toggling the secondary mode of motion. Only applies if the drag detector's DragStyle has both primary and secondary modes of motion.

The Axis expressed in world space. Relates to orientation using the same paradigm as Attachments.

The SecondaryAxis expressed in world space. Relates to orientation using the same paradigm as Attachments.

Adds a function to modify or constrain proposed motion. The function takes an input CFrame of proposed motion and returns a CFrame of modified or unmodified motion. Both the input and output are expressed relative to the reference frame. You can add multiple functions which will be called in order by priority, passing the results along in a chain.

To remove the added constraint function, call Disconnect() on the returned connection object.

Paramètres

Retours

Returns the reference CFrame in which motion is expressed; see the ReferenceInstance property for more details.

Retours

May be invoked from a script to restart the drag using new parameters, if parameters such as DragStyle, Axis, or SecondaryAxis change.

Retours

Passes a function to be used if and only if DragStyle is set to Scriptable. The given function is called when responding to a DragContinue signal, it receives the signal's world space cursor ray with type Ray, and it returns a CFrame containing the desired location and orientation of the pivot in world space.

If the function returns nil, the object will not be moved. This is useful if the script has not yet collected all the information it needs to give the correct answer, or in temporary cases where you want the object to stay where it is.

Paramètres

Retours

Passes a function to be used if and only if PermissionPolicy is set to Enum.DragDetectorPermissionPolicy.Scriptable. The given function accepts a Player parameter for enabling/disabling the detector for a specific player. It also receives a part parameter indicating which specific BasePart was clicked, such as one part within a draggable Model; this is useful for enabling/disabling the detector based on that part's Name, Color, HasTag() value, or other details.

local dragDetector = script.Parent.DragDetector
dragDetector.PermissionPolicy = Enum.DragDetectorPermissionPolicy.Scriptable

dragDetector:SetPermissionPolicyFunction(function(player, part)
	if player and player:GetAttribute("IsInTurn") then
		return true
	elseif part and not part:GetAttribute("IsDraggable") then
		return false
	else
		return true
	end
end)

Paramètres

Retours

Fires when a user continues dragging the object after DragStart has been initiated.

Paramètres

Fires when a user stops dragging the object.

Paramètres

Fires when a user starts dragging the object.

Paramètres