com.planet_ink.coffee_mud.MOBS.interfaces
Interface MOB

All Superinterfaces:
AbilityContainer, Affectable, Behavable, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, DBIdentifiable, Environmental, ItemCollection, ItemPossessor, Modifiable, MsgListener, Physical, PhysicalAgent, Rider, StatsAffecting, Tickable
All Known Subinterfaces:
Deity
All Known Implementing Classes:
AngryCitizen, Ape, Assassin, Bee, BlackBear, BlackDragon, BlueDragon, BrassDragon, BronzeDragon, BrownBear, Buck, Buffalo, Bugbear, Bull, Cat, Centaur, Cheetah, Chicken, Chimp, Citizen, Cobra, CommonBat, CopperDragon, Cow, Deer, Doe, Dog, Doppleganger, Dragon, DrowElf, DrowPriestess, DrowWarrior, DrowWizard, Duck, Falcon, FireGiant, Fox, GardenSnake, GenAuctioneer, GenBanker, GenDeity, GenMob, GenPostman, GenRideable, GenShopkeeper, GenUndead, GiantBat, GiantScorpion, Gnoll, Goblin, GoldDragon, Gorilla, GreenDragon, HeavenlyServent, HillGiant, Horse, InvisibleStalker, Jaguar, Kitten, LargeBat, Lion, Lizard, LizardMan, LizardManShaman, Minotaur, Monkey, Mouse, Ogre, Orc, Panther, Parakeet, Pegasus, PegasusGreater, Pig, Puppy, Python, Rabbit, Rat, Rattlesnake, Raven, RedDragon, Sheep, SilverDragon, Skeleton, StdAuctioneer, StdBanker, StdDeity, StdFactoryMOB, StdMOB, StdPostman, StdRideable, StdShopKeeper, StoneGiant, StoneGolem, Teacher, Tiger, Troll, Turtle, UmberHulk, Undead, WhiteDragon, WildEagle, Wolf, Wyvern, Zombie

public interface MOB
extends Rider, DBIdentifiable, PhysicalAgent, ItemPossessor, AbilityContainer


Nested Class Summary
static class MOB.Follower
           
static class MOB.QMCommand
           
static class MOB.Tattoo
           
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor
ItemPossessor.Expire, ItemPossessor.Find, ItemPossessor.Move
 
Field Summary
static long AGE_MILLIS_THRESHOLD
           
static int ATT_ANSI
           
static int ATT_AUTOASSIST
           
static int ATT_AUTODRAW
           
static int ATT_AUTOEXITS
           
static int ATT_AUTOFORWARD
           
static int ATT_AUTOGOLD
           
static int ATT_AUTOGUARD
           
static int ATT_AUTOIMPROVE
           
static int ATT_AUTOLOOT
           
static int ATT_AUTOMAP
           
static int ATT_AUTOMELEE
           
static int ATT_AUTONOTIFY
           
static int ATT_AUTORUN
           
static int ATT_AUTOWEATHER
           
static int ATT_BRIEF
           
static int ATT_COMPRESS
           
static int ATT_DAILYMESSAGE
           
static int ATT_MXP
           
static int ATT_NOFOLLOW
           
static int ATT_NOTEACH
           
static int ATT_PLAYERKILL
           
static int ATT_QUIET
           
static int ATT_SOUND
           
static int ATT_SYSOPMSGS
           
static java.lang.String[] AUTODESC
           
static boolean[] AUTOREV
           
static long END_SHEATH_TIME
           
static long START_SHEATH_TIME
           
 
Method Summary
 double actions()
           
 void addExpertise(java.lang.String code)
          Adds a new expertise, or updates an existing one.
 void addFaction(java.lang.String of, int start)
          Manipulation of the factions list
 void addFollower(MOB follower, int order)
          Manipulation of followers
 void addPriorityEffect(Ability to)
           
 void addTattoo(MOB.Tattoo of)
          Manipulation of the tatoo list
 void adjustFaction(java.lang.String of, int amount)
           
 boolean amActive()
           
 boolean amDead()
          Combat and death
 MOB amFollowing()
           
 MOB amUltimatelyFollowing()
           
 CharStats baseCharStats()
           
 CharState baseState()
           
 int baseWeight()
           
 void bringToLife()
           
 void bringToLife(Room newLocation, boolean resetStats)
           
 CharStats charStats()
           
 java.lang.Iterable<Pair<Clan,java.lang.Integer>> clans()
           
 void clearCommandQueue()
           
 int commandQueSize()
           
 void copyFactions(MOB source)
           
 CharState curState()
           
 void delAllExpertises()
          Deletes all expertises from the collection
 void delExpertise(java.lang.String baseCode)
          Deletes an expertise.
 void delFollower(MOB follower)
           
 void delTattoo(MOB.Tattoo of)
           
 boolean dequeCommand()
           
 java.lang.String displayName(MOB mob)
           
 java.lang.String displayText(MOB viewer)
           
 void dispossess(boolean giveMsg)
           
 void doCommand(java.util.List commands, int metaFlags)
           
 void enqueCommand(java.util.List<java.lang.String> commands, int metaFlags, double tickDelay)
           
 java.util.Enumeration<java.lang.String> expertises()
          Returns an enumerator of all the expertise names with their numbers if any .
 java.util.Map.Entry<java.lang.String,java.lang.Integer> fetchExpertise(java.lang.String code)
          Returns the expertise and number for the given code
 int fetchFaction(java.lang.String which)
           
 java.util.List<java.lang.String> fetchFactionRanges()
           
 java.util.Enumeration<java.lang.String> fetchFactions()
           
 Item fetchFirstWornItem(long wornCode)
           
 MOB fetchFollower(int index)
           
 MOB fetchFollower(java.lang.String named)
           
 int fetchFollowerOrder(MOB thisOne)
           
 Item fetchHeldItem()
           
 Item fetchItem(Item goodLocation, Filterer<Environmental> filter, java.lang.String itemName)
           
 Item fetchWieldedItem()
           
 java.util.List<Item> fetchWornItems(long wornCode, short aboveOrAroundLayer, short layerAttributes)
           
 Ability findAbility(java.lang.String name)
          Extra functions on ability objects, which includes spells, traits, skills, etc.
 MOB.Tattoo findTattoo(java.lang.String of)
           
 void flagVariableEq()
          Manipulation of inventory, which includes held, worn, wielded, and contained items
 java.util.Enumeration<MOB.Follower> followers()
           
 int freeWearPositions(long wornCode, short belowLayer, short layerAttributes)
           
 java.lang.String genericName()
           
 int[][] getAbilityUsageCache(java.lang.String abilityID)
           
 long getAgeMinutes()
           
 int getBitmap()
           
 Pair<Clan,java.lang.Integer> getClanRole(java.lang.String clanID)
           
 int getExperience()
           
 int getExpNeededDelevel()
           
 int getExpNeededLevel()
           
 int getExpNextLevel()
           
 int getExpPrevLevel()
           
 java.lang.String getFactionListing()
           
 java.util.Set<MOB> getGroupMembers(java.util.Set<MOB> list)
           
 java.lang.String getLiegeID()
           
 int getMoney()
           
 double getMoneyVariation()
           
 Deity getMyDeity()
           
 int getPractices()
           
 int getQuestPoint()
           
 java.util.Set<MOB> getRideBuddies(java.util.Set<MOB> list)
           
 Room getStartRoom()
           
 int getTrains()
           
 MOB getVictim()
           
 int getWearPositions(long wornCode)
           
 int getWimpHitPoint()
           
 java.lang.String getWorshipCharID()
           
 boolean hasFaction(java.lang.String which)
           
 boolean hasOnlyGoldInInventory()
           
 java.lang.String healthText(MOB viewer)
           
 boolean isFollowedBy(MOB thisOne)
           
 boolean isInCombat()
           
 boolean isMarriedToLiege()
           
 boolean isMine(Environmental env)
           
 boolean isMonster()
           
 boolean isPlayer()
           
 boolean isPossessing()
           
 DeadBody killMeDead(boolean createBody)
           
 long lastTickedDateTime()
           
 Room location()
           
 void makePeace()
           
 int maxCarry()
           
 int maxFollowers()
           
 int maxItems()
           
 int maxRange(Environmental using)
           
 CharState maxState()
           
 boolean mayIFight(MOB mob)
           
 boolean mayPhysicallyAttack(MOB mob)
           
 int minRange(Environmental using)
           
 Weapon myNaturalWeapon()
           
 int numAllEffects()
           
 int numFollowers()
           
 long peaceTime()
           
 java.util.Enumeration<Ability> personalEffects()
           
 PlayerStats playerStats()
          Some general statistics about MOBs.
 void prequeCommand(java.util.Vector commands, int metaFlags, double tickDelay)
           
 int rangeToTarget()
           
 void recoverCharStats()
           
 void recoverMaxState()
           
 void removeFaction(java.lang.String which)
           
 void removeFromGame(boolean preserveFollowers, boolean killSession)
           
 void resetToMaxState()
           
 Session session()
          Whether a sessiob object is attached to this MOB
 void setActions(double remain)
           
 void setAgeMinutes(long newVal)
           
 void setAtRange(int newRange)
           
 void setBaseCharStats(CharStats newBaseCharStats)
           
 void setBaseState(CharState newState)
           
 void setBitmap(int bitmap)
           
 void setClan(java.lang.String clanID, int role)
           
 void setExperience(int newVal)
           
 void setExpNextLevel(int newVal)
           
 void setFollowing(MOB mob)
           
 void setLiegeID(java.lang.String newVal)
           
 void setLocation(Room newRoom)
           
 void setMoney(int newVal)
           
 void setMoneyVariation(double newVal)
           
 void setPlayerStats(PlayerStats newStats)
           
 void setPractices(int newVal)
           
 void setQuestPoint(int newVal)
           
 void setSession(Session newSession)
           
 void setSoulMate(MOB mob)
           
 void setStartRoom(Room newRoom)
           
 void setTrains(int newVal)
           
 void setVictim(MOB mob)
           
 void setWimpHitPoint(int newVal)
           
 void setWorshipCharID(java.lang.String newVal)
           
 MOB soulMate()
           
 java.util.Enumeration<MOB.Tattoo> tattoos()
           
 void tell(MOB source, Environmental target, Environmental tool, java.lang.String msg)
          Primary mob communication
 void tell(java.lang.String msg)
           
 java.lang.String titledName()
           
 int totalFollowers()
           
 boolean willFollowOrdersOf(MOB mob)
           
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider
riding, setRiding
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.DBIdentifiable
canSaveDatabaseID, databaseID, setDatabaseID
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemPossessor
addItem, moveItemTo, moveItemTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, ID, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.ItemCollection
addItem, delAllItems, delItem, eachItem, findItem, findItem, findItems, findItems, getItem, getRandomItem, isContent, items, numItems
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.AbilityContainer
abilities, addAbility, allAbilities, delAbility, delAllAbilities, fetchAbility, fetchAbility, fetchRandomAbility, numAbilities, numAllAbilities
 

Field Detail

AGE_MILLIS_THRESHOLD

static final long AGE_MILLIS_THRESHOLD
See Also:
Constant Field Values

ATT_AUTOGOLD

static final int ATT_AUTOGOLD
See Also:
Constant Field Values

ATT_AUTOLOOT

static final int ATT_AUTOLOOT
See Also:
Constant Field Values

ATT_AUTOEXITS

static final int ATT_AUTOEXITS
See Also:
Constant Field Values

ATT_AUTOASSIST

static final int ATT_AUTOASSIST
See Also:
Constant Field Values

ATT_ANSI

static final int ATT_ANSI
See Also:
Constant Field Values

ATT_SYSOPMSGS

static final int ATT_SYSOPMSGS
See Also:
Constant Field Values

ATT_AUTOMELEE

static final int ATT_AUTOMELEE
See Also:
Constant Field Values

ATT_PLAYERKILL

static final int ATT_PLAYERKILL
See Also:
Constant Field Values

ATT_BRIEF

static final int ATT_BRIEF
See Also:
Constant Field Values

ATT_NOFOLLOW

static final int ATT_NOFOLLOW
See Also:
Constant Field Values

ATT_AUTOWEATHER

static final int ATT_AUTOWEATHER
See Also:
Constant Field Values

ATT_AUTODRAW

static final int ATT_AUTODRAW
See Also:
Constant Field Values

ATT_AUTOGUARD

static final int ATT_AUTOGUARD
See Also:
Constant Field Values

ATT_SOUND

static final int ATT_SOUND
See Also:
Constant Field Values

ATT_AUTOIMPROVE

static final int ATT_AUTOIMPROVE
See Also:
Constant Field Values

ATT_NOTEACH

static final int ATT_NOTEACH
See Also:
Constant Field Values

ATT_AUTONOTIFY

static final int ATT_AUTONOTIFY
See Also:
Constant Field Values

ATT_AUTOFORWARD

static final int ATT_AUTOFORWARD
See Also:
Constant Field Values

ATT_DAILYMESSAGE

static final int ATT_DAILYMESSAGE
See Also:
Constant Field Values

ATT_QUIET

static final int ATT_QUIET
See Also:
Constant Field Values

ATT_MXP

static final int ATT_MXP
See Also:
Constant Field Values

ATT_COMPRESS

static final int ATT_COMPRESS
See Also:
Constant Field Values

ATT_AUTORUN

static final int ATT_AUTORUN
See Also:
Constant Field Values

ATT_AUTOMAP

static final int ATT_AUTOMAP
See Also:
Constant Field Values

START_SHEATH_TIME

static final long START_SHEATH_TIME

END_SHEATH_TIME

static final long END_SHEATH_TIME

AUTOREV

static final boolean[] AUTOREV

AUTODESC

static final java.lang.String[] AUTODESC
Method Detail

getBitmap

int getBitmap()

setBitmap

void setBitmap(int bitmap)

titledName

java.lang.String titledName()

displayName

java.lang.String displayName(MOB mob)

genericName

java.lang.String genericName()

playerStats

PlayerStats playerStats()
Some general statistics about MOBs. See the CharStats class (in interfaces) for more info.


setPlayerStats

void setPlayerStats(PlayerStats newStats)

baseCharStats

CharStats baseCharStats()

charStats

CharStats charStats()

recoverCharStats

void recoverCharStats()

setBaseCharStats

void setBaseCharStats(CharStats newBaseCharStats)

displayText

java.lang.String displayText(MOB viewer)

maxCarry

int maxCarry()

maxItems

int maxItems()

baseWeight

int baseWeight()

healthText

java.lang.String healthText(MOB viewer)

amDead

boolean amDead()
Combat and death


killMeDead

DeadBody killMeDead(boolean createBody)

isInCombat

boolean isInCombat()

bringToLife

void bringToLife(Room newLocation,
                 boolean resetStats)

bringToLife

void bringToLife()

removeFromGame

void removeFromGame(boolean preserveFollowers,
                    boolean killSession)

amActive

boolean amActive()

getVictim

MOB getVictim()

setVictim

void setVictim(MOB mob)

makePeace

void makePeace()

setAtRange

void setAtRange(int newRange)

maxRange

int maxRange(Environmental using)

minRange

int minRange(Environmental using)

rangeToTarget

int rangeToTarget()

mayIFight

boolean mayIFight(MOB mob)

mayPhysicallyAttack

boolean mayPhysicallyAttack(MOB mob)

peaceTime

long peaceTime()

tell

void tell(MOB source,
          Environmental target,
          Environmental tool,
          java.lang.String msg)
Primary mob communication


tell

void tell(java.lang.String msg)

enqueCommand

void enqueCommand(java.util.List<java.lang.String> commands,
                  int metaFlags,
                  double tickDelay)

prequeCommand

void prequeCommand(java.util.Vector commands,
                   int metaFlags,
                   double tickDelay)

dequeCommand

boolean dequeCommand()

clearCommandQueue

void clearCommandQueue()

commandQueSize

int commandQueSize()

doCommand

void doCommand(java.util.List commands,
               int metaFlags)

actions

double actions()

setActions

void setActions(double remain)

session

Session session()
Whether a sessiob object is attached to this MOB


setSession

void setSession(Session newSession)

isMonster

boolean isMonster()

isPlayer

boolean isPlayer()

isPossessing

boolean isPossessing()

soulMate

MOB soulMate()

setSoulMate

void setSoulMate(MOB mob)

dispossess

void dispossess(boolean giveMsg)

getAgeMinutes

long getAgeMinutes()

getPractices

int getPractices()

getExperience

int getExperience()

getExpNextLevel

int getExpNextLevel()

getExpNeededLevel

int getExpNeededLevel()

getExpNeededDelevel

int getExpNeededDelevel()

getExpPrevLevel

int getExpPrevLevel()

getTrains

int getTrains()

getMoney

int getMoney()

getMoneyVariation

double getMoneyVariation()

setAgeMinutes

void setAgeMinutes(long newVal)

setExperience

void setExperience(int newVal)

setExpNextLevel

void setExpNextLevel(int newVal)

setPractices

void setPractices(int newVal)

setTrains

void setTrains(int newVal)

setMoney

void setMoney(int newVal)

setMoneyVariation

void setMoneyVariation(double newVal)

curState

CharState curState()

maxState

CharState maxState()

recoverMaxState

void recoverMaxState()

baseState

CharState baseState()

setBaseState

void setBaseState(CharState newState)

resetToMaxState

void resetToMaxState()

myNaturalWeapon

Weapon myNaturalWeapon()

getLiegeID

java.lang.String getLiegeID()

setLiegeID

void setLiegeID(java.lang.String newVal)

isMarriedToLiege

boolean isMarriedToLiege()

getWorshipCharID

java.lang.String getWorshipCharID()

setWorshipCharID

void setWorshipCharID(java.lang.String newVal)

getMyDeity

Deity getMyDeity()

getWimpHitPoint

int getWimpHitPoint()

setWimpHitPoint

void setWimpHitPoint(int newVal)

getQuestPoint

int getQuestPoint()

setQuestPoint

void setQuestPoint(int newVal)

lastTickedDateTime

long lastTickedDateTime()

clans

java.lang.Iterable<Pair<Clan,java.lang.Integer>> clans()

getClanRole

Pair<Clan,java.lang.Integer> getClanRole(java.lang.String clanID)

setClan

void setClan(java.lang.String clanID,
             int role)

getStartRoom

Room getStartRoom()

setStartRoom

void setStartRoom(Room newRoom)

location

Room location()

setLocation

void setLocation(Room newRoom)

flagVariableEq

void flagVariableEq()
Manipulation of inventory, which includes held, worn, wielded, and contained items


fetchItem

Item fetchItem(Item goodLocation,
               Filterer<Environmental> filter,
               java.lang.String itemName)

fetchWornItems

java.util.List<Item> fetchWornItems(long wornCode,
                                    short aboveOrAroundLayer,
                                    short layerAttributes)

fetchFirstWornItem

Item fetchFirstWornItem(long wornCode)

fetchWieldedItem

Item fetchWieldedItem()

fetchHeldItem

Item fetchHeldItem()

hasOnlyGoldInInventory

boolean hasOnlyGoldInInventory()

freeWearPositions

int freeWearPositions(long wornCode,
                      short belowLayer,
                      short layerAttributes)

isMine

boolean isMine(Environmental env)

getWearPositions

int getWearPositions(long wornCode)

numAllEffects

int numAllEffects()

addPriorityEffect

void addPriorityEffect(Ability to)

personalEffects

java.util.Enumeration<Ability> personalEffects()

addFollower

void addFollower(MOB follower,
                 int order)
Manipulation of followers


delFollower

void delFollower(MOB follower)

numFollowers

int numFollowers()

fetchFollowerOrder

int fetchFollowerOrder(MOB thisOne)

isFollowedBy

boolean isFollowedBy(MOB thisOne)

followers

java.util.Enumeration<MOB.Follower> followers()

fetchFollower

MOB fetchFollower(int index)

fetchFollower

MOB fetchFollower(java.lang.String named)

amFollowing

MOB amFollowing()

amUltimatelyFollowing

MOB amUltimatelyFollowing()

willFollowOrdersOf

boolean willFollowOrdersOf(MOB mob)

setFollowing

void setFollowing(MOB mob)

getGroupMembers

java.util.Set<MOB> getGroupMembers(java.util.Set<MOB> list)

getRideBuddies

java.util.Set<MOB> getRideBuddies(java.util.Set<MOB> list)

maxFollowers

int maxFollowers()

totalFollowers

int totalFollowers()

findAbility

Ability findAbility(java.lang.String name)
Extra functions on ability objects, which includes spells, traits, skills, etc.


getAbilityUsageCache

int[][] getAbilityUsageCache(java.lang.String abilityID)

addExpertise

void addExpertise(java.lang.String code)
Adds a new expertise, or updates an existing one. Requires a coded expertise name (string followed by roman or decimal number)

Parameters:
code - the expertise to add or update

delExpertise

void delExpertise(java.lang.String baseCode)
Deletes an expertise.

Parameters:
baseCode - the expertise code

fetchExpertise

java.util.Map.Entry<java.lang.String,java.lang.Integer> fetchExpertise(java.lang.String code)
Returns the expertise and number for the given code

Parameters:
code - the expertise code
Returns:
the entry with the string and number

delAllExpertises

void delAllExpertises()
Deletes all expertises from the collection


expertises

java.util.Enumeration<java.lang.String> expertises()
Returns an enumerator of all the expertise names with their numbers if any .

Returns:
an enumerator

addTattoo

void addTattoo(MOB.Tattoo of)
Manipulation of the tatoo list


delTattoo

void delTattoo(MOB.Tattoo of)

tattoos

java.util.Enumeration<MOB.Tattoo> tattoos()

findTattoo

MOB.Tattoo findTattoo(java.lang.String of)

addFaction

void addFaction(java.lang.String of,
                int start)
Manipulation of the factions list


adjustFaction

void adjustFaction(java.lang.String of,
                   int amount)

fetchFactions

java.util.Enumeration<java.lang.String> fetchFactions()

fetchFactionRanges

java.util.List<java.lang.String> fetchFactionRanges()

hasFaction

boolean hasFaction(java.lang.String which)

fetchFaction

int fetchFaction(java.lang.String which)

getFactionListing

java.lang.String getFactionListing()

removeFaction

void removeFaction(java.lang.String which)

copyFactions

void copyFactions(MOB source)