Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:37Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the short name and button image slice of a sigil, as shown on the target unit frame.

<pre>
info = TomeGetSigilDisplayInfo(sigilEntryId)
</pre>

== Arguments ==
;sigilEntryId : <code>number</code> – Sigil entry id. Only the low 16 bits are used.

== Returns ==
;info : <code>table</code> – The display data, or nothing if the id is invalid or the player is not in the world.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Sigil entry id.
|-
| <code>name</code> || <code>wstring</code> || Short name of the sigil; empty if the name table is not loaded.
|-
| <code>sliceName</code> || <code>string</code> || Name of a texture slice. The stock UI uses it, and the same name with <code>"-rollover"</code> added, as slices of the <code>EA_HUD_01</code> texture.
|}

== Details ==
* Exactly one argument must be passed.

== Errors ==
These are written to the UI log, and the function returns nothing.
* <code>Error in function call 'TomeGetSigilDisplayInfo': %d is not a valid entry id.</code>

== Example ==
From <code>default/eatemplate_unitframes/source/targetunitframe.lua</code>:
<pre>
HostileUnitSigilDisplayInfo = TomeGetSigilDisplayInfo( sigilEntryId )

local buttonName = self:GetName().."SigilButton"
local normalSlice = HostileUnitSigilDisplayInfo.sliceName
local rolloverSlice = HostileUnitSigilDisplayInfo.sliceName.."-rollover"

ButtonSetTextureSlice(buttonName, Button.ButtonState.NORMAL, "EA_HUD_01", normalSlice);
ButtonSetTextureSlice(buttonName, Button.ButtonState.HIGHLIGHTED, "EA_HUD_01", rolloverSlice);
</pre>

== See also ==
* [[API:TomeGetSigilEntry|TomeGetSigilEntry]]
* [[API:TomeGetSigilTOC|TomeGetSigilTOC]]

API:TomeGetSigilDisplayInfo - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)