pl.isangeles.senlin.core

Class Module

java.lang.Object

pl.isangeles.senlin.core.Module

public final class Module
extends java.lang.Object

Static class for current game module details

Author:

Isangeles

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getActiveChapterName() Returns active chapter name
static java.lang.String	getAreaPath() Returns path to area directory in current module directory
static Chapter	getChapter(java.lang.String chapterId, org.newdawn.slick.GameContainer gc) Sets chapter with specified ID as active chapter
static java.lang.String	getChapterObjectsPath() Returns path to objects directory in current chapter directory
static java.lang.String	getDBasePath() Returns path to dialogues base file in current module directory
static java.lang.String	getGlobalLangPath() Returns path to global lang dir in current module directory
static java.lang.String	getGuildPath() Returns path to guilds base file in current module directory
static java.lang.String	getItemsPath() Returns path to items directory in current module directory
static java.lang.String	getLangPath() Returns path to lang directory for current language in current chapter directory of active module e.g.
static java.lang.String	getModuleObjectsPath() Returns path to objects directory in current module directory
static java.lang.String	getName() Returns current module name
static java.lang.String	getNpcsPath() Returns path to npc base file in current module directory
static java.lang.String	getQuestsPath() Returns path to quests base file in current module directory
static java.lang.String	getScriptsPath() Returns path to scripts directory in current module directory
static java.lang.String	getSkillsPath() Returns path to skills directory in current module directory
static void	nextChapter()
static boolean	setDir(java.lang.String modName)
static boolean	setDir(java.lang.String modName, java.lang.String chapterName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDir

public static boolean setDir(java.lang.String modName,
                             java.lang.String chapterName)

setDir

public static boolean setDir(java.lang.String modName)

getChapter

public static Chapter getChapter(java.lang.String chapterId,
                                 org.newdawn.slick.GameContainer gc)

Sets chapter with specified ID as active chapter

Parameters:

chapterId - String with desired chapter ID

nextChapter

public static void nextChapter()

getName

public static java.lang.String getName()

Returns current module name

Returns:

String with module name

getActiveChapterName

public static java.lang.String getActiveChapterName()

Returns active chapter name

Returns:

String with active chapter name

getDBasePath

public static java.lang.String getDBasePath()

Returns path to dialogues base file in current module directory

Returns:

String with path to dialogues base file

getQuestsPath

public static java.lang.String getQuestsPath()

Returns path to quests base file in current module directory

Returns:

String with path to quests base file

getNpcsPath

public static java.lang.String getNpcsPath()

Returns path to npc base file in current module directory

Returns:

String with path to npc base file

getGuildPath

public static java.lang.String getGuildPath()

Returns path to guilds base file in current module directory

Returns:

String with path to quests base file

getAreaPath

public static java.lang.String getAreaPath()

Returns path to area directory in current module directory

Returns:

String with path to area directory

getScriptsPath

public static java.lang.String getScriptsPath()

Returns path to scripts directory in current module directory

Returns:

String with path to scripts directory

getItemsPath

public static java.lang.String getItemsPath()

Returns path to items directory in current module directory

Returns:

String with path to items directory

getSkillsPath

public static java.lang.String getSkillsPath()

Returns path to skills directory in current module directory

Returns:

String with path to skills directory

getChapterObjectsPath

public static java.lang.String getChapterObjectsPath()

Returns path to objects directory in current chapter directory

Returns:

String with path to objects directory

getModuleObjectsPath

public static java.lang.String getModuleObjectsPath()

Returns path to objects directory in current module directory

Returns:

String with path to objects directory

getLangPath

public static java.lang.String getLangPath()

Returns path to lang directory for current language in current chapter directory of active module e.g. for english in settings : 'data/modules/[module name]/chapters/[chapter name]/lang/english'

Returns:

String with path to dialogues lang file

getGlobalLangPath

public static java.lang.String getGlobalLangPath()

Returns path to global lang dir in current module directory

Returns:

String with path to dialogues lang file