ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2026-01-02 05:43:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat: add ITextureProvider.GetIconPath() function to allow for icon path lookups by plugins

Browse source
This commit is contained in:
goat 2023-08-03 19:18:38 +02:00
parent 389ff91097
commit 8df154c1a9
No known key found for this signature in database
GPG key ID: 49E2AA8C6A76498B
2 changed files with 43 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Dalamud/Plugin/Services/ITextureProvider.cs
View file

@ -52,6 +52,21 @@ public interface ITextureProvider
/// </returns>
public IDalamudTextureWrap? GetIcon(uint iconId, IconFlags flags = IconFlags.HiRes, ClientLanguage? language = null, bool keepAlive = false);
/// <summary>
/// Get a path for a specific icon's .tex file.
/// </summary>
/// <param name="iconId">The ID of the icon to look up.</param>
/// <param name="flags">Options to be considered when loading the icon.</param>
/// <param name="language">
/// The language to be considered when loading the icon, if the icon has versions for multiple languages.
/// If null, default to the game's current language.
/// </param>
/// <returns>
/// Null, if the icon does not exist in the specified configuration, or the path to the texture's .tex file,
/// which can be loaded via IDataManager.
/// </returns>
public string? GetIconPath(uint iconId, IconFlags flags = IconFlags.HiRes, ClientLanguage? language = null);
/// <summary>
/// Get a texture handle for the texture at the specified path.
/// You may only specify paths in the game's VFS.