OnClientGUIDoubleClick: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Add note for "state" argument) |
||
(12 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{Client event}} | {{Client event}} | ||
__NOTOC__ | __NOTOC__ | ||
This event is fired when the user double clicks a GUI element. | This event is fired when the user double clicks a GUI element. Doesn't work with buttons. | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string button, string state, int absoluteX, int absoluteY | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''button:''' the name of the mouse button that the GUI element was double clicked with. | |||
*'''state:''' the state of the mouse button. Can be ''down'' or ''up''. '''Please note currently only the up state is 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. | |||
==Source== | |||
The source of this event is the GUI element that was double clicked. | |||
==Example== | ==Example== | ||
This example | This example displays in chatbox name of double-clicked player in a gridlist. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | addEventHandler( "onClientResourceStart", getResourceRootElement( ), | ||
function ( ) | |||
-- | gridList = guiCreateGridList( 10, 200, 100, 50, false ) -- create a gridlist | ||
local col = guiGridListAddColumn( gridList, "Players", .9 ) -- add "Players" column | |||
local players = getElementsByType( "player" ) | |||
for i, plr in pairs( players ) do -- loop through the table of players | |||
local row = guiGridListAddRow( gridList ); -- add row for player | |||
guiGridListSetItemText( gridList, row, col, getPlayerName( plr ), false, false ) -- change the text of the added row | |||
end | |||
addEventHandler( "onClientGUIDoubleClick", gridList, doubleClickedName, false ) | |||
end | |||
); | |||
function doubleClickedName( ) | |||
local selectedRow, selectedCol = guiGridListGetSelectedItem( gridList ); -- get double clicked item in the gridlist | |||
local playerName = guiGridListGetItemText( gridList, selectedRow, selectedCol ) -- get its text | |||
outputChatBox( "You double-clicked: " .. playerName ) -- display the text taken from gridlist | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
[[pl:onClientGUIDoubleClick]] | |||
==See Also== | |||
{{GUI_events}} | |||
===Client event functions=== | |||
{{Client_event_functions}} |
Latest revision as of 07:08, 10 February 2024
This event is fired when the user double clicks a GUI element. Doesn't work with buttons.
Parameters
string button, string state, int absoluteX, int absoluteY
- button: the name of the mouse button that the GUI element was double clicked with.
- state: the state of the mouse button. Can be down or up. Please note currently only the up state is 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.
Source
The source of this event is the GUI element that was double clicked.
Example
This example displays in chatbox name of double-clicked player in a gridlist.
addEventHandler( "onClientResourceStart", getResourceRootElement( ), function ( ) gridList = guiCreateGridList( 10, 200, 100, 50, false ) -- create a gridlist local col = guiGridListAddColumn( gridList, "Players", .9 ) -- add "Players" column local players = getElementsByType( "player" ) for i, plr in pairs( players ) do -- loop through the table of players local row = guiGridListAddRow( gridList ); -- add row for player guiGridListSetItemText( gridList, row, col, getPlayerName( plr ), false, false ) -- change the text of the added row end addEventHandler( "onClientGUIDoubleClick", gridList, doubleClickedName, false ) end ); function doubleClickedName( ) local selectedRow, selectedCol = guiGridListGetSelectedItem( gridList ); -- get double clicked item in the gridlist local playerName = guiGridListGetItemText( gridList, selectedRow, selectedCol ) -- get its text outputChatBox( "You double-clicked: " .. playerName ) -- display the text taken from gridlist end
See Also
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel
Client event functions
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled