OnDgsMouseClickUp: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 6: | Line 6: | ||
{{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 will not trigger when [[ | {{Note|This event will not trigger when [[onDgsMousePreClick]] is cancelled.}} | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string button, int absoluteX, int absoluteY | string button, string state, int absoluteX, int absoluteY, bool isCoolingDown | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''button | *'''button''': the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''. | ||
*'''absoluteX | *'''state''': a string of mouse state. In this cause, it is always '''up'''. | ||
*'''absoluteY | *'''absoluteX''': the X position of the mouse cursor, in pixels, measured from the left side of the screen. | ||
*'''isCoolingDown | *'''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== | ==Source== |
Latest revision as of 14:42, 18 February 2021
This event happens when any dgs-element clicked ( Mouse up ).
And this event is for those who are converting gui to dgs.
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: a string of mouse state. In this cause, it is always up.
- 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
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
DGS = exports.dgs -- When client's resource starts, create the GUI function initGUI( ) -- Create our button btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true ) -- And attach our button to the outputEditBox function addEventHandler ( "onDgsMouseClickUp", btnOutput, outputEditBox ) -- Create an edit box and define it as "editBox". editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true ) end addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI ) -- Setup our function to output the message to the chatbox function outputEditBox ( button ) if button == "left" then local text = DGS:dgsGetText( editBox )-- Get the text from the edit box outputChatBox ( text ) -- Output that text end end
Clear Example
DGS = exports.dgs btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true ) function outputEditBox ( button ) if button == "left" then outputChatBox ( "Hey bro, you clicked me, your state is "..state ) end end addEventHandler ( "onDgsMouseClickUp", btnOutput, outputEditBox )
See Also
DGS events
General
- onDgsBlur
- onDgsCreate
- onDgsCursorTypeChange
- onDgsCursorStateChange
- onDgsDestroy
- onDgsElementRender
- onDgsElementMove
- onDgsElementSize
- onDgsElementEnter
- onDgsElementLeave
- onDgsFocus
- onDgsKey
- onDgsPositionChange
- onDgsPreRender
- onDgsRender
- onDgsElementScroll
- onDgsSizeChange
- onDgsTextChange
- onDgsWindowClose
- onDgsPropertyChange
Check Box
Combo Box
Drag'N Drop
Edit
Grid List
Menu
Selector
Mouse
- onDgsMousePreClick
- onDgsMouseClick
- onDgsMouseClickDown
- onDgsMouseClickUp
- onDgsMouseDrag
- onDgsMouseDoubleClick
- onDgsMouseDoubleClickDown
- onDgsMouseDoubleClickUp
- onDgsMouseDown
- onDgsMouseHover
- onDgsMouseEnter
- onDgsMouseLeave
- onDgsMouseMultiClick
- onDgsMouseMove
- onDgsMouseStay
- onDgsMouseUp
- onDgsMouseWheel
Radio Button
Switch Button
Tab
Animation
Plugin
Media
- onDgsMediaPlay
- onDgsMediaPause
- onDgsMediaStop
- onDgsMediaLoaded
- onDgsMediaTimeUpdate
- onDgsMediaBrowserReturn