Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:58Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Loads the picture of a bestiary species into the texture <code>bestiary_species_image</code>.

<pre>
TomeSetBestiarySpeciesImage(speciesId)
</pre>

== Arguments ==
;speciesId : <code>number</code> – Species id. The species must be unlocked.

== Returns ==
Nothing.

== Details ==
* The image file is taken from <code>interface/InterfaceCore/Tome/Bestiary/Images/</code>, using the file name stored for the species.
* The texture <code>bestiary_species_image</code> is then updated, so every window that uses it shows the new picture. The stock bestiary page has a DynamicImage with <code>texture="bestiary_species_image"</code> in <code>ea_tomeofknowledge/source/tomewindow_bestiary.xml</code>.
* If the species has no picture, or the file does not exist, the texture is cleared. The stock UI checks this with <code>DynamicImageHasTexture</code>.
* If the id is unknown or the species is locked, the texture is cleared and an error is logged.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'TomeSetBestiarySpeciesImage: You have not yet unlocked species # %d.</code> (the quote after the function name is missing in the client's text)

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_bestiary.lua</code>:
<pre>
TomeSetBestiarySpeciesImage( id )
...
if( DynamicImageHasTexture( "BestiarySpeciesInfoImage" ) ) then
WindowAddAnchor( "BestiarySpeciesInfoText1", "bottom", "BestiarySpeciesInfoImage", "top", 0, 10 )
else
WindowAddAnchor( "BestiarySpeciesInfoText1", "top", "BestiarySpeciesInfoImage", "top", 0, 0 )
end
</pre>

== See also ==
* [[API:TomeGetBestiarySpeciesData|TomeGetBestiarySpeciesData]]
* [[API:TomeSetBestiarySubTypeImage|TomeSetBestiarySubTypeImage]]
* [[API:DynamicImageHasTexture|DynamicImageHasTexture]]

API:TomeSetBestiarySpeciesImage - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)