mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-07-07 04:14:26 +00:00
440fca6535
We've got in touch with Brady, so can now do the last of the docs \o/! Also pick up a couple of stragglers that I'd missed from before.
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
---
|
|
module: [kind=event] mouse_click
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
This event is fired when the terminal is clicked with a mouse. This event is only fired on advanced computers (including
|
|
advanced turtles and pocket computers).
|
|
|
|
## Return values
|
|
1. [`string`]: The event name.
|
|
2. [`number`]: The mouse button that was clicked.
|
|
3. [`number`]: The X-coordinate of the click.
|
|
4. [`number`]: The Y-coordinate of the click.
|
|
|
|
## Mouse buttons
|
|
Several mouse events ([`mouse_click`], [`mouse_up`], [`mouse_scroll`]) contain a "mouse button" code. This takes a
|
|
numerical value depending on which button on your mouse was last pressed when this event occurred.
|
|
|
|
| Button Code | Mouse Button |
|
|
|------------:|---------------|
|
|
| 1 | Left button |
|
|
| 2 | Right button |
|
|
| 3 | Middle button |
|
|
|
|
## Example
|
|
Print the button and the coordinates whenever the mouse is clicked.
|
|
|
|
```lua
|
|
while true do
|
|
local event, button, x, y = os.pullEvent("mouse_click")
|
|
print(("The mouse button %s was pressed at %d, %d"):format(button, x, y))
|
|
end
|
|
```
|