https://github.com/vlazed/toggle-cursor
Unlock the mouse cursor without opening the context menu
https://github.com/vlazed/toggle-cursor
gmod gmod-addon gmod-lua lua
Last synced: 4 months ago
JSON representation
Unlock the mouse cursor without opening the context menu
- Host: GitHub
- URL: https://github.com/vlazed/toggle-cursor
- Owner: vlazed
- License: mit
- Created: 2024-08-20T01:06:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-08T16:46:47.000Z (10 months ago)
- Last Synced: 2025-04-22T22:48:01.304Z (8 months ago)
- Topics: gmod, gmod-addon, gmod-lua, lua
- Language: Lua
- Homepage:
- Size: 7.14 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Toggle Mouse Cursor
tmc_togglemousecursor to lock or unlock the mouse
This addon adds the following console commands:
- `tmc_togglemousecursor` to toggle free mouse cursor movement without moving the crosshair. You can bind a key to this console command,
- `tmc_blockentitymenu [0/1]` to enable/disable entity menus when right-clicking on an entity, and
- `tmc_notifications [0/1]` to enable/disable customizable notification text and sound.
This addon works in the same way as holding C to open the tool control panel. However, this console command keeps the mouse free until the command is called again.
This is useful for scenarios which require precise mouse movement, as opposed to the crosshair which is locked to mouse sensitivity.
## Note
This addon detours the following functions:
- `gui.EnableScreenClicker` to preserve the unlocked cursor state,
- `properties.OpenEntityMenu` to block the EntityMenu when unlocked and when `tmc_blockentitymenu 1`.
Toggle `tmc_togglemousecursor` again to fix inconsistent behaviors.