Roblox UtilitiesDevlHub Roblox Documentation

Class

ClickDetector

Inherits
Instance › Object
Memory category
Instances
Subclasses
1

An object that provides user input on in-experience BaseParts and Models.

ClickDetector allows Scripts and LocalScripts to receive pointer input on 3D objects through their MouseClick event. They work when parented to BasePart, Model, or Folder objects. They detect basic mouse events: enter, leave, left click and right click. Touch input on TouchEnabled devices also fires click events.

The default control scripts bind ButtonR2 to interact with ClickDetectors using ContextActionService:BindActivate(), which can also be used to override this. When using gamepads, the center dot triggers MouseHoverEnter and MouseHoverLeave. The bound activation button fires MouseClick.

MaxActivationDistance can be used to limit the distance a player may be from a click detector before it is no longer clickable.

ClickDetector events fire on both the client and the server. Since a LocalScript will only run if it descends from a Player or player Character, it's usually not useful to put a LocalScript inside a ClickDetector, since the script won't run or the object won't be clickable. If you need a LocalScript to detect ClickDetector events, StarterPlayerScripts may be a better place instead.

Input Priority#

If multiple ClickDetectors may detect user input, only the deepest will fire events. If two ClickDetectors are siblings, the first will take priority.

If an action bound with ContextActionService uses the same input as a ClickDetector, the action bound with ContextActionService will take priority over the click detector's events.

UserInputService.InputBegan will fire before ClickDetector events.

Properties 3#

CursorIconContentIdSets the cursor icon to display when the mouse is hovered over the parent of this ClickDetector or DragDetector.ReadSafe
CursorIconContentContentSets the cursor icon to display when the mouse is hovered over the parent of this ClickDetector or DragDetector. Only supports asset URIs.ReadSafe
MaxActivationDistancefloatMaximum distance between a character and the ClickDetector or DragDetector for the player to be able to interact with it.ReadSafe

CursorIcon: ContentId#

ReadSafe

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

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

CursorIconContent: Content#

ReadSafe

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

To change the cursor icon, set this property to the asset ID of the image you'd like to use. Only asset URIs are supported for this property.

MaxActivationDistance: float#

ReadSafe

This property controls the maximum distance, in studs, between a Character and the ClickDetector or DragDetector for the player to be able to interact with it. For instance, a character within 10 studs of a ClickDetector or DragDetector with a max activation distance of 5 would not be able to use the detector because they are out of range.

Events 5#

MouseClickFires when a player interacts with the parent of a ClickDetector or DragDetector.
mouseClickDeprecated
MouseHoverEnterFires when the parent of a ClickDetector or DragDetector is hovered over by a player.
MouseHoverLeaveFires when a player's cursor hovers off the parent of a ClickDetector or DragDetector.
RightMouseClickFires when a player right clicks their mouse cursor on a ClickDetector or DragDetector.

MouseClick(playerWhoClicked: Player)#

This event fires from either a Script or LocalScript when a player interacts with a ClickDetector or DragDetector via the following inputs:

  • On platforms with a mouse, when the player left mouse clicks.
  • On TouchEnabled platforms, when the player taps.
  • On GamepadEnabled platforms, when the center dot is over the same model and the A button is pressed and released.

Note that the player's Character must be within the MaxActivationDistance of the detector.

NameTypeDefaultDescription
playerWhoClickedPlayerThe Player who clicked on the parent of a ClickDetector or DragDetector.

mouseClick(playerWhoClicked: Player)#

DeprecatedDeprecated

Deprecated. This deprecated event is a variant of ClickDetector.MouseClick, which should be used instead.

NameTypeDefaultDescription
playerWhoClickedPlayer

MouseHoverEnter(playerWhoHovered: Player)#

This event fires from either a Script or LocalScript when the parent of a ClickDetector or DragDetector is hovered over by a player. This does not entail explicit interaction with the detector, for which you can listen to either MouseClick and RightMouseClick events.

Due to the nature of user input, you should not depend on all MouseHoverEnter events firing a corresponding MouseHoverLeave event.

NameTypeDefaultDescription
playerWhoHoveredPlayerThe Player who started hovering over the parent of a ClickDetector or DragDetector.

MouseHoverLeave(playerWhoHovered: Player)#

This event fires from either a Script or LocalScript when a player's cursor hovers off the parent of a ClickDetector or DragDetector. This does not entail explicit interaction with the detector, for which you can listen to either MouseClick and RightMouseClick events.

Due to the nature of user input, you should not depend on all MouseHoverLeave events firing after a corresponding MouseHoverEnter event.

NameTypeDefaultDescription
playerWhoHoveredPlayerThe Player whose cursor hovered off the parent of a ClickDetector or DragDetector.

RightMouseClick(playerWhoClicked: Player)#

This event fires from either a Script or LocalScript when a player right clicks their mouse cursor on a ClickDetector or DragDetector. Note that the player's Character must be within the MaxActivationDistance of the detector.

NameTypeDefaultDescription
playerWhoClickedPlayerThe Player who right clicked their mouse cursor on the parent of a ClickDetector or DragDetector.

Inherited members#

Inherited from Instance 58
Properties (10)

Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId

Methods (39)

AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild

Events (9)

AncestryChanged, AttributeChanged, ChildAdded, childAdded, ChildRemoved, DescendantAdded, DescendantRemoving, Destroying, StyledPropertiesChanged

Inherited from Object 6
Properties (2)

ClassName, className

Methods (3)

GetPropertyChangedSignal, IsA, isA

Events (1)

Changed

Subclasses 1#

DragDetector