OnDgsMouseClick - Revision history

Thisdp at 14:16, 16 February 2021

2021-02-16T14:16:22Z

← Older revision		Revision as of 14:16, 16 February 2021
Line 4:		Line 4:
	{{Note\|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}		{{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\|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~~}}		{{Note\|This event will not trigger when [[onDgsMousePreClick]] is cancelled.}}

	==Parameters==		==Parameters==

Thisdp at 11:47, 12 February 2021

2021-02-12T11:47:20Z

← Older revision		Revision as of 11:47, 12 February 2021
Line 4:		Line 4:
	{{Note\|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}		{{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\|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==		==Parameters==

Thisdp at 11:42, 12 February 2021

2021-02-12T11:42:21Z

← Older revision		Revision as of 11:42, 12 February 2021
Line 13:		Line 13:
	*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.		*'''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.		*'''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\|DGS_General_Basic_Properties#~~clickCoolDown]]		*'''isCoolingDown:''' A bool indicates whether this dgs element is cooling down. See [[DGS_General_Basic_Properties#clickCoolDown\|Property:clickCoolDown]]
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the DGS element that was clicked.		The [[event system#Event source\|source]] of this event is the DGS element that was clicked.

Thisdp at 11:42, 12 February 2021

2021-02-12T11:42:04Z

← Older revision		Revision as of 11:42, 12 February 2021
Line 13:		Line 13:
	*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.		*'''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.		*'''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]]		*'''isCoolingDown:''' A bool indicates whether this dgs element is cooling down. See [[Property:clickCoolDown\|DGS_General_Basic_Properties#clickCoolDown]]
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the DGS element that was clicked.		The [[event system#Event source\|source]] of this event is the DGS element that was clicked.

Thisdp at 11:41, 12 February 2021

2021-02-12T11:41:45Z

← Older revision		Revision as of 11:41, 12 February 2021
Line 7:		Line 7:
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string button, string state, int absoluteX, int absoluteY		string button, string state, int absoluteX, int absoluteY, bool isCoolingDown
	</syntaxhighlight>		</syntaxhighlight>
	*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''		*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
Line 13:		Line 13:
	*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.		*'''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.		*'''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]]
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the DGS element that was clicked.		The [[event system#Event source\|source]] of this event is the DGS element that was clicked.

Thisdp: /* Parameters */

2020-04-11T11:54:41Z

Parameters

← Older revision		Revision as of 11:54, 11 April 2020
Line 10:		Line 10:
	</syntaxhighlight>		</syntaxhighlight>
	*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''		*'''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, which is different from ''onClientGUIClick''.''' For only ''up'' or ''down'', see [[~~onDgsMouseClickDown~~]]/[[~~onDgsMouseClickUp~~]]		*'''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, which is different from ''onClientGUIClick''.''' For only ''up'' or ''down'', see [[onDgsMouseClickUp]]/[[onDgsMouseClickDown]]
	*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.		*'''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.		*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

Thisdp at 11:54, 11 April 2020

2020-04-11T11:54:11Z

← Older revision		Revision as of 11:54, 11 April 2020
Line 10:		Line 10:
	</syntaxhighlight>		</syntaxhighlight>
	*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''		*'''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, which is different from ''onClientGUIClick''.'''		*'''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, which is different from ''onClientGUIClick''.''' For only ''up'' or ''down'', see [[onDgsMouseClickDown]]/[[onDgsMouseClickUp]]
	*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.		*'''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.		*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

Thisdp at 15:00, 22 July 2019

2019-07-22T15:00:07Z

← Older revision		Revision as of 15:00, 22 July 2019
Line 3:		Line 3:
	This event happens when any dgs-element clicked		This event happens when any dgs-element clicked
	{{Note\|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}		{{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]]}}

	==Parameters==		==Parameters==

Thisdp: /* Clear Example */

2018-08-15T14:20:18Z

Clear Example

← Older revision		Revision as of 14:20, 15 August 2018
Line 42:		Line 42:
	</syntaxhighlight>		</syntaxhighlight>

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

Thisdp: /* Example */

2018-08-15T14:19:35Z

Example

@@ Line 40: / Line 40: @@
      end
 end
 </syntaxhighlight>