net.sourceforge.jsh3modtool.mod
Interface GameMod

All Known Implementing Classes:

DefaultGameMod

public interface GameMod

Game modification interface. This interface describes a game modification. A game modification can be installed into a game, modifying one or more files in the game's folder.

Author:

redsolo

Method Summary

java.util.List	getAuthors() Returns a list of mod authors.
java.util.Date	getCreatedDate() Returns the date the mod was created.
java.lang.String	getDescription() Returns a description of the mod.
java.util.List	getGameFiles() Returns a list of game files that are going to be modified.
java.lang.String	getName() Returns the name of the mod.
java.util.List	getScreenshots() Returns a list of screen shots of the mod.
java.util.Date	getUpdatedDate() Returns the date when the current version was release.
java.lang.String	getVersion() Returns the version of the mod.
java.net.URL	getWebsite() Returns the website of the mod.

Method Detail

getName

java.lang.String getName()

Returns the name of the mod.

Returns:

the name of the mod.

getVersion

java.lang.String getVersion()

Returns the version of the mod.

Returns:

the version of the mod.

getDescription

java.lang.String getDescription()

Returns a description of the mod.

Returns:

a description of the mod.

getCreatedDate

java.util.Date getCreatedDate()

Returns the date the mod was created.

Returns:

the date the mod was created.

getUpdatedDate

java.util.Date getUpdatedDate()

Returns the date when the current version was release.

Returns:

the date when the current version was release.

getWebsite

java.net.URL getWebsite()

Returns the website of the mod.

Returns:

the website of the mod.

getScreenshots

java.util.List getScreenshots()

Returns a list of screen shots of the mod. The list consists of only ModScreenShot objects.

Returns:

a list of screen shots of the mod.

getGameFiles

java.util.List getGameFiles()

Returns a list of game files that are going to be modified. The list consists of only ModGameFile objects.

Returns:

a list of game files that are going to be modified.

getAuthors

java.util.List getAuthors()

Returns a list of mod authors. The list consists of only ModAuthor objects.

Returns:

a list of mod authors.