PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

IsMouseButtonPressed

This function takes a mouse button Enum/UserInputType and returns a bool that indicates whether it is currently pressed.

The mouse button checked depends on the Enum/UserInputType value passed to the function as an argument. For example:

local UserInputService = game:GetService("UserInputService")
    
local pressed = UserInputService:IsMouseButtonPressed(Enum.UserInputType.MouseButton1)

Since UserInputService is client-side only, this function can only be used in a LocalScript.

Parameters

Name Type Default Description

The Enum/UserInputType of the mouse button

Returns

Return Type Summary

Whether the given mouse button is currently held down


Code Samples


Create a Custom CameraScript

By default, Roblox relies on a LocalScript, described [here][1], to control the user’s camera. However, this script can be overridden with a custom CameraScript. The example below demonstrates how to create a custom script to control the user’s camera using many of the UserInputService events.

The script is broken into two parts:

  1. Mobile camera events, which rely on touch events
  2. Non-mobile camera events, which rely on keyboard input and tracking the user’s movement

First, the camera script needs utility functions to setup the camera and set its Camera/CameraType|CameraType to Scriptable so that the script can control the camera. It also needs a function to update the camera when it moves, rotates, and zooms.

Using touch events allows us to track user input as they interact with the touchscreen on their mobile device. These events allow us to handle camera movement, rotation, and zoom.

The second half of the code sample adds camera support for players on desktop devices. When input begans, the function Input() checks that the state of the input is Enum/UserInputState|Enum.UserInputState.Begin to ignore all keypress inputs other than when the user first presses a key down. When the user presses I and O the camera zooms in and out. When the presses down and moves their left mouse button, the script Enum/MouseBehavior|locks the player’s mouse by changing the UserInputService/MouseBehavior property. The camera rotates according to the mouse’s UserInputService/GetMouseDelta|change in screen position. When the player moves their character, the camera moves with them.

All of the parts discussed above are combined and shown in the code sample below.