The API is no longer being updated here until further notice.

Fires immediately before OnClick,

(self, button, down)

Arguments

self

Button - Widget being clicked.

button

string - "LeftButton", "RightButton", "MiddleButton", "Button4", "Button5", ..., "ButtonN"; however, virtual or overriden clicks have aribtrary values using Button:Click(), SetBindingClick() and SecureHandlerWrapScript().

down

boolean - True when the button is pressed, false when it is released.

Details

• Preceeded by OnMouseDown and OnMouseUp.
• Blocked in the "up" direction by OnDoubleClick when it fires.
• Blocked in the "up" direction after dragging with a button registered for dragging, or any time if the cursor is moved off the widget and not brought back before releasing the mouse button.