BoxArtProvider

Inherits: Node

Base class for BoxArt implementations

Description

The BoxArtProvider class provides an interface for providing sources of game artwork. To create a new BoxArtProvider, simply extend this class and implement its methods. When a BoxArtProvider node enters the scene tree, it will automatically register itself with the global BoxArtManager. When a menu requires showing artwork for a particular game, it will request that artwork from the BoxArtManager. The manager, in turn, will request artwork from all registered boxart providers until it finds one.

Properties

Type	Name	Default
BoxArtManager	BoxArtManager
String	provider_id
Texture2D	provider_icon
String	logger_name	provider_id
int	log_level	3
CustomLogger	logger

Methods

Returns	Signature
Texture2D	get_boxart(item: LibraryItem, kind: int)

---

Property Descriptions

BoxArtManager

BoxArtManager BoxArtManager

Note

There is currently no description for this property. Please help us by contributing one!

provider_id

String provider_id

Unique identifier for the boxart provider

provider_icon

Texture2D provider_icon

Icon for boxart provider

logger_name

String logger_name = provider_id

Logger name used for debug messages

log_level

int log_level = 3

Log level of the logger.

logger

CustomLogger logger

Note

There is currently no description for this property. Please help us by contributing one!

---

Method Descriptions

get_boxart()

Texture2D get_boxart(item: LibraryItem, kind: int)

Returns the game artwork as a texture for the given game in the given layout. This method should be overriden in the extending class.