Basalt/docs/events/mouseEvents.md

Here we will talk about mouse events and how you can use them. You can register custom mouse events to all visual objects

onClick

onClick(self, event, button, x, y)
The computercraft event which triggers this method is mouse_click and monitor_touch. Any visual object can register onClick events.

Here is a example on how to add a onClick event to your button:

local basalt = dofile("basalt.lua")

local mainFrame = basalt.createFrame("myMainFrame"):show()
local button = mainFrame:addButton("myButton"):setPosition(3,3):setSize(12,3):setText("Click"):show()

function buttonOnClick()
  basalt.debug("Button got clicked!")
end
button:onClick(buttonOnClick())

onClickUp

onClickUp(self, event, button, x, y)
The computercraft event which triggers this method is mouse_up. Any visual object can register onClickUp events.

Here is a example on how to add a onClickUp event to your button:

local basalt = dofile("basalt.lua")

local mainFrame = basalt.createFrame("myMainFrame"):show()
local button = mainFrame:addButton("myButton"):setPosition(3,3):setSize(12,3):setText("Click"):show()

function buttonOnClick(self, button, x, y)
  basalt.debug("Button got clicked!")
end
button:onClick(buttonOnClick)

function buttonOnRelease(self, button, x, y)
  basalt.debug("Button got released!")
end
button:onClickUp(buttonOnRelease)

onScroll

onScroll(self, event, direction, x, y)
The computercraft event which triggers this method is mouse_scroll. Any visual object can register onScroll events.

Here is a example on how to add a onScroll event to your button:

local basalt = dofile("basalt.lua")

local mainFrame = basalt.createFrame("myMainFrame"):show()
local button = mainFrame:addButton("myButton"):setPosition(3,3):setSize(12,3):setText("Click"):show()

function buttonOnScroll(self, direction, x, y)
  basalt.debug("Someone scrolls on me!")
end
button:onScroll(buttonOnScroll)

onDrag

onDrag(self, event, button, x, y)
The computercraft event which triggers this method is mouse_drag. Any visual object can register onDrag events.

Here is a example on how to add a onDrag event to your button:

local basalt = dofile("basalt.lua")

local mainFrame = basalt.createFrame("myMainFrame"):show()
local button = mainFrame:addButton("myButton"):setPosition(3,3):setSize(12,3):setText("Click"):show()

function buttonOnDrag(self, button, x, y)
  basalt.debug("Someone drags me (i know i wont reposition myself)!")
end
button:onDrag(buttonOnDrag)