atavism.agis.plugins
Class AgisMobPlugin

java.lang.Object
  atavism.server.engine.EnginePlugin
      atavism.server.plugins.MobManagerPlugin
          atavism.agis.plugins.AgisMobPlugin

All Implemented Interfaces:

MessageCallback, StatusMapCallback

public class AgisMobPlugin
extends MobManagerPlugin

Nested Class Summary

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

static java.util.HashMap<OID,ObjectStub>	arenaSpawns
static java.lang.String	BEHAVIOR_TMPL_PROP
static boolean	EXP_BASED_ON_DAMAGE_DEALT
static boolean	LOOT_BASED_ON_DAMAGE_DEALT
static int	lootObjectDespawn
static int	lootObjectTmpl
static java.util.HashMap<java.lang.Integer,MerchantTable>	merchantTables
static float	MOB_AGGRO_CLOSE_RANGE_CHECK
static float	MOB_AGGRO_MELEE_THREAT_THRESHOLD
static float	MOB_AGGRO_RANGED_THREAT_THRESHOLD
static boolean	MOB_DEATH_EXP
static java.util.HashMap<java.lang.Integer,PatrolPoint>	patrolPoints
static int	PORTAL_Y_OFFSET
static int	TIME_MULTIPLIER

Fields inherited from class atavism.server.plugins.MobManagerPlugin

askedForPathInfo, log, pathInfo

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

AgisMobPlugin()

Method Summary

static boolean	accountHasDeveloperAccess(OID characterOID, OID accountID, int world) Checks if the player has Developer Access to the world, allowing them to modify spawns, and other world objects.
static boolean	AccountIsAdmin(OID accountOID)
static void	addMobToAlertOnDeath(OID targetOid, CombatBehavior cBehav)
static java.lang.String	createMobFactory(SpawnData sd) Creates a new ObjectFactory using the data provided by the spawn data.
static boolean	despawnArenaCreature(OID oid)
static java.lang.String	generateObjectKey(java.lang.String prefix)
static Dialogue	getDialogue(int dialogueID) Gets the dialogue matching the specified dialogueID.
int	GetIslandsCreated(OID accountOID)
protected BasicWorldNode	joinDungeonInstance(InstanceTemplate island, OID playerOid, java.lang.String markerName, Point loc, boolean requiresGroup)
protected BasicWorldNode	joinGuildInstance(InstanceTemplate island, OID playerOid, java.lang.String markerName, Point loc, java.lang.String suffix) Tries to move the player to a "Guild Instance" which will be specific to the suffix provided.
protected BasicWorldNode	joinPlayerInstance(InstanceTemplate island, OID playerOid, java.lang.String markerName, Point loc, java.lang.String suffix) Tries to move the player to a "Player Instance" which will be specific to the suffix provided.
protected BasicWorldNode	joinWorldInstance(InstanceTemplate island, OID playerOid, java.lang.String markerName, Point loc)
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	putMobCombatStats(Template tmpl, int level, int health)
static void	removeMobFromDeathAlert(CombatBehavior cBehav)
protected void	sendDialogueTemplates(OID playerOid)
protected void	sendFactionTemplates(OID playerOid)
protected void	sendIslandsData(OID playerOid, OID accountID)
protected void	sendLootTables(OID playerOid)
protected void	sendMerchantTables(OID playerOid)
protected void	sendMobTemplates(OID playerOid)
protected void	sendPatrolPoints(OID playerOid)
protected void	sendQuestTemplate(OID playerOid, int questID) Sends down the full details of a single quest
protected void	sendQuestTemplates(OID playerOid)
static void	setDisplay(OID oid, java.lang.String gender) Sets the display properties for the mob/npc based on their gender.
static void	setLootObjectDespawn(int duration) Sets the Loot Object Despawn Time.
static void	setLootObjectTmpl(int tmpl) Sets the Loot Object Template.

Methods inherited from class atavism.server.plugins.MobManagerPlugin

createObject, createObject, createObject, getPathInfo, getSpawnGeneratorClass, getTrackedObjectTypes, getTracker, registerHooks, registerSpawnGeneratorClass, removeTracker, setAggroRadiusTracker, setPathInfo, setTrackedObjectTypes

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

Field Detail

lootObjectTmpl

public static int lootObjectTmpl

lootObjectDespawn

public static int lootObjectDespawn

arenaSpawns

public static java.util.HashMap<OID,ObjectStub> arenaSpawns

merchantTables

public static java.util.HashMap<java.lang.Integer,MerchantTable> merchantTables

patrolPoints

public static java.util.HashMap<java.lang.Integer,PatrolPoint> patrolPoints

BEHAVIOR_TMPL_PROP

public static final java.lang.String BEHAVIOR_TMPL_PROP

See Also:

Constant Field Values

PORTAL_Y_OFFSET

public static final int PORTAL_Y_OFFSET

See Also:

Constant Field Values

TIME_MULTIPLIER

public static final int TIME_MULTIPLIER

See Also:

Constant Field Values

MOB_DEATH_EXP

public static boolean MOB_DEATH_EXP

EXP_BASED_ON_DAMAGE_DEALT

public static boolean EXP_BASED_ON_DAMAGE_DEALT

LOOT_BASED_ON_DAMAGE_DEALT

public static boolean LOOT_BASED_ON_DAMAGE_DEALT

MOB_AGGRO_CLOSE_RANGE_CHECK

public static float MOB_AGGRO_CLOSE_RANGE_CHECK

MOB_AGGRO_MELEE_THREAT_THRESHOLD

public static float MOB_AGGRO_MELEE_THREAT_THRESHOLD

MOB_AGGRO_RANGED_THREAT_THRESHOLD

public static float MOB_AGGRO_RANGED_THREAT_THRESHOLD

Constructor Detail

AgisMobPlugin

public AgisMobPlugin()

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 MobManagerPlugin

createMobFactory

public static java.lang.String createMobFactory(SpawnData sd)

Creates a new ObjectFactory using the data provided by the spawn data. The mob template name is obtained from a property in the spawn data.

Parameters:

sd: - the Spawn Data to create an object factory for

Returns:

String: the name of the object factory

setDisplay

public static void setDisplay(OID oid,
                              java.lang.String gender)

Sets the display properties for the mob/npc based on their gender.

Parameters:

oid -

gender -

despawnArenaCreature

public static boolean despawnArenaCreature(OID oid)

sendMobTemplates

protected void sendMobTemplates(OID playerOid)

sendPatrolPoints

protected void sendPatrolPoints(OID playerOid)

sendQuestTemplates

protected void sendQuestTemplates(OID playerOid)

sendQuestTemplate

protected void sendQuestTemplate(OID playerOid,
                                 int questID)

Sends down the full details of a single quest

Parameters:

playerOid -

sendDialogueTemplates

protected void sendDialogueTemplates(OID playerOid)

sendMerchantTables

protected void sendMerchantTables(OID playerOid)

sendFactionTemplates

protected void sendFactionTemplates(OID playerOid)

sendLootTables

protected void sendLootTables(OID playerOid)

sendIslandsData

protected void sendIslandsData(OID playerOid,
                               OID accountID)

GetIslandsCreated

public int GetIslandsCreated(OID accountOID)

joinWorldInstance

protected BasicWorldNode joinWorldInstance(InstanceTemplate island,
                                           OID playerOid,
                                           java.lang.String markerName,
                                           Point loc)

joinDungeonInstance

protected BasicWorldNode joinDungeonInstance(InstanceTemplate island,
                                             OID playerOid,
                                             java.lang.String markerName,
                                             Point loc,
                                             boolean requiresGroup)

joinPlayerInstance

protected BasicWorldNode joinPlayerInstance(InstanceTemplate island,
                                            OID playerOid,
                                            java.lang.String markerName,
                                            Point loc,
                                            java.lang.String suffix)

Tries to move the player to a "Player Instance" which will be specific to the suffix provided. This allows things like instanced housing or an instance that's part of a claim.

Parameters:

island -

playerOid -

markerName -

loc -

suffix -

Returns:

joinGuildInstance

protected BasicWorldNode joinGuildInstance(InstanceTemplate island,
                                           OID playerOid,
                                           java.lang.String markerName,
                                           Point loc,
                                           java.lang.String suffix)

Tries to move the player to a "Guild Instance" which will be specific to the suffix provided. This allows things like instanced housing or an instance that's part of a claim.

Parameters:

island -

playerOid -

markerName -

loc -

suffix -

Returns:

putMobCombatStats

protected void putMobCombatStats(Template tmpl,
                                 int level,
                                 int health)

AccountIsAdmin

public static boolean AccountIsAdmin(OID accountOID)

accountHasDeveloperAccess

public static boolean accountHasDeveloperAccess(OID characterOID,
                                                OID accountID,
                                                int world)

Checks if the player has Developer Access to the world, allowing them to modify spawns, and other world objects.

Parameters:

accountID -

world -

Returns:

generateObjectKey

public static java.lang.String generateObjectKey(java.lang.String prefix)

getDialogue

public static Dialogue getDialogue(int dialogueID)

Gets the dialogue matching the specified dialogueID. Should only be used within the mobserver process.

Parameters:

dialogueID -

Returns:

setLootObjectTmpl

public static void setLootObjectTmpl(int tmpl)

Sets the Loot Object Template. If specified, the loot object template will be spawned with the mobs loot instead of the mob having the loot.

Parameters:

prefab -

setLootObjectDespawn

public static void setLootObjectDespawn(int duration)

Sets the Loot Object Despawn Time.

Parameters:

prefab -

addMobToAlertOnDeath

public static void addMobToAlertOnDeath(OID targetOid,
                                        CombatBehavior cBehav)

removeMobFromDeathAlert

public static void removeMobFromDeathAlert(CombatBehavior cBehav)