https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALCDBitmapSetImageAPI:LCDBitmapSetImage - Revision history2026-10-17T23:25:41ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LCDBitmapSetImage&diff=30527&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:45:59Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=LCD}}<br />
Loads a .bmp image file into an LCD bitmap element.<br />
<br />
<pre><br />
LCDBitmapSetImage(pageName, bitmapName, imageFile, resizeToImage)<br />
</pre><br />
<br />
== Arguments ==<br />
;pageName : <code>string</code> – Name of the page.<br />
;bitmapName : <code>string</code> – Name of a bitmap element created with [[API:LCDCreateBitmap|LCDCreateBitmap]].<br />
;imageFile : <code>string</code> – Path of a Windows bitmap file, relative to the folder of the addon that is running the code.<br />
;resizeToImage : <code>boolean</code> – <code>true</code> to size the element to the image's width and height.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The client builds the full path from the current addon's folder, a slash and <code>imageFile</code>. The stock addon passes <code>"Textures/LCDLogo.bmp"</code> for the file <code>ea_lcdkeyboard/textures/lcdlogo.bmp</code>.<br />
* Any image already loaded into the element is released first.<br />
* If the file cannot be found or is too small to be a bitmap, the element is left without an image.<br />
* If no addon is current at the time of the call, nothing is loaded. The stock addon calls this function from its <code>Initialize</code> function.<br />
* With <code>resizeToImage = false</code> the element keeps its size.<br />
* <code>resizeToImage</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.<br />
* The function needs at least four arguments and only reads the last four.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'LCDBitmapSetImage': Page '%s' does not exist.</code><br />
* <code>Error in function call 'LCDBitmapSetImage': Page '%s' does not have a child named '%s'.</code><br />
* <code>Error in function call 'LCDBitmapSetImage': '%s' on page '%s' is not a/an Bitmap.</code><br />
<br />
== Example ==<br />
From <code>ea_lcdkeyboard/source/g15test.lua</code>:<br />
<pre><br />
LCDCreateBitmap( EA_LCDKeyboard.Page2, "Logo" )<br />
LCDBitmapSetImage( EA_LCDKeyboard.Page2, "Logo", "Textures/LCDLogo.bmp", true )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:LCDCreateBitmap|LCDCreateBitmap]]<br />
* [[API:LCDSetSize|LCDSetSize]]</div>Maintenance script