OnClientGUIClick

2009-09-24T08:18:38Z

Graetz:

{{Client event}}
__NOTOC__
{{Needs Checking|''middle'' button does not trigger this event.--[[User:50pence|50pence]] 12:19, 19 May 2008 (CDT)}}
This event is fired when the user clicks a GUI element.

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the mouse button that the GUI element was clicked with, can be ''left'', ''right'', or ''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 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 [[event system#Event source|source]] of this event is the GUI 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.
<syntaxhighlight lang="lua">
-- when client's resource start, create the gui
function initGUI( )
--create our button
btnOutput = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this
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 = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
end
--and attach our button to the outputEditBox function
function onResStart( )
addEventHandler ( "onClientGUIClick", btnOutput, outputEditBox, false )
end
addEventHandler( "onClientResourceStart", getRootElement(), onResStart )
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

Multi Theft Auto: Wiki - User contributions [en]

OnClientGUIClick