Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:16Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Sets the background image drawn behind the target's 3D portrait.

<pre>
SetTargetPortraitBackground(templateName, x, y)
</pre>

== Arguments ==
;templateName : <code>string</code> – Name of a DynamicImage window template defined in the UI's XML.
;x, y : <code>number</code> – Position given to the background image.

== Returns ==
Nothing.

== Details ==
* Any background set earlier is destroyed first.
* If <code>templateName</code> names a DynamicImage template, the client creates a new DynamicImage from it for the target portrait and places it at (<code>x</code>, <code>y</code>), kept inside the screen. If there is no such template, or it is not a DynamicImage, the portrait is left without a background.
* If the target portrait does not exist yet, the call does nothing.
* The stock UI never calls this function. The only reference is a commented-out line in <code>eatemplate_unitframes/source/targetunitframe.lua</code>.

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

== Example ==
The commented-out call in <code>eatemplate_unitframes/source/targetunitframe.lua</code>:
<pre>
-- SetTargetPortraitBackground( "TargetPortraitBackground", 10, 10 )
</pre>

== See also ==
* [[API:SetPlayerPortraitBackground|SetPlayerPortraitBackground]]

API:SetTargetPortraitBackground - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)