li.cil.manual.api.manual

Interface ImageProvider

All Known Implementing Classes:

BlockImageProvider, ItemImageProvider, OreDictImageProvider, TextureImageProvider

public interface ImageProvider

This allows implementing custom image providers for rendering custom content in manual pages. Each provider can be registered for one or more prefixes, and will be selected based on the prefix it was registered with. It is expected to return an image renderer, which essentially represents the area it will render to.

Method Summary

Modifier and Type	Method and Description
ImageRenderer	getImage(java.lang.String data) Gets an image renderer for the specified data.

Method Detail

getImage

@Nullable
ImageRenderer getImage(java.lang.String data)

Gets an image renderer for the specified data.

The data passed here will be part of the image URL following the prefix that the provider was registered with. So for example, if the provider was registered for the prefix custom, and the image to be rendered in the Markdown document was [blah](custom:the data], then the string passed where would be the data.

If there is no appropriate image renderer (for example, for the built-in item stack renderers: if the item definition is invalid), this should return null, it should never throw an exception.

Parameters:

data - the data part of the image definition.

Returns:

the image renderer for the data, or null if none exists.