mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-09-10 22:39:44 +00:00
895bc7721a
This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
29 lines
767 B
Markdown
29 lines
767 B
Markdown
---
|
|
module: [kind=event] mouse_drag
|
|
see: mouse_click For when a mouse button is initially pressed.
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: LicenseRef-CCPL
|
|
-->
|
|
|
|
This event is fired every time the mouse is moved while a mouse button is being held.
|
|
|
|
## Return values
|
|
1. @{string}: The event name.
|
|
2. @{number}: The [mouse button](mouse_click.html#Mouse_buttons) that is being pressed.
|
|
3. @{number}: The X-coordinate of the mouse.
|
|
4. @{number}: The Y-coordinate of the mouse.
|
|
|
|
## Example
|
|
Print the button and the coordinates whenever the mouse is dragged.
|
|
|
|
```lua
|
|
while true do
|
|
local event, button, x, y = os.pullEvent("mouse_drag")
|
|
print(("The mouse button %s was dragged at %d, %d"):format(button, x, y))
|
|
end
|
|
```
|