Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:18Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Loads a new image file into an existing UI texture.

<pre>
success = SetTextureImage(textureName, imagePath)
</pre>

== Arguments ==
;textureName : <code>string</code> – Name of a texture already defined by the UI, for example in a <code><Texture></code> element of a module's XML.
;imagePath : <code>string</code> – Path of the image file, relative to the folder of the UI module that is current when the call is made.

== Returns ==
;success : <code>boolean</code> – <code>true</code> if the image was loaded and assigned to the texture.

== Details ==
* The client must have a current UI module, otherwise the ''must be called from a UI module'' error is logged. The full path is built as ''module folder''<code>/</code>''imagePath''.
* If no texture named <code>textureName</code> exists, or the image file does not exist, the matching error is logged and <code>false</code> is returned.
* In the stock example the path <code>Textures/english/...</code> points into the <code>ea_helpwindow</code> module's own folder.
* The argument check is shared with [[API:DynamicImageSetTexture|DynamicImageSetTexture]]: if an argument is missing or not a string, the ''Invalid Parameters'' message names that function.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns <code>false</code>.
* <code>Error in function call 'SetTextureImage': This function must be called from a UI module</code>
* <code>Error in function call 'SetTextureImage': Texture %s does not exist</code>
* <code>Error in function call 'SetTextureImage': Image file %s does not exist</code>

== Example ==
Loading a localised tutorial picture and falling back to English, from <code>ea_helpwindow/source/tutorialwindow.lua</code>:
<pre>
local function GetTextureFilePath( lang )
local langDir = InterfaceCore.CoreLanguageDirectories[ lang ]
return "Textures/"..langDir.."/"..textureFileName
end

-- First try to load the localized image
local success = SetTextureImage( "EA_Help_Tutorial_Background1", GetTextureFilePath( SystemData.Settings.Language.active ) )
if( success == false )
then
-- Otherwise fallback on the English image
SetTextureImage( "EA_Help_Tutorial_Background1", GetTextureFilePath( SystemData.Settings.Language.ENGLISH ) )
end
</pre>

== See also ==
* [[API:DynamicImageSetTexture|DynamicImageSetTexture]]
* [[API:LoadResources|LoadResources]]

API:SetTextureImage - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)