OnDgsMousePreClick

From Multi Theft Auto: Wiki
Revision as of 05:21, 2 June 2024 by Thisdp (talk | contribs) (→‎Example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This event happens when any dgs-element clicked

[[{{{image}}}|link=|]] Note: The player who clicked the dgs-element is always the localPlayer.
[[{{{image}}}|link=|]] Note: If you want to ask why everything is triggered... See the forth parameter of addEventHandler
[[{{{image}}}|link=|]] Note: This event is cancelable, which will affect the click effect and related events

Parameters

string button, string state, int absoluteX, int absoluteY, bool isCoolingDown
  • button: the name of the button which will be clicked , it can be left, right, middle
  • state: the state of the mouse button, will be down if the mouse button was pushed, or up if it was released. Please note currently both up and down state are supported.
  • absoluteX: the X position of the mouse cursor, in pixels, measured from the left side of the screen.
  • absoluteY: the Y position of the mouse cursor, in pixels, measured from the top of the screen.
  • isCoolingDown: A bool indicates whether this dgs element is cooling down. See Property:clickCoolDown

Source

The source of this event is the DGS element that was clicked.

Example

DGS = exports.dgs

btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )
addEventHandler ( "onDgsMouseClick", btnOutput, onClick )

state = false
function onPreClick ( button, state, x, y, isCoolingDown )
	state = not state
	if state then
		outputChatBox("Pre Click Cancelled")
		cancelEvent()
	else
		outputChatBox("Pre Click")
	end
end

function onClick ( button, state ) --Event is canceled, no longer triggers 
	outputChatBox("Click")
end

See Also

DGS events

General

Check Box

Combo Box

Drag'N Drop

Edit

Grid List

Menu

Selector

Mouse

Radio Button

Switch Button

Tab

Animation

Plugin

Media

Color Picker

QRCode

Remote Image

Client event functions