Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface QuestManager

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

Quests

public interface QuestManager
extends CMLibrary

Manager for all game Quests and Holidays. Quests are scripts that make temporary modifications to the world, are trackable on players, and can be competitive or not. They can be created by writing a custom script, or using the QuestMaker Wizard based on templates. Holidays are a special time-based Quest and are managed in the same way as a normal Quest, while Archons see them as a separate system.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QuestManager.HolidayData	Interface for the raw definition data for a Holiday
static class	QuestManager.QMCommand	Enum of official data types for the QuestMaker Wizard templates.

Field Summary

Fields

Modifier and Type	Field	Description
static int	QM_COMMAND_MASK	MASK for QuestMaker QM COMMAND ORDINAL
static int	QM_COMMAND_OPTIONAL	MASK for QuestMaker QM COMMAND to mark it Optional

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
void	addQuest(Quest Q)	Given a Quest object, this will add the object to the cache, auto-starting it if necessary.
java.lang.String	alterHoliday(java.lang.String oldName, QuestManager.HolidayData newData)	Given the official name of an existing holiday, and a HolidayData data structure that was possibly altered, this will modify the existing holiday to reflect the new data.
java.util.List<java.util.List<java.lang.String>>	breakOutMudChatVs(java.lang.String MUDCHAT, TriadList<java.lang.String,java.lang.String,java.lang.Integer> behaviors)	Given a list of variables and their values, and the name of a variable, this will find the variable value that matches the variable name, and then return the list of definitions.
java.lang.String	createHoliday(java.lang.String named, java.lang.String areaName, boolean save)	Attempts to create and possibly save a holiday quest script where the holiday has the given name, and applies to the given area (or ANY).
java.lang.String	deleteHoliday(int holidayNumber)	Given an index, this deletes the associated holiday from the official holiday file completely.
void	delQuest(Quest Q)	Given an existing Quest in the cache, this will stop it if necesssary, and remove it.
java.util.Enumeration<Quest>	enumQuests()	Returns an enumeration of all cached Quest objects.
Quest	fetchQuest(int i)	Given a 0-based index into the Quest object cache, this will return the corresponding Quest.
Quest	fetchQuest(java.lang.String qname)	Returns the cached Quest with the given unique name.
Quest	findQuest(java.lang.String qname)	Given a unique quest name, or partial name, this will return the closest matching Quest from the internal cache.
java.lang.StringBuffer	getDefaultHoliData(java.lang.String named, java.lang.String area)	Generates a default Holiday quest script.
QuestManager.HolidayData	getEncodedHolidayData(java.lang.String dataFromStepsFile)	Given a quest script representing a Holiday, this will parse the script and generate a HolidayData object, usually for editing.
java.util.List<JournalEntry>	getHolidayEntries(boolean datedOnly)	Returns the various holidays as journal entries, where update is the start time, expiration is the end time, from is the creator (usually Holidays), to is the area list (unparsed) or ALL or "".
java.util.List<java.lang.String>	getHolidayFile()	Loads the official Holiday Quest Script, and parses it into its constituent steps, returning the list of sub-scripts.
int	getHolidayIndex(java.lang.String named)	Given a unique holiday name, this will return its index.
java.lang.String	getHolidayName(int index)	Given an index, this returns the unique name of the holiday at that index.
java.util.List<java.util.List<java.lang.String>>	getNextQuestScriptCommands(java.util.List<?> script, java.lang.String cmdOnly, int startLine)	Given a semi-parsed quest script and a starting line, this will return all lines, minus any JavaScript, between the startLine and the next STEP command, parsed into bits.
java.util.List<Quest>	getPlayerPersistentQuests(MOB player)	Given a player mob, this will return the list of quests that the player has accepted and not yet completed.
GenericEditor.CMEval	getQuestCommandEval(QuestManager.QMCommand command)	This is part of the QuestMaker.
DVector	getQuestTemplate(MOB mob, java.lang.String fileToGet)	Parses a Quest Template file into a data structure which no human, not even me, will ever fully unravel again.
java.lang.String	listHolidays(java.lang.String areaName)	Returns a nice displayable formatted list of all holidays and their associated areas.
void	modifyHoliday(MOB mob, int holidayNumber)	Given a player mob and a holiday number, this allows the given user to modify the holiday using the standard menu system.
int	numQuests()	Returns the number of Quest objects in the cache.
Quest	objectInUse(Environmental E)	Scans every Quest and returns the first one that is using the given MOB, Item, Area, Room, whatever.
java.util.List<java.lang.String>	parseQuestSteps(java.util.List<java.lang.String> script, int startLine, boolean rawLineInput)	Given a final quest script parsed into lines, and a starting line, this will return a list of mini-scripts broken by STEPs.
Quest	questMakerCommandLine(MOB mob)	Runs the Quest Maker Wizard process command line version for the given mob, returning the resulting Quest.
void	save()	Re-saves every quest in this manager to the database

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

QM_COMMAND_MASK

static final int QM_COMMAND_MASK

MASK for QuestMaker QM COMMAND ORDINAL

See Also:

Constant Field Values

QM_COMMAND_OPTIONAL

static final int QM_COMMAND_OPTIONAL

MASK for QuestMaker QM COMMAND to mark it Optional

See Also:

Constant Field Values

Method Detail

numQuests

int numQuests()

Returns the number of Quest objects in the cache.

Returns:

the number of Quests

See Also:

fetchQuest(int)

fetchQuest

Quest fetchQuest(int i)

Given a 0-based index into the Quest object cache, this will return the corresponding Quest.

Parameters:

i - the index

Returns:

null, or the Quest

See Also:

numQuests()

fetchQuest

Quest fetchQuest(java.lang.String qname)

Returns the cached Quest with the given unique name.

Parameters:

qname - the quest name

Returns:

null, or the Quest object

See Also:

findQuest(String), fetchQuest(int), enumQuests()

findQuest

Quest findQuest(java.lang.String qname)

Given a unique quest name, or partial name, this will return the closest matching Quest from the internal cache.

Parameters:

qname - the name of a quest

Returns:

null, or the Quest object

See Also:

fetchQuest(String), fetchQuest(int), enumQuests()

enumQuests

java.util.Enumeration<Quest> enumQuests()

Returns an enumeration of all cached Quest objects.

Returns:

all the quests

See Also:

delQuest(Quest), addQuest(Quest), fetchQuest(String)

addQuest

void addQuest(Quest Q)

Given a Quest object, this will add the object to the cache, auto-starting it if necessary.

Parameters:

Q - the Quest to delete

See Also:

delQuest(Quest), enumQuests(), fetchQuest(String)

delQuest

void delQuest(Quest Q)

Given an existing Quest in the cache, this will stop it if necesssary, and remove it.

Parameters:

Q - the Quest to delete

See Also:

addQuest(Quest), enumQuests(), fetchQuest(String)

listHolidays

java.lang.String listHolidays(java.lang.String areaName)

Returns a nice displayable formatted list of all holidays and their associated areas.

Parameters:

areaName - null or all, or area name

Returns:

the nice list of holidays

deleteHoliday

java.lang.String deleteHoliday(int holidayNumber)

Given an index, this deletes the associated holiday from the official holiday file completely.

Parameters:

holidayNumber - the 0-based index

Returns:

the result message (error, or happy)

See Also:

getHolidayIndex(String)

getHolidayName

java.lang.String getHolidayName(int index)

Given an index, this returns the unique name of the holiday at that index.

Parameters:

index - the 0-based index

Returns:

"" or the name of the indexed holiday

See Also:

getHolidayIndex(String), listHolidays(String)

getHolidayIndex

int getHolidayIndex(java.lang.String named)

Given a unique holiday name, this will return its index.

Parameters:

named - the unique name of the holiday

Returns:

-1, or the 0 based holiday index

See Also:

modifyHoliday(MOB, int), getHolidayName(int), deleteHoliday(int), listHolidays(String)

modifyHoliday

void modifyHoliday(MOB mob,
                   int holidayNumber)

Given a player mob and a holiday number, this allows the given user to modify the holiday using the standard menu system.

Parameters:

mob - the player mob to do the editing

holidayNumber - the holiday number (0 based)

See Also:

getHolidayIndex(String), alterHoliday(String, HolidayData), deleteHoliday(int)

alterHoliday

java.lang.String alterHoliday(java.lang.String oldName,
                              QuestManager.HolidayData newData)

Given the official name of an existing holiday, and a HolidayData data structure that was possibly altered, this will modify the existing holiday to reflect the new data. It then saves the holiday file.

Parameters:

oldName - the name of the existing holiday to modify

newData - the modified holiday data

Returns:

"", or any error message from the alteration

See Also:

QuestManager.HolidayData, getHolidayFile(), modifyHoliday(MOB, int)

createHoliday

java.lang.String createHoliday(java.lang.String named,
                               java.lang.String areaName,
                               boolean save)

Attempts to create and possibly save a holiday quest script where the holiday has the given name, and applies to the given area (or ANY).

Parameters:

named - the name of the holiday, unique plz

areaName - the name of the area (or ANY) the holiday occurs in

save - true to append to the official holiday file

Returns:

"", or any error message from the creation

See Also:

getDefaultHoliData(String, String)

getDefaultHoliData

java.lang.StringBuffer getDefaultHoliData(java.lang.String named,
                                          java.lang.String area)

Generates a default Holiday quest script.

Parameters:

named - the name of the holiday, unique plz

area - the name of the area (or ANY) the holiday occurs in

Returns:

the default holiday quest script

See Also:

createHoliday(String, String, boolean)

getHolidayFile

java.util.List<java.lang.String> getHolidayFile()
                                         throws CMException

Loads the official Holiday Quest Script, and parses it into its constituent steps, returning the list of sub-scripts.

Returns:

the steps of the holiday file

Throws:

CMException - a parsing error occurred

See Also:

getEncodedHolidayData(String), getHolidayEntries(boolean)

getHolidayEntries

java.util.List<JournalEntry> getHolidayEntries(boolean datedOnly)

Returns the various holidays as journal entries, where update is the start time, expiration is the end time, from is the creator (usually Holidays), to is the area list (unparsed) or ALL or "". Subject is the name of the holiday.

Parameters:

datedOnly - true to only return dated/muddate entries

Returns:

the list of holidays as journal entries.

See Also:

getEncodedHolidayData(String), getHolidayFile()

getEncodedHolidayData

QuestManager.HolidayData getEncodedHolidayData(java.lang.String dataFromStepsFile)

Given a quest script representing a Holiday, this will parse the script and generate a HolidayData object, usually for editing.

Parameters:

dataFromStepsFile - the holiday quest script

Returns:

the HolidayData structure

See Also:

QuestManager.HolidayData, getHolidayFile(), alterHoliday(String, HolidayData), getHolidayEntries(boolean)

breakOutMudChatVs

java.util.List<java.util.List<java.lang.String>> breakOutMudChatVs(java.lang.String MUDCHAT,
                                                                   TriadList<java.lang.String,java.lang.String,java.lang.Integer> behaviors)

Given a list of variables and their values, and the name of a variable, this will find the variable value that matches the variable name, and then return the list of definitions.

Parameters:

MUDCHAT - the mudchat variable name, usually "MUDCHAT"

behaviors - list of behavior variables, name, value, an integer

Returns:

the parsed list of mudchat definitions

getQuestTemplate

DVector getQuestTemplate(MOB mob,
                         java.lang.String fileToGet)

Parses a Quest Template file into a data structure which no human, not even me, will ever fully unravel again. I mean, it is unravelable, but the risk to breaking the codebase is enormous, so just trust me, leave it alone. This is all part of the QuestMaker system. The DVector is 5-part, consisting of: 1. name 2. description 3. filename 4. DVector list of pages -- Page is 4-part list, each representing a variable, except the first entry, which is page type, name, description Variables are: 1. var type code (Integer), 2. name, 3. default value, 4. final value 5. Final Quest Script as a StringBuffer

Parameters:

mob - player mob, for file permission reasons

fileToGet - the template filename to load

Returns:

the evil data structure

See Also:

getQuestTemplate(MOB, String), questMakerCommandLine(MOB), getQuestCommandEval(QMCommand)

questMakerCommandLine

Quest questMakerCommandLine(MOB mob)

Runs the Quest Maker Wizard process command line version for the given mob, returning the resulting Quest.

Parameters:

mob - the player who wants to create a Quest

Returns:

null, or the Quest created

See Also:

getQuestTemplate(MOB, String), questMakerCommandLine(MOB), getQuestCommandEval(QMCommand)

getQuestCommandEval

GenericEditor.CMEval getQuestCommandEval(QuestManager.QMCommand command)

This is part of the QuestMaker. Given a QMCommand, which is a QuestMaker script variable type, this will return an Eval object that can be used to populate a value for the variable of that type.

Parameters:

command - the quest maker variable type

Returns:

the CMEval object for that variable type

See Also:

getQuestTemplate(MOB, String), questMakerCommandLine(MOB), getQuestCommandEval(QMCommand), QuestManager.QMCommand, GenericEditor.CMEval

getPlayerPersistentQuests

java.util.List<Quest> getPlayerPersistentQuests(MOB player)

Given a player mob, this will return the list of quests that the player has accepted and not yet completed. These are the quests that the player is currently "on".

Parameters:

player - the player mob

Returns:

the list of quests the player is on

objectInUse

Quest objectInUse(Environmental E)

Scans every Quest and returns the first one that is using the given MOB, Item, Area, Room, whatever.

Parameters:

E - the object to find the Quest user of

Returns:

null, or the first Quest using

save

void save()

Re-saves every quest in this manager to the database

parseQuestSteps

java.util.List<java.lang.String> parseQuestSteps(java.util.List<java.lang.String> script,
                                                 int startLine,
                                                 boolean rawLineInput)

Given a final quest script parsed into lines, and a starting line, this will return a list of mini-scripts broken by STEPs.

Parameters:

script - the final lines of the entire quest script

startLine - the line to start breaking at

rawLineInput - false to manage ; line endings, true to leave raw

Returns:

the mini-scripts, cr delimited, broken into steps

getNextQuestScriptCommands

java.util.List<java.util.List<java.lang.String>> getNextQuestScriptCommands(java.util.List<?> script,
                                                                            java.lang.String cmdOnly,
                                                                            int startLine)

Given a semi-parsed quest script and a starting line, this will return all lines, minus any JavaScript, between the startLine and the next STEP command, parsed into bits. If a cmdOnly is given it will filter only by those commands.

Parameters:

script - the complete quest script parsed

cmdOnly - null, or a command to filter the script by

startLine - 0 - the line in the given script to start with

Returns:

the lines of the script, parsed into bits the normal way