The MouseClick event fires when a player presses and releases the left mouse button while the cursor is hovering over a
Model with a
ClickDetector. Additionally, the Player’s
Player/Character|Character must be within the
ClickDetector/MaxActivationDistance|MaxActivationDistance of the clicked object. This event fires when using either a
UserInputService/TouchEnabled|TouchEnabledplatforms, this event fires when the user taps on the same model.
UserInputService/GamepadEnabled|GamepadEnabledplatforms, this event fires when the center dot is over the same model and the A button is pressed and released.
- If you want to check when a player right clicks on the ClickDetector, you can use the
- If you want a function to fire when a player hovers on or off of the ClickDetector without mouse clicking it you can use the
Creating a ClickDetector Door
The code sample below demonstrates the functionality of a
ClickDetector and its properties and events.
First the code creates a ClickDetector and set’s its
Instance/Parent|parent to the
door. It also sets the
ClickDetector/MaxActivationDistance|maximum distance players can interact with the ClickDetector to 10 studs and set’s the ClickDetector’s
Then, the code connects the ClickDetector to several events, including changing the door’s
BasePart/Transparency when the player’s mouse hovers
ClickDetector/MouseHoverLeave|off off the door. The player opens the door by
ClickDetector/MouseClick|left clicking their mouse while over the ClickDetector and closes the door by
ClickDetector/RightMouseClick|right clicking their mouse while over the ClickDetector.
This code works in a
Script and a
LocalScript as long as the script’s parent is the door