OnDgsMouseClick: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 9: Line 9:
</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 that 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''.'''
*'''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.

Revision as of 05:52, 5 October 2017

This event happens when any dgs-element clicked

[[{{{image}}}|link=|]] Note: The player who clicked the dgs-element is always the localPlayer.

Parameters

string button, string state, int absoluteX, int absoluteY
  • 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.
  • 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.

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:dgsDxCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

    -- And attach our button to the outputEditBox function
    addEventHandler ( "onClientDgsDxMouseClick", btnOutput, outputEditBox )

    -- Create an edit box and define it as "editBox".
    editBox = DGS:dgsDxCreateEdit( 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:dgsDxGUIGetText( editBox )-- Get the text from the edit box
        outputChatBox ( text ) -- Output that text
    end
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