OnClientGuiClick

onClientGuiClick

Triggered when a clickable element in a resource-owned RmlUi document is activated.

Availability

This event is available in client-side scripts.

Callback signature

onClientGuiClick(documentId, elementId, value)

Parameters

Name	Type	Description
documentId	string	The resource-owned RmlUi document ID.
elementId	string	The source element ID.
value	string	The element value at dispatch time.

Examples

Handle the event:

addEventHandler("onClientGuiClick", resourceRoot, function(documentId, elementId, value)
    outputDebugString("onClientGuiClick: " .. documentId .. "/" .. elementId .. " = " .. value)
end)

Notes

• The event is delivered only to the client resource that owns the document.