Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:43Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Button}}
Returns the width and height of the text on a Button.

<pre>
width, height = ButtonGetTextDimensions(buttonName)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.

== Returns ==
;width : <code>number</code> – Width of the widest line of text.
;height : <code>number</code> – Height of all lines: the number of lines times the line height.

== Details ==
* The values are measured the same way as [[API:LabelGetTextDimensions|LabelGetTextDimensions]], from the button's text label, and are divided by the label's scale.
* If the button has no text label, the two returned numbers are not meaningful.

== Errors ==
* <code>Error in function call 'ButtonGetTextDimensions': Window %s does not exist</code>
* <code>Error in function call 'ButtonGetTextDimensions': Window %s is not a Button</code>

== Example ==
Measuring a context-menu entry, from <code>ea_contextmenu/source/contextmenu.lua</code>:
<pre>
local x, _ = ButtonGetTextDimensions( menuItemWindowName )
</pre>

From <code>ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:
<pre>
local _, height = ButtonGetTextDimensions( entryWindowName.."Text" )
</pre>

== See also ==
* [[API:ButtonGetText|ButtonGetText]]
* [[API:LabelGetTextDimensions|LabelGetTextDimensions]]

API:ButtonGetTextDimensions - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)