OnDgsMousePreClick - Revision history

Thisdp: /* Example */

2024-06-02T05:21:54Z

Example

← Older revision		Revision as of 05:21, 2 June 2024
Line 23:		Line 23:

	btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )		btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
	~~DGS:dgsSetProperty( btnOutput , "clickCoolDown", 1000 ) --Cool Down 1s~~
	addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )		addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )
	addEventHandler ( "onDgsMouseClick", btnOutput, onClick )		addEventHandler ( "onDgsMouseClick", btnOutput, onClick )

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

Thisdp: /* Example */

2024-05-12T07:12:25Z

Example

← Older revision		Revision as of 07:12, 12 May 2024
Line 23:		Line 23:

	btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )		btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
	addEventHandler ( "onDgsMousePreClick", btnOutput, ~~cancelTheEvent~~ )		DGS:dgsSetProperty( btnOutput , "clickCoolDown", 1000 ) --Cool Down 1s
	addEventHandler ( "onDgsMouseClick", btnOutput, ~~output~~ )		addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )
			addEventHandler ( "onDgsMouseClick", btnOutput, onClick )

	function ~~cancelTheEvent~~()		function onPreClick ( button, state, x, y, isCoolingDown )
	cancelEvent()		if isCoolingDown then
			outputChatBox("Cooling Down, Cancelled")
			cancelEvent()
			else
			outputChatBox("Pre Click")
			end
	end		end

	function ~~output~~( button, state ) --Event is canceled, no longer triggers		function onClick ( button, state ) --Event is canceled, no longer triggers
	outputChatBox("~~I Clicked~~")		outputChatBox("Click")
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: Created page with "{{Client event}} NOTOC This event happens when any dgs-element clicked {{Note|The '''player''' who clicked the dgs-element is always the localPlayer.}} {{Note|If you w..."

2021-02-16T14:15:26Z

Created page with "{{Client event}} __NOTOC__ This event happens when any dgs-element clicked {{Note|The '''player''' who clicked the dgs-element is always the localPlayer.}} {{Note|If you w..."

New page

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

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY, bool isCoolingDown
</syntaxhighlight>
*'''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 [[DGS_General_Basic_Properties#clickCoolDown|Property:clickCoolDown]]
==Source==
The [[event system#Event source|source]] of this event is the DGS element that was clicked.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs

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

function cancelTheEvent()
cancelEvent()
end

function output( button, state ) --Event is canceled, no longer triggers
outputChatBox("I Clicked")
end
</syntaxhighlight>

==See Also==
===DGS events===
{{DGSEVENTS}}
===Client event functions===
{{Client_event_functions}}

OnDgsMousePreClick - Revision history

Thisdp: /* Example */

Thisdp: /* Example */

Thisdp: Created page with "{{Client event}} __NOTOC__ This event happens when any dgs-element clicked {{Note|The '''player''' who clicked the dgs-element is always the localPlayer.}} {{Note|If you w..."

Thisdp: Created page with "{{Client event}} NOTOC This event happens when any dgs-element clicked {{Note|The '''player''' who clicked the dgs-element is always the localPlayer.}} {{Note|If you w..."