Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:50Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Builds the markup for a clickable link that can be put into chat or label text.

<pre>
link = CreateHyperLink(data, text, color, color2)
</pre>

== Arguments ==
;data : <code>wstring</code> – The link's data string, for example <code>L"PLAYER:"..name</code>. The stock UI starts it with a tag that tells what kind of link it is.
;text : <code>wstring</code> – The text shown for the link.
;color : <code>number-table</code> – Colour of the link as <code>{r, g, b}</code> on a 0–255 scale, or <code>{}</code> for no colour.
;color2 : <code>number-table</code> – A second colour in the same form, or <code>{}</code>. The stock UI always passes <code>{}</code>.

== Returns ==
;link : <code>wstring</code> – The markup, for example <code><LINK data="PLAYER:Name" text="Name" color="255,255,255"></code>.

== Details ==
* The result has the form <code><LINK data="''data''" text="''text''"></code>. Each colour table adds a <code>color="r,g,b"</code> attribute before the closing <code>></code>; with both tables filled the markup has two <code>color</code> attributes.
* A colour table is used only if it has at least three entries; only the first three are read. Each value is clamped to 0–255 and written as a whole number.
* <code>data</code> and <code>text</code> are copied as they are. Quotes or <code>></code> characters in them are not escaped.
* <code>data</code> and <code>text</code> must be wide strings. Passing a plain Lua string raises an ''Invalid Parameters'' error.
* The function needs at least four arguments and only reads the last four.

== Errors ==
None besides the ''Invalid Parameters'' argument check.

== Example ==
Inserting an item link into the chat input, from <code>ea_chatwindow/source/chathyperlinking.lua</code>:
<pre>
local data = ITEM_TAG..itemData.uniqueID
local text = L"["..itemData.name..L"]"
local color = DataUtils.GetItemRarityColor(itemData)

local link = CreateHyperLink( data, text, {color.r,color.g,color.b}, {} )

EA_ChatWindow.InsertText( link )
</pre>

A player link without a colour, from <code>ea_guildwindow/source/guildwindowtabrecruitsearch.lua</code>:
<pre>
local text = CreateHyperLink( L"PLAYER:"..name, name, {}, {} )
</pre>

== See also ==
* [[API:TextEditBoxInsertText|TextEditBoxInsertText]]
* [[API:LabelSetLinkColor|LabelSetLinkColor]]
* [[API:LabelSetIgnoreFormattingTags|LabelSetIgnoreFormattingTags]]

API:CreateHyperLink - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)