1 package net.sourceforge.jsh3modtool.mod;
2
3 import java.io.IOException;
4 import java.io.InputStream;
5
6 /***
7 * Interface for screenshots showing of a modification.
8 * In order to see what a modification does and doesnt do, it can contain
9 * screenshots from the game.
10 *
11 * @author redsolo
12 */
13 public interface ModScreenShot
14 {
15 /***
16 * Returns the screenshot.
17 * @return the screenshot.
18 */
19 InputStream getImageData() throws IOException;
20
21 /***
22 * Returns a description of the screen shot.
23 * The description can contain a longer text describing what is seen
24 * in the scren shot. The text is displayed along with the image when
25 * it is viewed in full size.
26 * @return a description of the screen shot.
27 */
28 String getDescription();
29
30 /***
31 * Returns a descriptive name of the screen shot.
32 * @return a descriptive name of the screen shot.
33 */
34 String getName();
35 }