Package com.planet_ink.coffee_mud.core.interfaces

Interface Behavable

All Known Subinterfaces:

Ammunition, AmmunitionWeapon, Area, Armor, AutoGenArea, BodyToken, Book, CagedAnimal, ClanItem, Coins, Combatant, Computer, Container, DeadBody, DeckOfCards, Deity, DoorKey, ElecPanel, Electronics, Exit, FalseLimb, Food, FuelConsumer, GridLocale, HandOfCards, InnKey, Item, ItemPossessor, Light, LocationRoom, MagicDust, MiscMagic, MOB, MusicalInstrument, NavigableItem, PackagedItems, PhysicalAgent, Pill, Places, PlayingCard, Potion, PowerGenerator, PowerSource, PrepositionExit, RawMaterial, RecipesBook, Rideable, Rider, Room, RoomMap, Scroll, Shield, ShipDirectional, ShipEngine, ShipWarComponent, SiegableItem, Software, SpaceObject.SpaceGateway, SubArea, TechComponent, Technical, Wand, Weapon

All Known Implementing Classes:

AjarDoor, Alligator, AngryCitizen, Ape, Apple, ArchonJournal, ArchonStaff, Arquebus, Assassin, Asteroid, Backpack, BagOfEndlessness, BagOfHolding, BandedArmor, BardMap, BattleAxe, Beaver, Bed, Bee, BlackBear, BlackDragon, BlueDragon, Boat, BrassDragon, BronzeDragon, Broom, BrownBear, BrownSnake, Buck, Buffalo, Bugbear, Bull, Cat, CaveGrid, CaveMaze, CaveRoom, CaveSeaPort, CaveSurface, Centaur, Centipede, Cestus, ChainMailArmor, ChainMailVest, Chair, Cheetah, Chicken, Chimp, Citizen, CityStreet, Claymore, ClimbableExit, ClimbableLedge, ClimbableSurface, CloseableContainer, Cobra, CombatDummy, CommonBat, CopperDragon, Corpse, Cougar, Cow, Coyote, Crocodile, CubicGate, Dagger, DaggerOfVenom, DarkStoneRoom, DatabaseProgram, Deer, Desert, DesertGrid, DesertMaze, DesertThinGrid, DireWolf, Dirk, Doe, Dog, Dolphin, Door, Doppleganger, Dragon, DragonClaw, Dress, DrowChainMailArmor, DrowDagger, DrowElf, DrowMace, DrowPriestess, DrowQuarterstaff, DrowSword, DrowWarrior, DrowWizard, DruidicMonument, Duck, DwarfStar, Elephant, EmissionScanProgram, EndlessOcean, EndlessSky, EndlessThinOcean, EndlessThinSky, EternityBarkArmor, EternityLeafArmor, EternityLeafShield, EternityQuarterstaff, Falcon, FieldPlate, FireGiant, FlamingSword, FlyingExit, FlyingInsect, Fox, Frog, FrostGiant, FrozenMountains, FrozenPlains, FullPlate, GapExit, GardenSnake, GasGiant, Gate, Gem, GenAbsorbantShield, GenAirLock, GenAmmunition, GenArmor, GenAuctioneer, GenBagOfEndlessness, GenBagOfHolding, GenBanker, GenBed, GenBelt, GenBlaster, GenBoardable, GenBoat, GenBoffWeapon, GenBook, GenBow, GenBussardCollector, GenCage, GenCaged, GenCageRideable, GenCannon, GenCaravan, GenCastle, GenChair, GenCigar, GenClanApron, GenClanArmor, GenClanCard, GenClanCastle, GenClanCommonContainer, GenClanCommonItem, GenClanConcierge, GenClanContainer, GenClanDonationList, GenClanFlag, GenClanItem, GenClanPamphlet, GenClanSailorsCap, GenClanSpecialItem, GenClanTabbard, GenCloak, GenCoins, GenCompBattery, GenCompEnviroSystem, GenCompGenerator, GenCompLauncher, GenComputerConsole, GenContainer, GenCorpse, GenCow, GenCurtain, GenDeflectionShield, GenDeity, GenDice, GenDisruptor, GenDisruptor2, GenDissertation, GenDoor, GenDress, GenDrink, GenEarring, GenEclipseField, GenElecCompItem, GenElecCompSensor, GenElecContainer, GenElecItem, GenElecPanel, GenElecWeapon, GenEmptyDrink, GenEnergyShield, GenExit, GenFatWallpaper, GenFixture, GenFood, GenFoodResource, GenFountain, GenFuellessGenerator, GenFurniture, GenGangline, GenGiftContainer, GenGrapples, GenGraviticSensor, GenGun, GenHandBow, GenHorse, GenInstrument, GenIntegrityShield, GenItem, GenJournal, GenKey, GenKineticField, GenLantern, GenLaserGun, GenLasso, GenLawBook, GenLibrarian, GenLightSource, GenLightSwitch, GenLimb, GenLiquidResource, GenMagicInstrument, GenMap, GenMirror, GenMob, GenMobilePortal, GenMultiPotion, GenMutingField, GenNavigableBoardable, GenNet, GenPackagedItems, GenPackagedStack, GenPackagedVariety, GenPants, GenPaper, GenPerfume, GenPersonalShield, GenPhaser, GenPhaser2, GenPiano, GenPill, GenPipe, GenPlayerBook, GenPlayingCard, GenPortal, GenPostman, GenPotion, GenPowder, GenQuestBoard, GenReadable, GenRecipe, GenReflectionShield, GenResource, GenRideable, GenRideable, GenRideableUndead, GenRuinedItem, GenSailingShip, GenScale, GenScroll, GenShield, GenShipDampener, GenShipEngine, GenShipGravityGen, GenShipInertialBattery, GenShipOpticalSensor, GenShipPanel, GenShipProgram, GenShipShieldGenerator, GenShipThruster, GenShipViewScreen, GenShipWeapon, GenShipWindow, GenShirt, GenShoes, GenShopkeeper, GenSiegableBoardable, GenSiegeWeapon, GenSling, GenSmartTorpedo, GenSoftware, GenSolarGenerator, GenSonicGun, GenSpaceBody, GenSpaceDrive, GenSpaceShip, GenSpaceTech, GenSpear, GenStaff, GenStealthShield, GenStove, GenSuperPill, GenTable, GenTechItem, GenTent, GenThinArmor, GenTickerShield, GenTitle, GenTorpedo, GenTriCorder, GenTub, GenUndead, GenWallpaper, GenWand, GenWater, GenWaterPowerGenerator, GenWeapon, GenWindGenerator, GenWormhole, GiantBat, GiantScorpion, Glaive, GlovesSpeed, GlowingMageArmor, Gnoll, Goat, GoatDoe, Goblin, GoldDragon, GoodyBag, Gorilla, Grate, GreatHelm, GreatLake, GreatThinLake, GreenDragon, Halberd, Hat, Hat_Intelligence, Hawk, HealthScanProgram, HeavenlyServent, Helmet, HerbChest, HiddenClosedDoorway, HiddenWalkway, HideArmor, HideoutShelter, HillGiant, Hills, HillsGrid, HillsThinGrid, HoleInTheGround, HolyAvenger, Hood, Hornet, Horse, HorseCart, HotRoom, IcePlains, IceRoom, Impassable, IndoorInTheAir, IndoorShallowWater, IndoorUnderWater, IndoorUnderWaterColumnGrid, IndoorUnderWaterGrid, IndoorUnderWaterThinGrid, IndoorWaterSurface, IndoorWaterSurfaceColumn, IndoorWaterThinSurface, Ingredients, InTheAir, InvisibleStalker, Jaguar, Javelin, Jungle, JungleGrid, JungleThinGrid, Katana, Kitten, Lantern, LargeBat, LargeCaveRoom, LargeChest, LargeSack, LargeStoneRoom, LargeWoodRoom, LeatherArmor, LeatherBoots, LeatherBracers, LeatherCap, LeatherGauntlets, LifeFountain, LifeScanProgram, LightSource, Lion, Lizard, LizardMan, LizardManShaman, LockableContainer, LockedDoor, LockedGate, LongerRoad, LongestRoad, LongRoad, Longsword, Mace, MagicFreeRoom, MagicShelter, ManualAdvancement, ManualArchon, ManualClasses, MassiveStar, MetalBracers, MetalRoom, MetalRoomMaze, MichaelsMithrilChain, Minotaur, Monkey, Moon, Moonlet, MountainLion, Mountains, MountainsGrid, MountainsMaze, MountainsThinGrid, MountainSurface, MountainSurfaceGrid, MountainSurfaceThinGrid, Mouse, Naga, NamedRedirectable, Natural, NeedleChest, NeedleDoor, OceanGrid, OceanThinGrid, Ogre, OilFlask, Open, OpenDescriptable, OpenNameable, OpenPrepositional, Orc, OverTheLedge, Owl, PaddedArmor, Pan, Panther, Pants, Parakeet, Parchment, Pegasus, PegasusGreater, Penguin, Pig, PitOpen, Plains, PlainsGrid, PlainsThinGrid, Planet, PortableHole, Pot, PracticePoint, Puppy, Python, Quarterstaff, QuestPoint, Rabbit, Rapier, Rat, Ration, Rattlesnake, Raven, RedDragon, Ring, Ring_Ornamental, Ring_Protection, RingMail, RingOfColdProtection, RingOfElectricity, RingOfFortitude, RingOfJustice, RingOfMagicResistance, Road, RoadGrid, RoadThinGrid, Robes, RocketShipProgram, Rooster, Ruler, Sabre, SaltWaterSurface, SaltWaterSurfaceColumn, SaltWaterThinSurface, ScaleMail, Scimitar, Scorpion, ScrollSpell, Seal, SeaMap, SeaPort, SewerMaze, SewerRoom, ShallowWater, Shark, Sheep, ShieldWeapon, ShipDeck, ShipDiagProgram, ShipHeavyGunDeck, ShipHold, ShipLightGunDeck, ShipMagazine, ShipMedGunDeck, ShipNavProgram, ShipQuarter, ShipSensorProgram, ShipTacticalProgram, ShipTelnetProgram, Shirt, Shoes, Shore, ShoreGrid, Shortsword, Sickle, SilverDragon, Skeleton, Skyway, SmallChest, SmallDagger, SmallHammer, SmallMace, SmallSack, Snake, SpacePort, Spear, Spider, SplintMail, Spring, Squirrel, Staff, Star, StdArea, StdArmor, StdAuctioneer, StdAutoGenInstance, StdBanker, StdBoardable, StdBoardableShip, StdBoffWeapon, StdBook, StdBow, StdCage, StdCageRideable, StdClanApron, StdClanArmor, StdClanCard, StdClanCommonContainer, StdClanCommonItem, StdClanConcierge, StdClanContainer, StdClanDonationList, StdClanFlag, StdClanItem, StdClanPamphlet, StdClanSailorsCap, StdClanSpecialItem, StdClanTabbard, StdClosedDoorway, StdCoins, StdCompBattery, StdCompFuelConsumer, StdCompFuellessGenerator, StdCompGenerator, StdCompLauncher, StdCompPanel, StdComputerConsole, StdContainer, StdContainerWrapper, StdDeckOfCards, StdDeity, StdDice, StdDissertation, StdDrink, StdElecCompContainer, StdElecCompItem, StdElecCompSensor, StdElecContainer, StdElecItem, StdElecPanel, StdElecWeapon, StdExit, StdFactoryMOB, StdFood, StdGrapples, StdGrid, StdGridArea, StdGun, StdHandOfCards, StdInnKey, StdItem, StdItemWrapper, StdJournal, StdKey, StdLasso, StdLawBook, StdLibrarian, StdLimb, StdLockedDoorway, StdMap, StdMaze, StdMOB, StdMobWrapper, StdNavigableBoardable, StdNet, StdOpenDoorway, StdPaper, StdPerfume, StdPersonalShield, StdPill, StdPlanet, StdPlayerBook, StdPlayingCard, StdPortal, StdPortalWrapper, StdPostman, StdPotion, StdPowder, StdProgram, StdQuestBoard, StdRideable, StdRideable, StdRideableWrapper, StdRideableWrapper, StdRoom, StdScroll, StdShield, StdShipDampener, StdShipEngine, StdShipFuellessThruster, StdShipGravityGen, StdShipInertialBattery, StdShipShieldGenerator, StdShipThruster, StdShipWeapon, StdShopKeeper, StdSiegableBoardable, StdSiegeWeapon, StdSling, StdSmartTorpedo, StdSmokable, StdSpaceBody, StdSpaceShip, StdSpaceTech, StdSpaceTechWeapon, StdSpear, StdTechItem, StdThinArea, StdThinArmor, StdThinGrid, StdThinGridArea, StdThinInstance, StdThinItem, StdThinPlanet, StdTimeZone, StdTitle, StdTorpedo, StdTriCorder, StdTub, StdWand, StdWeapon, StdWormhole, SteelGauntlets, Stiletto, StoneGiant, StoneGolem, StoneGrid, StoneMaze, StoneRoom, StoneThinGrid, StuddedLeatherArmor, SubThinInstance, Swamp, SwampGrid, SwampThinGrid, Sword, Swordfish, Teacher, ThinRoom, ThreadbareRobes, ThrowingStone, Tiger, Toad, Torch, TrainingSession, TrappedChest, TrappedDoor, TrappedLockedDoor, TreeSurface, Trident, Troll, Turtle, TwoHandedSword, UmberHulk, Undead, UndergroundCityStreet, UnderSaltWater, UnderSaltWaterColumnGrid, UnderSaltWaterGrid, UnderSaltWaterMaze, UnderSaltWaterThinGrid, UnderWater, UnderwaterCityStreet, UnderWaterColumnGrid, UnderWaterGrid, UnderWaterMaze, UnderWaterThinGrid, UnseenWalkway, Void, Vulture, WalkingBoots, Walrus, Wand_Advancement, Wand_Fire, Wand_Nourishment, WandArchon, WarHammer, Waterskin, WaterSurface, WaterSurfaceColumn, WaterThinSurface, WetCaveGrid, WetCaveMaze, WetCaveRoom, Whale, Whip, Whirlpool, WhiteBear, WhiteDragon, WildEagle, Wineskin, Wolf, Wolverine, WoodenDeck, WoodRoom, WoodRoomGrid, WoodRoomMaze, WoodRoomThinGrid, Woods, WoodSeaPort, WoodsGrid, WoodsMaze, WoodsThinGrid, Worm, Wyvern, Zombie

public interface Behavable

Something that can behave -- means almost everything!

Method Summary

Modifier and Type	Method	Description
void	addBehavior(Behavior to)	Add a new behavior to this object.
void	addScript(ScriptingEngine s)	Add a new runnable script to this object.
java.util.Enumeration<Behavior>	behaviors()	Returns an enumerator of all the behaviors on this object.
void	delAllBehaviors()	Removes all behaviors from this object.
void	delAllScripts()	Removes all executing scripts from this object.
void	delBehavior(Behavior to)	Delete a behavior from this object.
void	delScript(ScriptingEngine s)	Remove a running script from this object.
void	eachBehavior(EachApplicable<Behavior> applier)	Applies the given code to each behavior on this object
void	eachScript(EachApplicable<ScriptingEngine> applier)	Applies the given code to each scripting engine on this object
Behavior	fetchBehavior(int index)	Returns a behavior object on this object.
Behavior	fetchBehavior(java.lang.String ID)	Returns a behavior object listed on this object.
ScriptingEngine	fetchScript(int x)	Retrieve one of the enumerated scripts running on this object
int	numBehaviors()	The number of behaviors this object has.
int	numScripts()	Return the number of scripts running on this object
java.util.Enumeration<ScriptingEngine>	scripts()	Returns an enumerator of all the scripts on this object.

Method Detail

addBehavior

void addBehavior(Behavior to)

Add a new behavior to this object. After calling this method, recoverPhyStats() should be called next in case this behavior object modifies the stats. A Behavior with a given ID() can only be added once per object.

Parameters:

to - The behavior object to add.

See Also:

Behavior, Affectable.recoverPhyStats()

delBehavior

void delBehavior(Behavior to)

Delete a behavior from this object. After calling this method, recoverPhyStats() should be called next in case this behavior object modified the stats.

Parameters:

to - The behavior object to remove.

See Also:

Behavior, Affectable.recoverPhyStats()

numBehaviors

int numBehaviors()

The number of behaviors this object has.

Returns:

the number of behaviors

See Also:

Behavior

fetchBehavior

Behavior fetchBehavior(int index)

Returns a behavior object on this object. May return null even if the index is correct to mark a race condition.

Parameters:

index - which object to return

Returns:

the behavior object

See Also:

Behavior, numBehaviors()

fetchBehavior

Behavior fetchBehavior(java.lang.String ID)

Returns a behavior object listed on this object. The object will be the one with the same ID() string as passed in.

Parameters:

ID - the Behavior ID to look for

Returns:

the behavior object

See Also:

Behavior, CMObject.ID()

behaviors

java.util.Enumeration<Behavior> behaviors()

Returns an enumerator of all the behaviors on this object.

Returns:

an enumerator of all the behaviors on this object.

See Also:

Behavior

eachBehavior

void eachBehavior(EachApplicable<Behavior> applier)

Applies the given code to each behavior on this object

Parameters:

applier - code to execute against each object

addScript

void addScript(ScriptingEngine s)

Add a new runnable script to this object. Objects which are not mobs or areas will gain a temporary tick service for this script.

Parameters:

s - the scripting engine, fully populated, to add

See Also:

ScriptingEngine

delAllBehaviors

void delAllBehaviors()

Removes all behaviors from this object.

delScript

void delScript(ScriptingEngine s)

Remove a running script from this object.

Parameters:

s - the specific scripting engine to remove

See Also:

ScriptingEngine

delAllScripts

void delAllScripts()

Removes all executing scripts from this object.

numScripts

int numScripts()

Return the number of scripts running on this object

Returns:

number of scripts

fetchScript

ScriptingEngine fetchScript(int x)

Retrieve one of the enumerated scripts running on this object

Parameters:

x - which script to return

Returns:

the scripting engine

See Also:

ScriptingEngine

scripts

java.util.Enumeration<ScriptingEngine> scripts()

Returns an enumerator of all the scripts on this object.

Returns:

an enumerator of all the scripts on this object.

See Also:

ScriptingEngine

eachScript

void eachScript(EachApplicable<ScriptingEngine> applier)

Applies the given code to each scripting engine on this object

Parameters:

applier - code to execute against each object