OnClientGuiEscape

onClientGuiEscape

Triggered when Escape is pressed while a resource-owned RmlUi document owns UI input.

Availability

This event is available in client-side scripts.

Callback signature

onClientGuiEscape(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("onClientGuiEscape", resourceRoot, function(documentId, elementId, value)
    outputDebugString("onClientGuiEscape: " .. documentId .. "/" .. elementId .. " = " .. value)
end)

Notes

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