net.sourceforge.jsh3modtool.mod
Interface ModScreenShot

public interface ModScreenShot

Interface for screenshots showing of a modification. In order to see what a modification does and doesnt do, it can contain screenshots from the game.

Author:

redsolo

Method Summary

java.lang.String	getDescription() Returns a description of the screen shot.
java.io.InputStream	getImageData() Returns the screenshot.
java.lang.String	getName() Returns a descriptive name of the screen shot.

Method Detail

getImageData

java.io.InputStream getImageData()
                                 throws java.io.IOException

Returns the screenshot.

Returns:

the screenshot.

Throws:

java.io.IOException

getDescription

java.lang.String getDescription()

Returns a description of the screen shot. The description can contain a longer text describing what is seen in the scren shot. The text is displayed along with the image when it is viewed in full size.

Returns:

a description of the screen shot.

getName

java.lang.String getName()

Returns a descriptive name of the screen shot.

Returns:

a descriptive name of the screen shot.