pl.isangeles.senlin.core

Class Chapter

java.lang.Object

pl.isangeles.senlin.core.Chapter

All Implemented Interfaces:

SaveElement

public class Chapter
extends java.lang.Object
implements SaveElement

Class for game chapters

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
Chapter(java.lang.String id, java.util.List<SavedScenario> savedScenarios, Scenario startScenario, org.newdawn.slick.GameContainer gc) Chapter constructor
Chapter(java.lang.String id, java.lang.String startScenario, org.newdawn.slick.GameContainer gc) Chapter constructor

Method Summary

Modifier and Type	Method and Description
boolean	containsScenario(java.lang.String scenarioId) Checks if this chapter contains scenario with specified ID
Scenario	getActiveScenario() Returns active scenario
Character	getCharacter(java.lang.String serial) Returns character with specified ID from all spawned character in this chapter
java.lang.String	getId()
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
Scenario	getScenario(java.lang.String scenarioId, org.newdawn.slick.GameContainer gc) Returns scenario with specified ID from scenarios list
java.util.List<Scenario>	getScenarios() Returns all loaded(visited) scenarios of this chapter
Targetable	getTObject(java.lang.String tObId) Returns targetable object with specified ID from all spawned object in this chapter
boolean	removeTObject(Targetable obToRemove) Removes specified targetable object from chapter
boolean	setScenario(java.lang.String scenarioId, org.newdawn.slick.GameContainer gc) Sets scenario with specified ID as active scenario
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Chapter

public Chapter(java.lang.String id,
               java.lang.String startScenario,
               org.newdawn.slick.GameContainer gc)

Chapter constructor

Parameters:

id - Chapter ID

startScenario - Start scenario

Chapter

public Chapter(java.lang.String id,
               java.util.List<SavedScenario> savedScenarios,
               Scenario startScenario,
               org.newdawn.slick.GameContainer gc)
        throws java.lang.NumberFormatException,
               org.w3c.dom.DOMException,
               org.newdawn.slick.SlickException,
               java.io.IOException,
               java.awt.FontFormatException

Chapter constructor

Parameters:

id - Chapter ID

scenarios - List of scenarios

startScenario - Start scenario

Throws:

java.awt.FontFormatException

java.io.IOException

org.newdawn.slick.SlickException

org.w3c.dom.DOMException

java.lang.NumberFormatException

Method Detail

getId

public java.lang.String getId()

getScenario

public Scenario getScenario(java.lang.String scenarioId,
                            org.newdawn.slick.GameContainer gc)

Returns scenario with specified ID from scenarios list

Parameters:

scenarioId - String with desired scenario ID

Returns:

Scenario with specified ID or null if not such scenario was found

containsScenario

public boolean containsScenario(java.lang.String scenarioId)

Checks if this chapter contains scenario with specified ID

Parameters:

scenarioId - String with scenario ID

Returns:

True if this character contains scenario with specified ID

getActiveScenario

public Scenario getActiveScenario()

Returns active scenario

Returns:

Active chapter scenario

getScenarios

public java.util.List<Scenario> getScenarios()

Returns all loaded(visited) scenarios of this chapter

Returns:

List with scenarios

getCharacter

public Character getCharacter(java.lang.String serial)

Returns character with specified ID from all spawned character in this chapter

Parameters:

serial - Character serial ID

Returns:

Character with specified serial ID or null if no character with such serial ID found

getTObject

public Targetable getTObject(java.lang.String tObId)

Returns targetable object with specified ID from all spawned object in this chapter

Parameters:

tObId - Targetable object ID

Returns:

Targetable object with specified ID

removeTObject

public boolean removeTObject(Targetable obToRemove)

Removes specified targetable object from chapter

Parameters:

obToRemove - Targetable object to remove

Returns:

True if specified object was successfully removed, false otherwise

setScenario

public boolean setScenario(java.lang.String scenarioId,
                           org.newdawn.slick.GameContainer gc)

Sets scenario with specified ID as active scenario

Parameters:

scenarioId - Scenario ID

Returns:

True if scenario with specified ID was successfully set as active scenario, false otherwise

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Description copied from interface: SaveElement

Parses object to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - XML document for save game

Returns:

XML document element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object