This property sets how the user’s mouse behaves based on the
Enum/MouseBehavior Enum. The default value is Enum.MouseBehavior.Default.
It can be set to three values:
- Default: The mouse moves freely around the user’s screen.
- LockCenter: The mouse is locked, and cannot move from, the center of the user’s screen.
- LockCurrentPosition: The mouse is locked, and cannot move from, it’s current position on the user’s screen at the time of locking.
The value of this property does not affect the sensitivity of events tracking mouse movement. For example,
UserInputService/GetMouseDelta|GetMouseDelta returns the same
DataType/Vector2|Vector2 screen position in pixels regardless of whether the mouse is locked or able to move freely around the user’s screen. As a result, default scripts like those controlling the camera are not impacted by this property.
This property is overridden if a
GuiButton/Modal|Modal enabled is
GuiButton/Visible unless the player’s right mouse button is down.
Note that, if the mouse is locked,
UserInputService/InputChanged will still fire when the player moves the mouse and will pass in the Delta that the mouse attempted to move by. Additionally, if the player is kicked from the game, the mouse will be forcefully unlocked.
UserInputService is client-side only, this property can only be used in a