atavism.agis.plugins
Class QuestPlugin

java.lang.Object
  atavism.server.engine.EnginePlugin
      atavism.agis.plugins.QuestPlugin

All Implemented Interfaces:

MessageCallback, StatusMapCallback

public class QuestPlugin
extends EnginePlugin

Handles requests for quest state information related to a player. manages all quest states for players.

Nested Class Summary

class	QuestPlugin.CanPlayerStartQuestHook
class	QuestPlugin.CategoryUpdatedHook
class	QuestPlugin.ConcludeQuestHook
class	QuestPlugin.GetQuestItemReqsHook
class	QuestPlugin.GetQuestStatusHook
class	QuestPlugin.NewQuestStateHook
class	QuestPlugin.OfferQuestsToPlayerHook
class	QuestPlugin.QuestResponseHook
class	QuestPlugin.QuestStatusChangedHook
class	QuestPlugin.QuestSubObjectHook
class	QuestPlugin.StartQuestHook Hook for the StartQuestMessage.

Nested classes/interfaces inherited from class atavism.server.engine.EnginePlugin

EnginePlugin.DeleteHook, EnginePlugin.DeleteSubObjHook, EnginePlugin.GenerateSubObjectHook, EnginePlugin.GetPropertyMessage, EnginePlugin.GetPropertyNamesMessage, EnginePlugin.LoadHook, EnginePlugin.LoadSubObjHook, EnginePlugin.PluginActivateHook, EnginePlugin.PluginStateMessage, EnginePlugin.SaveHook, EnginePlugin.SaveSubObjHook, EnginePlugin.SetPropertyMessage, EnginePlugin.SubObjData, EnginePlugin.TransferFilter, EnginePlugin.TransferObjectMessage, EnginePlugin.UnloadHook, EnginePlugin.UnloadSubObjHook

Field Summary

Fields inherited from class atavism.server.engine.EnginePlugin

deleteSubObjectSubscription, dumpAllThreadSubscription, dumpAllThreadSubscriptionLock, loadSubObjectSubscription, lock, MSG_TYPE_DUMP_ALL_THREAD_STACKS, MSG_TYPE_GET_PROPERTY, MSG_TYPE_GET_PROPERTY_NAMES, MSG_TYPE_PLUGIN_STATE, MSG_TYPE_SET_PROPERTY, MSG_TYPE_SET_PROPERTY_NONBLOCK, MSG_TYPE_TRANSFER_OBJECT, pluginStateSubscription, propertySubscription, saveSubObjectSubscription, selectionFilter, selectionSubscription, setSubObjectPersistenceSubscription, subObjectSubscription, unloadSubObjectSubscription

Fields inherited from interface atavism.msgsys.MessageCallback

NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

QuestPlugin()

Method Summary

protected static java.lang.String	getItemTemplateIcon(int templateID)
protected static java.lang.String	getItemTemplateName(int templateID)
static QuestStateInfo	getQuestStateInfo(OID oid)
void	onActivate() for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine.
protected void	registerHooks()
static void	registerQuestStateInfo(QuestStateInfo qsInfo)
static void	sendQuestHistoryLogInfo(OID playerOid) Sends down the QUEST_HISTORY_LOG_INFO message to the client with all of the information about a historical quest.
void	sendQuestInfo(OID playerOid, OID sourceOid, java.util.LinkedList<java.lang.Integer> questsOnOffer, boolean deleteItem)
static void	sendQuestLogInfo(OID playerOid, OID questOid, java.lang.String questTitle, java.lang.String questDesc, java.lang.String questObjective, int grades, java.util.HashMap<java.lang.Integer,java.lang.Integer> expRewards, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> currencyRewards, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> itemRewards, java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> itemRewardsToChoose, java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>> objectives, boolean questComplete) Sends down the QUEST_LOG_INFO message to the client with all of the information about a quest.
static void	sendQuestProgressInfo(OID playerOid, OID npcOid, java.util.LinkedList<QuestState> questsInProgress) Sends down information about the specified Quest that is currently in progress for the player.
static void	sendQuestStateInfo(OID playerOid, OID questOid, java.lang.Boolean complete, java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>> objectives) Sends down the updated stat of a Quest.
static void	sendRemoveQuestResp(OID playerOid, OID questOid)

Methods inherited from class atavism.server.engine.EnginePlugin

activate, createMBeanInstance, createSubscription, getHookManager, getMessageHandler, getName, getObjectLockManager, getObjectProperties, getObjectProperties, getObjectProperty, getObjectPropertyNames, getPercentCPULoad, getPluginAvailable, getPluginInfo, getPluginNamespaces, getPluginState, getPluginStatus, getPluginType, getPropertyImpl, getPropertyNamesImpl, getStatusMap, handleMessage, handleMessageImpl, logDepsOutstanding, processKeysAndValues, registerActivateHook, registerDeleteHook, registerLoadHook, registerPluginNamespace, registerPluginNamespaces, registerPluginNamespaces, registerPluginNamespaces, registerSaveHook, registerTransferHook, registerUnloadHook, sendSubObjectResponse, sendSubObjectResponse, sendSubObjectResponse, setMessageHandler, setName, setObjectProperties, setObjectProperties, setObjectProperties, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectPropertiesNoResponse, setObjectProperty, setObjectPropertyNoResponse, setPercentCPULoad, setPluginAvailable, setPluginInfo, setPluginType, setPropertyImpl, transferObject

Methods inherited from class java.lang.Object

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

Constructor Detail

QuestPlugin

public QuestPlugin()

Method Detail

onActivate

public void onActivate()

Description copied from class: EnginePlugin

for developers extending the EnginePlugin object, it may be easier to use the onActivate() method which gets called when the plugin is being activated by the Engine. this is an alternative to calling registerActivateHook()

Overrides:

onActivate in class EnginePlugin

registerHooks

protected void registerHooks()

getQuestStateInfo

public static QuestStateInfo getQuestStateInfo(OID oid)

registerQuestStateInfo

public static void registerQuestStateInfo(QuestStateInfo qsInfo)

getItemTemplateIcon

protected static java.lang.String getItemTemplateIcon(int templateID)

getItemTemplateName

protected static java.lang.String getItemTemplateName(int templateID)

sendRemoveQuestResp

public static void sendRemoveQuestResp(OID playerOid,
                                       OID questOid)

sendQuestLogInfo

public static void sendQuestLogInfo(OID playerOid,
                                    OID questOid,
                                    java.lang.String questTitle,
                                    java.lang.String questDesc,
                                    java.lang.String questObjective,
                                    int grades,
                                    java.util.HashMap<java.lang.Integer,java.lang.Integer> expRewards,
                                    java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> currencyRewards,
                                    java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> itemRewards,
                                    java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,java.lang.Integer>> itemRewardsToChoose,
                                    java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>> objectives,
                                    boolean questComplete)

Sends down the QUEST_LOG_INFO message to the client with all of the information about a quest.

Parameters:

playerOid -

questOid -

questTitle -

questDesc -

questObjective -

grades -

expRewards -

currencyRewards -

itemRewards -

itemRewardsToChoose -

objectives -

sendQuestHistoryLogInfo

public static void sendQuestHistoryLogInfo(OID playerOid)

Sends down the QUEST_HISTORY_LOG_INFO message to the client with all of the information about a historical quest.

Parameters:

playerOid -

sendQuestInfo

public void sendQuestInfo(OID playerOid,
                          OID sourceOid,
                          java.util.LinkedList<java.lang.Integer> questsOnOffer,
                          boolean deleteItem)

sendQuestStateInfo

public static void sendQuestStateInfo(OID playerOid,
                                      OID questOid,
                                      java.lang.Boolean complete,
                                      java.util.HashMap<java.lang.Integer,java.util.List<java.lang.String>> objectives)

Sends down the updated stat of a Quest. Used when the objective status for a Quest has been updated (for example, the player looted a Quest Item).

Parameters:

playerOid -

questOid -

complete -

objectives -

sendQuestProgressInfo

public static void sendQuestProgressInfo(OID playerOid,
                                         OID npcOid,
                                         java.util.LinkedList<QuestState> questsInProgress)

Sends down information about the specified Quest that is currently in progress for the player. The information is then displayed by the NPC who ends the Quest.

Parameters:

playerOid -

npcOid -

questsInProgress -