pl.isangeles.senlin.util

Class DConnector

java.lang.Object

pl.isangeles.senlin.util.DConnector

public final class DConnector
extends java.lang.Object

This class provides static methods giving access to external game data like items, NPCs, etc;

Author:

Isangeles

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SIMSUN_FONT

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,ArmorPattern>	getArmors(java.lang.String basePath) Parses specified XML base and returns map with armor patterns
static java.util.Map<java.lang.String,AttackPattern>	getAttacksMap(java.lang.String basePath) Parses XML base file and builds map with attacks patterns as values and its IDs as keys
static java.util.Map<java.lang.String,BuffPattern>	getBuffsMap(java.lang.String basePath) Parses XML base file and builds map with buffs patterns as values and its IDs as keys
static java.util.Map<java.lang.String,Dialogue>	getDialogueMap(java.lang.String basePath) Returns Map with dialogues map from specified base file
static java.util.Map<java.lang.String,EffectPattern>	getEffectsMap(java.lang.String basePath) Parses XML base file content to list with Effect objects
static java.util.Map<java.lang.String,Guild>	getGuildsMap(java.lang.String basePath) Parses XML doc and builds map with guilds and guilds IDs as keys
static java.util.Map<java.lang.String,MiscPattern>	getMisc(java.lang.String basePath) Returns map with miscellaneous item patterns as values and its IDs as keys
static java.util.Map<java.lang.String,NpcPattern>	getNpcMap(java.lang.String basePath) Parses XML NPC base to map with NPC IDs as keys assigned to specific NPC pattern
static java.util.Map<java.lang.String,ObjectPattern>	getObjects(java.lang.String basePath) Parses specified XML base with game objects to map with objects patterns as values and objects IDs as keys
static java.util.Map<java.lang.String,PassivePattern>	getPassivesMap(java.lang.String basePath) Parses XML base file content and builds map with passive skills patterns as values and its IDs as keys
static java.util.Map<java.lang.String,Quest>	getQuests(java.lang.String basePath) Parses specified XML quest base file and returns map with quests ID's as keys and quest as values
static java.util.List<Recipe>	getRecipes(java.lang.String basePath) Parses specified recipes base to list with recipe objects
static Scenario	getScenario(java.lang.String scenariosDir, java.lang.String scenarioId, org.newdawn.slick.GameContainer gc) Returns scenario with specified ID from file in specified directory
static Scenario	getScenarioFromSSG(java.lang.String ssgName, java.lang.String scenarioId) Returns scenario with specified specified ID from SSG file with specified name
static java.util.Map<java.lang.String,Scenario>	getScenarios(java.lang.String scenariosDir, org.newdawn.slick.GameContainer gc) Returns map with all scenarios from specified file with scenarios IDs
static Script	getScript(java.lang.String scriptFileName) Parses script with specified name in current module script dir
static java.util.Map<java.lang.String,TrinketPattern>	getTrinkets(java.lang.String basePath) Parses specified XML base and returns map with trinkets patterns
static java.util.Map<java.lang.String,WeaponPattern>	getWeapons(java.lang.String basePath) Parses specified XML base and returns map with weapon patterns

Methods inherited from class java.lang.Object

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

Field Detail

SIMSUN_FONT

public static final java.lang.String SIMSUN_FONT

Method Detail

getNpcMap

public static java.util.Map<java.lang.String,NpcPattern> getNpcMap(java.lang.String basePath)
                                                            throws javax.xml.parsers.ParserConfigurationException,
                                                                   org.xml.sax.SAXException,
                                                                   java.io.IOException

Parses XML NPC base to map with NPC IDs as keys assigned to specific NPC pattern

Parameters:

baseName - Name of base in data/npc dir

Returns:

Map with NPC IDs as keys assigned to specific NPC pattern

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getGuildsMap

public static java.util.Map<java.lang.String,Guild> getGuildsMap(java.lang.String basePath)
                                                          throws javax.xml.parsers.ParserConfigurationException,
                                                                 org.xml.sax.SAXException,
                                                                 java.io.IOException

Parses XML doc and builds map with guilds and guilds IDs as keys

Parameters:

baseFile - Name of xml file in data/npc dir

Returns:

Map with IDs and guilds

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getDialogueMap

public static java.util.Map<java.lang.String,Dialogue> getDialogueMap(java.lang.String basePath)
                                                               throws javax.xml.parsers.ParserConfigurationException,
                                                                      org.xml.sax.SAXException,
                                                                      java.io.IOException

Returns Map with dialogues map from specified base file

Parameters:

baseFile - XML base file

Returns:

HashMap with dialogues and npcs IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getAttacksMap

public static java.util.Map<java.lang.String,AttackPattern> getAttacksMap(java.lang.String basePath)
                                                                   throws org.xml.sax.SAXException,
                                                                          java.io.IOException,
                                                                          javax.xml.parsers.ParserConfigurationException

Parses XML base file and builds map with attacks patterns as values and its IDs as keys

Parameters:

baseFile - XML base file

Returns:

Map with attacks patterns as values and its IDs as keys

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getBuffsMap

public static java.util.Map<java.lang.String,BuffPattern> getBuffsMap(java.lang.String basePath)
                                                               throws org.xml.sax.SAXException,
                                                                      java.io.IOException,
                                                                      javax.xml.parsers.ParserConfigurationException

Parses XML base file and builds map with buffs patterns as values and its IDs as keys

Parameters:

baseFile - XML base file

Returns:

Map with buffs patterns as values and its IDs as keys

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getPassivesMap

public static java.util.Map<java.lang.String,PassivePattern> getPassivesMap(java.lang.String basePath)
                                                                     throws javax.xml.parsers.ParserConfigurationException,
                                                                            org.xml.sax.SAXException,
                                                                            java.io.IOException

Parses XML base file content and builds map with passive skills patterns as values and its IDs as keys

Parameters:

basePath - Path to XML base

Returns:

Map with skills patterns as values and its IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

getEffectsMap

public static java.util.Map<java.lang.String,EffectPattern> getEffectsMap(java.lang.String basePath)
                                                                   throws org.xml.sax.SAXException,
                                                                          java.io.IOException,
                                                                          javax.xml.parsers.ParserConfigurationException

Parses XML base file content to list with Effect objects

Parameters:

baseFile -

Returns:

ArrayList with all effects from base

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

getScenarios

public static java.util.Map<java.lang.String,Scenario> getScenarios(java.lang.String scenariosDir,
                                                                    org.newdawn.slick.GameContainer gc)
                                                             throws java.io.FileNotFoundException

Returns map with all scenarios from specified file with scenarios IDs

Parameters:

scenariosList - file with scenarios IDs from data/area/scenarios dir

Returns:

Map with scenarios as values and its IDs as keys

Throws:

java.io.FileNotFoundException

getScenario

public static Scenario getScenario(java.lang.String scenariosDir,
                                   java.lang.String scenarioId,
                                   org.newdawn.slick.GameContainer gc)
                            throws javax.xml.parsers.ParserConfigurationException,
                                   org.xml.sax.SAXException,
                                   java.io.IOException,
                                   org.newdawn.slick.SlickException,
                                   java.awt.FontFormatException

Returns scenario with specified ID from file in specified directory

Parameters:

scenariosDir - Directory with scenarios

scenarioId - Scenario ID

gc - Slick game container

Returns:

Game world area scenario or null if scenario with such ID was not found

Throws:

java.awt.FontFormatException

org.newdawn.slick.SlickException

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

getScenarioFromSSG

public static Scenario getScenarioFromSSG(java.lang.String ssgName,
                                          java.lang.String scenarioId)
                                   throws javax.xml.parsers.ParserConfigurationException,
                                          org.xml.sax.SAXException,
                                          java.io.IOException

Returns scenario with specified specified ID from SSG file with specified name

Parameters:

ssgName - Name of SSG file

scenarioId - Scenario ID

Returns:

Game world area scenario or null

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

getQuests

public static java.util.Map<java.lang.String,Quest> getQuests(java.lang.String basePath)
                                                       throws javax.xml.parsers.ParserConfigurationException,
                                                              org.xml.sax.SAXException,
                                                              java.io.IOException

Parses specified XML quest base file and returns map with quests ID's as keys and quest as values

Parameters:

questsBase - Base file name in data/quests dir

Returns:

Map with quests ID's as keys and quest as values

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getObjects

public static java.util.Map<java.lang.String,ObjectPattern> getObjects(java.lang.String basePath)
                                                                throws javax.xml.parsers.ParserConfigurationException,
                                                                       org.xml.sax.SAXException,
                                                                       java.io.IOException

Parses specified XML base with game objects to map with objects patterns as values and objects IDs as keys

Parameters:

objectsBase - Name of base file in data/objects

Returns:

Map with objects patterns as values and objects IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getWeapons

public static java.util.Map<java.lang.String,WeaponPattern> getWeapons(java.lang.String basePath)
                                                                throws javax.xml.parsers.ParserConfigurationException,
                                                                       org.xml.sax.SAXException,
                                                                       java.io.IOException

Parses specified XML base and returns map with weapon patterns

Parameters:

weaponsBase - Name of base file in data/item dir

Returns:

Map with weapon patterns as values and weapons IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getArmors

public static java.util.Map<java.lang.String,ArmorPattern> getArmors(java.lang.String basePath)
                                                              throws javax.xml.parsers.ParserConfigurationException,
                                                                     org.xml.sax.SAXException,
                                                                     java.io.IOException

Parses specified XML base and returns map with armor patterns

Parameters:

armorBase - Name of XML base in data/item dir

Returns:

Map with armor patterns as values and armor IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getTrinkets

public static java.util.Map<java.lang.String,TrinketPattern> getTrinkets(java.lang.String basePath)
                                                                  throws javax.xml.parsers.ParserConfigurationException,
                                                                         org.xml.sax.SAXException,
                                                                         java.io.IOException

Parses specified XML base and returns map with trinkets patterns

Parameters:

trinketsBase - Name of XML base in data/item dir

Returns:

Map with trinkets patterns as values and its IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getMisc

public static java.util.Map<java.lang.String,MiscPattern> getMisc(java.lang.String basePath)
                                                           throws javax.xml.parsers.ParserConfigurationException,
                                                                  org.xml.sax.SAXException,
                                                                  java.io.IOException

Returns map with miscellaneous item patterns as values and its IDs as keys

Parameters:

miscBase - Name of misc items base in data/item

Returns:

Map with miscellaneous item patterns as values and its IDs as keys

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getRecipes

public static java.util.List<Recipe> getRecipes(java.lang.String basePath)
                                         throws javax.xml.parsers.ParserConfigurationException,
                                                org.xml.sax.SAXException,
                                                java.io.IOException

Parses specified recipes base to list with recipe objects

Parameters:

recipesBase - String with recipes base name in data/item catalog

Returns:

List with recipes objects

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getScript

public static Script getScript(java.lang.String scriptFileName)
                        throws java.io.FileNotFoundException

Parses script with specified name in current module script dir

Parameters:

scriptFileName - Name of script in current module script dir

Returns:

List with commands for game CLI

Throws:

java.io.FileNotFoundException