Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:42:07Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=DynamicImage}}
Meant to give a DynamicImage a custom shader. In the current client the shader name and parameters are not used.

<pre>
DynamicImageSetCustomShader(imageName, shaderName, parameters)
</pre>

== Arguments ==
;imageName : <code>string</code> – Name of a DynamicImage window.
;shaderName : <code>string</code> – Name of the shader. Not used.
;parameters : <code>number-table</code> – Shader parameters. Not used.

== Returns ==
Nothing.

== Details ==
* The client checks the window, converts the parameter table to floats and copies the shader name, but passes neither to the image. It only re-applies the image's current stencil settings and tint colour, then discards the converted values. No shader is set.
* The error messages name <code>DynamicImageSetRotation</code>, not this function.
* The function needs at least three arguments and only reads the last three.
* The stock UI never calls <code>DynamicImageSetCustomShader</code>.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'DynamicImageSetRotation': Window %s does not exist</code>
* <code>Error in function call 'DynamicImageSetRotation': Window %s is not a DynamicImage</code>

== Example ==
A minimal example built from the signature above (it has no visible effect in this client):
<pre>
DynamicImageSetCustomShader( "MyImage", "MyShader", { 1, 0, 0, 1 } )
</pre>

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

API:DynamicImageSetCustomShader - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)