View source for OnClientGuiChange

<!-- This page is generated from the verified Lua event definition: onClientGuiChange. -->
= onClientGuiChange =
Triggered when a supported RmlUi input value changes.

== Availability ==
This event is available in '''client-side''' scripts.

== Callback signature ==
<syntaxhighlight lang="lua">
onClientGuiChange(documentId, elementId, value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Description
|-
| <code>documentId</code> || <code>string</code> || The resource-owned RmlUi document ID.
|-
| <code>elementId</code> || <code>string</code> || The source element ID.
|-
| <code>value</code> || <code>string</code> || The element value at dispatch time.
|}

== Examples ==
Handle the event:
<syntaxhighlight lang="lua" line>
addEventHandler("onClientGuiChange", resourceRoot, function(documentId, elementId, value)
    outputDebugString("onClientGuiChange: " .. documentId .. "/" .. elementId .. " = " .. value)
end)
</syntaxhighlight>

== Notes ==
* The event is delivered only to the client resource that owns the document.

[[Category:Lua Events]]
[[Category:Client Events]]
[[Category:GUI Events]]