atavism.agis.plugins
Class AgisMobClient

java.lang.Object
  atavism.agis.plugins.AgisMobClient

public class AgisMobClient
extends java.lang.Object

AGIS-specific calls for sending/getting messages to the AgisInventoryPlugin

Nested Class Summary

static class	AgisMobClient.addTargetToCheckMessage Obsolete, to be deleted.
static class	AgisMobClient.categoryUpdatedMessage Message used to indicate the category of islands/worlds the player is in has changed.
static class	AgisMobClient.createAvatarCloneMessage Message indicating that a clone of the player is to be created in the specified instance.
static class	AgisMobClient.DeleteSpawnGeneratorMessage
static class	AgisMobClient.DialogueOptionChosenMessage Message used to indicate what option a player has chosen from a dialogue.
static class	AgisMobClient.GetInstanceTemplateMessage
static class	AgisMobClient.getIslandsDataMessage Message used to request the list of islands to be sent down to the player.
static class	AgisMobClient.GetNpcInteractionsMessage Message used for requesting the list of interactions the NPC specified has available to be sent to the client.
static class	AgisMobClient.InvalidPathMessage Message used to indicate what option a player has chosen from a dialogue.
static class	AgisMobClient.petCommandUpdateMessage Message used to update the behaviour for the pet.
static class	AgisMobClient.petTargetLostMessage Message used to indicate the Pet has lost its target and should change its current action.
static class	AgisMobClient.removeTargetToCheckMessage Obsolete, to be deleted.
static class	AgisMobClient.sendPetCommandMessage Message used to update the summoned pets command.
static class	AgisMobClient.spawnArenaCreatureMessage Message used to spawn a creature in an Arena Instance.
static class	AgisMobClient.SpawnInstanceMobsMessage
static class	AgisMobClient.SpawnMobMessage
static class	AgisMobClient.spawnPetMessage Message used to spawn a pet for a player
static class	AgisMobClient.StartNpcInteractionMessage Message used to start the specified NPC interaction.
static class	AgisMobClient.tameBeastMessage Message used to indicate a beast has been tamed.
static class	AgisMobClient.targetInReactionRangeMessage Obsolete, to be deleted.
static class	AgisMobClient.updatePetStatsMessage Message used to update the stats for a pet based on its level.

Field Summary

static MessageType	MSG_TYPE_ACTIVATE_DOME_ABILITY
static MessageType	MSG_TYPE_ADD_TARGET_TO_CHECK
static MessageType	MSG_TYPE_CATEGORY_UPDATED
static MessageType	MSG_TYPE_CREATE_AVATAR_CLONE
static MessageType	MSG_TYPE_CREATE_BUILDING
static MessageType	MSG_TYPE_CREATE_FACTION
static MessageType	MSG_TYPE_CREATE_ISLAND
static MessageType	MSG_TYPE_CREATE_LOOT_TABLE
static MessageType	MSG_TYPE_CREATE_MOB
static MessageType	MSG_TYPE_CREATE_MOB_SPAWN
static MessageType	MSG_TYPE_CREATE_NYTS_CLONES
static MessageType	MSG_TYPE_CREATE_QUEST
static MessageType	MSG_TYPE_DELETE_SPAWN_GENERATOR
static MessageType	MSG_TYPE_DELETE_SPAWN_MARKER
static MessageType	MSG_TYPE_DESPAWN_CLONES
static MessageType	MSG_TYPE_DETECT_BUILDING_GRIDS
static MessageType	MSG_TYPE_DIALOGUE_OPTION_CHOSEN
static MessageType	MSG_TYPE_DOME_ENQUIRY
static MessageType	MSG_TYPE_DOME_ENTRY_REQUEST
static MessageType	MSG_TYPE_DOME_LEAVE_REQUEST
static MessageType	MSG_TYPE_EDIT_FACTION
static MessageType	MSG_TYPE_EDIT_MOB
static MessageType	MSG_TYPE_EDIT_QUEST
static MessageType	MSG_TYPE_EDIT_SPAWN_MARKER
static MessageType	MSG_TYPE_ENTER_WORLD
static MessageType	MSG_TYPE_GET_BUILDING_GRID_DATA
static MessageType	MSG_TYPE_GET_INSTANCE_TEMPLATE
static MessageType	MSG_TYPE_GET_INTERACTION_OPTIONS
static MessageType	MSG_TYPE_GET_ISLANDS_DATA
static MessageType	MSG_TYPE_GET_TEMPLATES
static MessageType	MSG_TYPE_HARVEST_RESOURCE_GRID
static MessageType	MSG_TYPE_INTERACT_WITH_OBJECT
static MessageType	MSG_TYPE_INVALID_PATH
static MessageType	MSG_TYPE_MOB_KILLED
static MessageType	MSG_TYPE_OBJECT_ACTIVATED
static MessageType	MSG_TYPE_PERFORM_GESTURE
static MessageType	MSG_TYPE_PET_COMMAND_UPDATE
static MessageType	MSG_TYPE_PET_TARGET_LOST
static MessageType	MSG_TYPE_PLAY_COORD_EFFECT
static MessageType	MSG_TYPE_PURCHASE_BUILDING_GRID
static MessageType	MSG_TYPE_REMOVE_TARGET_TO_CHECK
static MessageType	MSG_TYPE_REQUEST_DEVELOPER_ACCESS
static MessageType	MSG_TYPE_REQUEST_SPAWN_DATA
static MessageType	MSG_TYPE_SEND_PET_COMMAND
static MessageType	MSG_TYPE_SET_BLOCK
static MessageType	MSG_TYPE_SPAWN_ARENA_CREATURE
static MessageType	MSG_TYPE_SPAWN_DOME_MOB
static MessageType	MSG_TYPE_SPAWN_INSTANCE_MOBS
static MessageType	MSG_TYPE_SPAWN_MOB
static MessageType	MSG_TYPE_SPAWN_PET
static MessageType	MSG_TYPE_START_DIALOGUE
static MessageType	MSG_TYPE_START_INTERACTION
static MessageType	MSG_TYPE_TAME_BEAST
static MessageType	MSG_TYPE_TARGET_IN_REACTION_RANGE
static MessageType	MSG_TYPE_UPDATE_PET_STATS
static MessageType	MSG_TYPE_USE_TRAP_DOOR
static MessageType	MSG_TYPE_VERIFY_ISLAND_ACCESS
static MessageType	MSG_TYPE_VIEW_MARKERS

Constructor Summary

AgisMobClient()

Method Summary

static void	addTargetToCheck(OID oid, OID targetOid) Obsolete, to be deleted.
static void	categoryUpdated(OID oid, int category) Sends the categoryUpdatedMessage which lets subobjects know to change their current category setting.
static void	chooseDialogueOption(OID oid, OID playerOid, int dialogueID, int actionID, java.lang.String interactionType) Sends DialogueOptionChosenMessage alerting the NPC that the player has chosen a dialogue option.
static void	createAvatarClone(java.lang.Long oid, java.lang.Long instanceOid) Sends the createAvatarCloneMessage which will create a clone NPC of the player.
static void	deleteSpawnGenerator(java.lang.String spawnGeneratorName, OID instanceOid)
static InstanceTemplate	getInstanceTemplate(int instanceTemplateID)
static void	getIslandsData(OID oid) Sends the getIslandsDataMessage which results in a list of islands being sent to the player.
static void	getNpcInteractions(OID oid, OID playerOid) Sends the GetNpcInteractionsMessage which requests a list of possible interactions with the specified NPC to be sent to the client.
static void	petCommandUpdate(OID oid, int command, OID target) Sends the petCommandUpdateMessage which will update the pets behaviour.
static void	petTargetLost(OID oid) Sends the petTargetLostMessage which will cause the pet to follow the owner if it was in attack mode.
static void	removeTargetToCheck(OID oid, OID targetOid) Obsolete, to be deleted.
static void	sendInvalidPath(OID mobOid)
static void	sendPetCommand(OID oid, OID targetOid, java.lang.String command) Sends the sendPetCommandMessage which will try to update the summoned pets command.
static void	spawnArenaCreature(int spawnDataID, int arenaID, OID instanceOid) Sends the spawnArenaCreatureMessage which will spawn a mob based on the spawnData specified in the arena instance.
static void	spawnInstanceObjects(InstanceTemplate tmpl, OID instanceOid)
static void	spawnMob(int spawnDataID, Point loc, Quaternion orient, OID instanceOid, boolean oneOffSpawn)
static void	spawnMob(SpawnData sd)
static void	spawnPet(OID oid, java.io.Serializable mobName, int petType, java.lang.Long duration, int passiveEffect, int skillType) Sends the spawnPetMessage which will spawn a pet for the player in question.
static void	startNpcInteraction(OID oid, OID playerOid, int interactionID, java.lang.String interactionType) Sends the StartNpcInteractionMessage alerting the NPC to start the specified interaction.
static void	tameBeast(OID oid, OID mobOid, int skillType) Sends the TameBeastMessage which indicates the player has tamed a beast.
static void	targetInReactionRange(OID oid, OID targetOid, float distance) Obsolete, to be deleted.
static void	updatePetStats(OID oid, OID mobOid, int level, int baseStat) Sends the UpdatePetStatsMessage.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_TYPE_GET_INSTANCE_TEMPLATE

public static final MessageType MSG_TYPE_GET_INSTANCE_TEMPLATE

MSG_TYPE_SPAWN_INSTANCE_MOBS

public static final MessageType MSG_TYPE_SPAWN_INSTANCE_MOBS

MSG_TYPE_SPAWN_MOB

public static final MessageType MSG_TYPE_SPAWN_MOB

MSG_TYPE_DELETE_SPAWN_GENERATOR

public static final MessageType MSG_TYPE_DELETE_SPAWN_GENERATOR

MSG_TYPE_CREATE_AVATAR_CLONE

public static final MessageType MSG_TYPE_CREATE_AVATAR_CLONE

MSG_TYPE_CREATE_NYTS_CLONES

public static final MessageType MSG_TYPE_CREATE_NYTS_CLONES

MSG_TYPE_PERFORM_GESTURE

public static final MessageType MSG_TYPE_PERFORM_GESTURE

MSG_TYPE_DESPAWN_CLONES

public static final MessageType MSG_TYPE_DESPAWN_CLONES

MSG_TYPE_SPAWN_ARENA_CREATURE

public static final MessageType MSG_TYPE_SPAWN_ARENA_CREATURE

MSG_TYPE_SPAWN_PET

public static final MessageType MSG_TYPE_SPAWN_PET

MSG_TYPE_TAME_BEAST

public static final MessageType MSG_TYPE_TAME_BEAST

MSG_TYPE_PET_COMMAND_UPDATE

public static final MessageType MSG_TYPE_PET_COMMAND_UPDATE

MSG_TYPE_SEND_PET_COMMAND

public static final MessageType MSG_TYPE_SEND_PET_COMMAND

MSG_TYPE_UPDATE_PET_STATS

public static final MessageType MSG_TYPE_UPDATE_PET_STATS

MSG_TYPE_PET_TARGET_LOST

public static final MessageType MSG_TYPE_PET_TARGET_LOST

MSG_TYPE_TARGET_IN_REACTION_RANGE

public static final MessageType MSG_TYPE_TARGET_IN_REACTION_RANGE

MSG_TYPE_ADD_TARGET_TO_CHECK

public static final MessageType MSG_TYPE_ADD_TARGET_TO_CHECK

MSG_TYPE_REMOVE_TARGET_TO_CHECK

public static final MessageType MSG_TYPE_REMOVE_TARGET_TO_CHECK

MSG_TYPE_MOB_KILLED

public static final MessageType MSG_TYPE_MOB_KILLED

MSG_TYPE_OBJECT_ACTIVATED

public static final MessageType MSG_TYPE_OBJECT_ACTIVATED

MSG_TYPE_DETECT_BUILDING_GRIDS

public static final MessageType MSG_TYPE_DETECT_BUILDING_GRIDS

MSG_TYPE_GET_BUILDING_GRID_DATA

public static final MessageType MSG_TYPE_GET_BUILDING_GRID_DATA

MSG_TYPE_PURCHASE_BUILDING_GRID

public static final MessageType MSG_TYPE_PURCHASE_BUILDING_GRID

MSG_TYPE_CREATE_BUILDING

public static final MessageType MSG_TYPE_CREATE_BUILDING

MSG_TYPE_USE_TRAP_DOOR

public static final MessageType MSG_TYPE_USE_TRAP_DOOR

MSG_TYPE_HARVEST_RESOURCE_GRID

public static final MessageType MSG_TYPE_HARVEST_RESOURCE_GRID

MSG_TYPE_SET_BLOCK

public static final MessageType MSG_TYPE_SET_BLOCK

MSG_TYPE_GET_INTERACTION_OPTIONS

public static final MessageType MSG_TYPE_GET_INTERACTION_OPTIONS

MSG_TYPE_START_INTERACTION

public static final MessageType MSG_TYPE_START_INTERACTION

MSG_TYPE_DIALOGUE_OPTION_CHOSEN

public static final MessageType MSG_TYPE_DIALOGUE_OPTION_CHOSEN

MSG_TYPE_START_DIALOGUE

public static final MessageType MSG_TYPE_START_DIALOGUE

MSG_TYPE_INTERACT_WITH_OBJECT

public static final MessageType MSG_TYPE_INTERACT_WITH_OBJECT

MSG_TYPE_INVALID_PATH

public static final MessageType MSG_TYPE_INVALID_PATH

MSG_TYPE_GET_TEMPLATES

public static final MessageType MSG_TYPE_GET_TEMPLATES

MSG_TYPE_CREATE_MOB_SPAWN

public static final MessageType MSG_TYPE_CREATE_MOB_SPAWN

MSG_TYPE_CREATE_QUEST

public static final MessageType MSG_TYPE_CREATE_QUEST

MSG_TYPE_EDIT_QUEST

public static final MessageType MSG_TYPE_EDIT_QUEST

MSG_TYPE_GET_ISLANDS_DATA

public static final MessageType MSG_TYPE_GET_ISLANDS_DATA

MSG_TYPE_VERIFY_ISLAND_ACCESS

public static final MessageType MSG_TYPE_VERIFY_ISLAND_ACCESS

MSG_TYPE_ENTER_WORLD

public static final MessageType MSG_TYPE_ENTER_WORLD

MSG_TYPE_CATEGORY_UPDATED

public static final MessageType MSG_TYPE_CATEGORY_UPDATED

MSG_TYPE_REQUEST_DEVELOPER_ACCESS

public static final MessageType MSG_TYPE_REQUEST_DEVELOPER_ACCESS

MSG_TYPE_CREATE_ISLAND

public static final MessageType MSG_TYPE_CREATE_ISLAND

MSG_TYPE_VIEW_MARKERS

public static final MessageType MSG_TYPE_VIEW_MARKERS

MSG_TYPE_REQUEST_SPAWN_DATA

public static final MessageType MSG_TYPE_REQUEST_SPAWN_DATA

MSG_TYPE_EDIT_SPAWN_MARKER

public static final MessageType MSG_TYPE_EDIT_SPAWN_MARKER

MSG_TYPE_DELETE_SPAWN_MARKER

public static final MessageType MSG_TYPE_DELETE_SPAWN_MARKER

MSG_TYPE_CREATE_MOB

public static final MessageType MSG_TYPE_CREATE_MOB

MSG_TYPE_EDIT_MOB

public static final MessageType MSG_TYPE_EDIT_MOB

MSG_TYPE_CREATE_FACTION

public static final MessageType MSG_TYPE_CREATE_FACTION

MSG_TYPE_EDIT_FACTION

public static final MessageType MSG_TYPE_EDIT_FACTION

MSG_TYPE_CREATE_LOOT_TABLE

public static final MessageType MSG_TYPE_CREATE_LOOT_TABLE

MSG_TYPE_SPAWN_DOME_MOB

public static final MessageType MSG_TYPE_SPAWN_DOME_MOB

MSG_TYPE_DOME_ENQUIRY

public static final MessageType MSG_TYPE_DOME_ENQUIRY

MSG_TYPE_DOME_ENTRY_REQUEST

public static final MessageType MSG_TYPE_DOME_ENTRY_REQUEST

MSG_TYPE_DOME_LEAVE_REQUEST

public static final MessageType MSG_TYPE_DOME_LEAVE_REQUEST

MSG_TYPE_ACTIVATE_DOME_ABILITY

public static final MessageType MSG_TYPE_ACTIVATE_DOME_ABILITY

MSG_TYPE_PLAY_COORD_EFFECT

public static final MessageType MSG_TYPE_PLAY_COORD_EFFECT

Constructor Detail

AgisMobClient

public AgisMobClient()

Method Detail

getInstanceTemplate

public static InstanceTemplate getInstanceTemplate(int instanceTemplateID)

spawnInstanceObjects

public static void spawnInstanceObjects(InstanceTemplate tmpl,
                                        OID instanceOid)

spawnMob

public static void spawnMob(SpawnData sd)

spawnMob

public static void spawnMob(int spawnDataID,
                            Point loc,
                            Quaternion orient,
                            OID instanceOid,
                            boolean oneOffSpawn)

deleteSpawnGenerator

public static void deleteSpawnGenerator(java.lang.String spawnGeneratorName,
                                        OID instanceOid)

createAvatarClone

public static void createAvatarClone(java.lang.Long oid,
                                     java.lang.Long instanceOid)

Sends the createAvatarCloneMessage which will create a clone NPC of the player. Has not been tested recently.

spawnArenaCreature

public static void spawnArenaCreature(int spawnDataID,
                                      int arenaID,
                                      OID instanceOid)

Sends the spawnArenaCreatureMessage which will spawn a mob based on the spawnData specified in the arena instance.

spawnPet

public static void spawnPet(OID oid,
                            java.io.Serializable mobName,
                            int petType,
                            java.lang.Long duration,
                            int passiveEffect,
                            int skillType)

Sends the spawnPetMessage which will spawn a pet for the player in question.

tameBeast

public static void tameBeast(OID oid,
                             OID mobOid,
                             int skillType)

Sends the TameBeastMessage which indicates the player has tamed a beast.

Parameters:

oid -

mobOid -

skillType -

petCommandUpdate

public static void petCommandUpdate(OID oid,
                                    int command,
                                    OID target)

Sends the petCommandUpdateMessage which will update the pets behaviour. Usually called from the Pet class.

sendPetCommand

public static void sendPetCommand(OID oid,
                                  OID targetOid,
                                  java.lang.String command)

Sends the sendPetCommandMessage which will try to update the summoned pets command. Usually called from a client command.

updatePetStats

public static void updatePetStats(OID oid,
                                  OID mobOid,
                                  int level,
                                  int baseStat)

Sends the UpdatePetStatsMessage. Not too sure where it goes from here.

Parameters:

oid -

mobOid -

level -

baseStat -

petTargetLost

public static void petTargetLost(OID oid)

Sends the petTargetLostMessage which will cause the pet to follow the owner if it was in attack mode.

targetInReactionRange

public static void targetInReactionRange(OID oid,
                                         OID targetOid,
                                         float distance)

Obsolete, to be deleted.

Parameters:

oid -

targetOid -

distance -

addTargetToCheck

public static void addTargetToCheck(OID oid,
                                    OID targetOid)

Obsolete, to be deleted.

Parameters:

oid -

targetOid -

removeTargetToCheck

public static void removeTargetToCheck(OID oid,
                                       OID targetOid)

Obsolete, to be deleted.

Parameters:

oid -

targetOid -

getIslandsData

public static void getIslandsData(OID oid)

Sends the getIslandsDataMessage which results in a list of islands being sent to the player. Wants renamed to instances or worlds.

categoryUpdated

public static void categoryUpdated(OID oid,
                                   int category)

Sends the categoryUpdatedMessage which lets subobjects know to change their current category setting.

getNpcInteractions

public static void getNpcInteractions(OID oid,
                                      OID playerOid)

Sends the GetNpcInteractionsMessage which requests a list of possible interactions with the specified NPC to be sent to the client.

Parameters:

oid -

playerOid -

startNpcInteraction

public static void startNpcInteraction(OID oid,
                                       OID playerOid,
                                       int interactionID,
                                       java.lang.String interactionType)

Sends the StartNpcInteractionMessage alerting the NPC to start the specified interaction.

chooseDialogueOption

public static void chooseDialogueOption(OID oid,
                                        OID playerOid,
                                        int dialogueID,
                                        int actionID,
                                        java.lang.String interactionType)

Sends DialogueOptionChosenMessage alerting the NPC that the player has chosen a dialogue option.

sendInvalidPath

public static void sendInvalidPath(OID mobOid)