package com.planet_ink.coffee_mud.Libraries.interfaces;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.*;
import com.planet_ink.coffee_mud.core.collections.*;
import com.planet_ink.coffee_mud.Abilities.interfaces.*;
import com.planet_ink.coffee_mud.Areas.interfaces.*;
import com.planet_ink.coffee_mud.Behaviors.interfaces.*;
import com.planet_ink.coffee_mud.CharClasses.interfaces.*;
import com.planet_ink.coffee_mud.Commands.interfaces.*;
import com.planet_ink.coffee_mud.Common.interfaces.*;
import com.planet_ink.coffee_mud.Exits.interfaces.*;
import com.planet_ink.coffee_mud.Items.interfaces.*;
import com.planet_ink.coffee_mud.Locales.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.*;
import com.planet_ink.coffee_mud.Races.interfaces.*;
import java.util.*;
/*
Copyright 2005-2016 Bo Zimmerman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* The Flag Library is full of shortcut methods for checking the
* state of objects in a high level way. This allows the underlying
* functionality of those states to change more easily in the future.
* Most of these check PhyStats disposition and senses flags, but
* there are also methods for checking room states, sorting through
* abilities by their flags, and similar methods.
* I guess it's really a state-checking-catch-all library.
* @author Bo Zimmerman
*
*/
public interface CMFlagLibrary extends CMLibrary
{
/**
* Return whether the given mob is blind or otherwise
* unable to see due to a strictly personal defect.
* @param M the mob to check
* @return whether the given mob is not blind
*/
public boolean canSee(MOB M);
/**
* Returns whether the given physical object can be located
* by magical means. Applies mostly to items.
* @param P the object to check
* @return true if it can be located, false otherwise
*/
public boolean canBeLocated(Physical P);
/**
* Returns whether the given mob has the ability to see
* hidden.
* @param M the mob to check
* @return whether the mob can see hidden
*/
public boolean canSeeHidden(MOB M);
/**
* Returns whether the given mob has the ability to see
* invisible.
* @param M the mob to check
* @return whether the mob can see invisible
*/
public boolean canSeeInvisible(MOB M);
/**
* Returns whether the given mob has the ability to see
* evil in people/things.
* @param M the mob to check
* @return whether the mob can see evil in people/things
*/
public boolean canSeeEvil(MOB M);
/**
* Returns whether the given mob has the ability to see
* good in people/things.
* @param M the mob to check
* @return whether the mob can see good in people/things
*/
public boolean canSeeGood(MOB M);
/**
* Returns whether the given mob has the ability to see
* sneaking mobs.
* @param M the mob to check
* @return whether the mob can see sneaking mobs
*/
public boolean canSeeSneakers(MOB M);
/**
* Returns whether the given mob has the ability to see
* magic items as such.
* @param M the mob to check
* @return whether the mob can see magic items
*/
public boolean canSeeBonusItems(MOB M);
/**
* Returns whether the given mob has the ability to see
* in the dark.
* @param M the mob to check
* @return whether the mob can see in the dark
*/
public boolean canSeeInDark(MOB M);
/**
* Returns whether the given mob has the ability to see
* their enemies in the dark.
* @param M the mob to check
* @return whether the mob can see their enemies in the dark
*/
public boolean canSeeVictims(MOB M);
/**
* Returns whether the given mob has the ability to see
* warm blooded mobs in the dark.
* @param M the mob to check
* @return whether the mob can see warm blooded mobs in the dark
*/
public boolean canSeeInfrared(MOB M);
/**
* Return whether the given mob is deaf or otherwise
* unable to hear due to a strictly personal defect.
* @param M the mob to check
* @return whether the given mob is not deaf
*/
public boolean canHear(MOB M);
/**
* Return whether the given mob is able to move at all.
* @param M the mob to check
* @return whether the given mob is not frozen
*/
public boolean canMove(MOB M);
/**
* Returns whether the given mob or item is not allowed
* to be camped, meaning they won't respawn while
* someone is just hanging around waiting in the
* room for them to spawn.
* @param P the item or mob to check
* @return true if they can't be camped
*/
public boolean canNotBeCamped(Physical P);
/**
* Returns whether this room allows mobs or players to enter
* or leave. Usually a temporary flag.
* @param R the room to check
* @return true if its ok to enter and leave
*/
public boolean allowsMovement(Room R);
/**
* Returns whether this area allows mobs or players to enter
* or leave. Usually a temporary flag.
* @param A the area to check
* @return true if its ok to enter and leave
*/
public boolean allowsMovement(Area A);
/**
* Return whether the given mob is stuffed or otherwise
* unable to smell due to a strictly personal defect.
* @param M the mob to check
* @return whether the given mob is able to smell
*/
public boolean canSmell(MOB M);
/**
* Return whether the given mob is able to eat or
* drink due to the lack of strictly personal defects.
* @param M the mob to check
* @return whether the given mob is able to eat and drink
*/
public boolean canTaste(MOB M);
/**
* Return whether the given mob is mute or otherwise
* unable to speak due to a strictly personal defect.
* @param M the mob to check
* @return whether the given mob is not mute
*/
public boolean canSpeak(MOB M);
/**
* Return whether the given mob is able to breathe at all
* due to a strictly personal defect.
* @param M the mob to check
* @return whether the given mob is able to breathe
*/
public boolean canBreathe(MOB M);
/**
* Return whether the given mob is able to breathe the given
* resource due to their race, usually.
* @see com.planet_ink.coffee_mud.Items.interfaces.RawMaterial
* @param M the mob to check
* @param atmoResource the Resource to check for breathability
* @return whether the given mob is able to breathe that
*/
public boolean canBreatheThis(MOB M, int atmoResource);
/**
* Return whether the given mob is able to breathe in the given
* room due to their race and the atmosphere of the room.
* @see com.planet_ink.coffee_mud.Items.interfaces.RawMaterial
* @param M the mob to check
* @param R the room the mob is trying to breathe in
* @return whether the given mob is able to breathe here
*/
public boolean canBreatheHere(MOB M, Room R);
/**
* Returns whether the given mob has the ability to see
* metal items as such.
* @param M the mob to check
* @return whether the mob can see metal items
*/
public boolean canSeeMetal(MOB M);
/**
* Returns whether the given thing is allowed to do mundane
* things, such as patrolling or tracking or being mobile.
* @param P the item or mob
* @return true if they can mobile and patrol and such
*/
public boolean canTrack(Physical P);
/**
* Returns whether the given mob is allowed to use their auto
* attack every tick, if that even applies to this system.
* @param M the mob to check
* @return true if they are allowed to auto-attack
*/
public boolean canAutoAttack(MOB M);
/**
* Returns whether the given mob has the ability to concentrate
* enough to cast spells.
* @param M the mob to check
* @return whether the mob can cast spells and concentrate and stuff
*/
public boolean canConcentrate(MOB M);
/**
* Returns whether the given hearer mob can hear the given mob or
* object moving around. Mostly by comparing the sneaking and hear sneakers
* as well as general hearing ability.
* @param heard the thing or mob moving around
* @param hearer the mob who wants to hear it
* @return whether the given hearer can hear the heard
*/
public boolean canBeHeardMovingBy(Physical heard , MOB hearer);
/**
* Returns whether the given hearer mob can hear the given mob or
* object speaking. Mostly just checks whether the hearer can hear.
* @param heard the thing or mob speaking
* @param hearer the mob who wants to hear it
* @return whether the given hearer can hear the heard
*/
public boolean canBeHeardSpeakingBy(Physical heard , MOB hearer);
/**
* Returns whether the given sensor can see or hear the given sensed
* mob or object moving around.
* @param sensed the thing being sensed
* @param sensor the mob who wants to sense it
* @return true if the moving sensed can be sensed by the sensor
*/
public boolean canSenseMoving(Physical sensed, MOB sensor);
/**
* Returns whether the given sensor mob can sense the given mob or
* object coming and going. Mostly by comparing the sneaking and hear sneakers
* as well as general seeing and hearing ability.
* @param sensed the thing or mob moving around
* @param sensor the mob who wants to sense it
* @return whether the given sensor can sense the sensed
*/
public boolean canSenseEnteringLeaving(Physical sensed, MOB sensor);
/**
* Returns whether the given mob can 'access' the given area, due
* to it not being hidden and sharing a timezone. Usually applies
* to knowledge of, as opposed to entry.
* @param mob the mob who wants to access an area
* @param A the area to access
* @return true if the mob can 'access' the area
*/
public boolean canAccess(MOB mob, Area A);
/**
* Returns whether the given mob can 'access' the given room, due
* to it not being hidden and sharing a timezone. Usually applies
* to knowledge of, as opposed to entry.
* @param mob the mob who wants to access a room
* @param R the room to access
* @return true if the mob can 'access' the room
*/
public boolean canAccess(MOB mob, Room R);
/**
* Returns whether the given affecting (usually a mob) is alive,
* awake, mobile, and officially in the game. This is a lighter
* test than some of the others that also check if its busy.
* @param affecting the thing to check
* @return true if the thing can act at all
*/
public boolean canActAtAll(Tickable affecting);
/**
* Returns whether the given affecting (usually a mob) is alive,
* awake, mobile, and officially in the game, and not in combat,
* sufficiently healthy, and not following anyone.
* @param affecting the thing to check
* @return true if the thing can act freely
*/
public boolean canFreelyBehaveNormal(Tickable affecting);
/**
* Returns whether the given seen mob or item or room or whatever
* can be seen by the given seer, given conditions, lighting,
* hidden, etc.
* @param seen the thing to be seen.
* @param seer the seer who wants to see it
* @return true if the seer can see the seen
*/
public boolean canBeSeenBy(Environmental seen , MOB seer);
/**
* Returns whether the given seen mob or item or room or whatever
* can only BARELY be seen by the given seer, given moon lightning
* mostly. Always returns false unless the BARELY applies.
* @param seen the thing to be seen.
* @param seer the seer who wants to see it
* @return true if the seer can see the seen BARELY
*/
public boolean canBarelyBeSeenBy(Environmental seen , MOB seer);
/**
* Returns whether the given item is marked as being readable.
* @see CMFlagLibrary#setReadable(Item, boolean)
* @param I the item to check
* @return true if it is readable, false otherwise
*/
public boolean isReadable(Item I);
/**
* Sets whether the given item is marked as being readable.
* @see CMFlagLibrary#isReadable(Item)
* @param I the item to set
* @param truefalse true if readable, false otherwise
*/
public void setReadable(Item I, boolean truefalse);
/**
* Returns whether the given item, mob, whatever is marked as being
* affected by an uninvokeable spell, chant, prayer, or whatever.
* @param F the room, item, or mob to check
* @return true if it is enspelled, false otherwise
*/
public boolean isEnspelled(Physical F);
/**
* Returns whether the given item is marked as being gettable.
* @see CMFlagLibrary#setGettable(Item, boolean)
* @param I the item to check
* @return true if it is gettable, false otherwise
*/
public boolean isGettable(Item I);
/**
* Sets whether the given item is marked as being gettable.
* @see CMFlagLibrary#isGettable(Item)
* @param I the item to set
* @param truefalse true if gettable, false otherwise
*/
public void setGettable(Item I, boolean truefalse);
/**
* Returns whether the given item is marked as being droppable.
* @see CMFlagLibrary#setDroppable(Item, boolean)
* @param I the item to check
* @return true if it is droppable, false otherwise
*/
public boolean isDroppable(Item I);
/**
* Sets whether the given item is marked as being droppable.
* @see CMFlagLibrary#isDroppable(Item)
* @param I the item to set
* @param truefalse true if droppable, false otherwise
*/
public void setDroppable(Item I, boolean truefalse);
/**
* Returns whether the given item is marked as being removeable.
* @see CMFlagLibrary#setRemovable(Item, boolean)
* @param I the item to check
* @return true if it is removeable, false otherwise
*/
public boolean isRemovable(Item I);
/**
* Sets whether the given item is marked as being removeable.
* @see CMFlagLibrary#isRemovable(Item)
* @param I the item to set
* @param truefalse true if removeable, false otherwise
*/
public void setRemovable(Item I, boolean truefalse);
/**
* Returns whether the given item is marked as being an
* instance of a mob or item from the catalog.
* @param E the item or mob to check
* @return true if it is cataloged, false otherwise
*/
public boolean isCataloged(Environmental E);
/**
* Returns whether the given object is marked as being allowed
* to be saved to the database. Most created objects are, though
* items and mobs generated by temporary spells often are not.
* @see CMFlagLibrary#setSavable(Physical, boolean)
* @param P the item, mob, whatever to check
* @return true if it is saveable, false otherwise
*/
public boolean isSavable(Physical P);
/**
* Sets whether the given object is marked as being allowed
* to be saved to the database. Most created objects are, though
* items and mobs generated by temporary spells often are not.
* @see CMFlagLibrary#isSavable(Physical)
* @param P the item, mob, whatever to set
* @param truefalse true if it is saveable, false otherwise
*/
public void setSavable(Physical P, boolean truefalse);
/**
* Returns whether the given non-mob (item) has
* contents which has be seen. Default is true.
* @param P the item to check
* @return true if contents have has seen
*/
public boolean isWithSeenContents(Physical P);
/**
* Returns whether the given item is a container which,
* when open, has accessible contents, and is also open.
* @param I the item to check
* @return true if the contents are accessible right now.
*/
public boolean isOpenAccessibleContainer(Item I);
/**
* Returns whether the given item, mob, room, whatever is
* seeable at all. This is beyond invisibility to the
* metaphysically unseeable.
* @param P the room, mob, or item to check
* @return true if it is seeable
*/
public boolean isSeeable(Physical P);
/**
* Returns whether the given item, mob, room, whatever is
* cloaked. This prevents a kind of global awareness, not
* connected to local seeability.
* @param P the room, mob, or item to check
* @return true if it is cloaked
*/
public boolean isCloaked(Physical P);
/**
* Returns whether the given item, mob, room, whatever is
* hidden.
* @param P the room, mob, or item to check
* @return true if it is hidden
*/
public boolean isHidden(Physical P);
/**
* Returns whether the given item, mob, room, whatever is
* invisible.
* @param P the room, mob, or item to check
* @return true if it is invisible
*/
public boolean isInvisible(Physical P);
/**
* Returns whether the given item, mob, room, whatever is
* goodly aligned.
* @param P the room, mob, or item to check
* @return true if it is goodness
*/
public boolean isGood(Physical P);
/**
* Returns whether the given mobby factionmember is
* goodly aligned due to factions.
* @param M the factionmember to check
* @return true if it is goodness
*/
public boolean isReallyGood(FactionMember M);
/**
* Returns whether the given item, mob, room, whatever is
* neutral, which is to say, neither good nor evil.
* @param P the room, mob, or item to check
* @return true if it is neutral
*/
public boolean isNeutral(Physical P);
/**
* Returns whether the given mobby factionmember is
* neutrally aligned due to factions.
* @param M the factionmember to check
* @return true if it is neutral
*/
public boolean isReallyNeutral(FactionMember M);
/**
* Returns whether the given mobby factionmember is
* evilly aligned due to factions.
* @param M the factionmember to check
* @return true if it is evilness
*/
public boolean isReallyEvil(FactionMember M);
/**
* Returns whether the given item, mob, room, whatever is
* evilly aligned.
* @param P the room, mob, or item to check
* @return true if it is evilness
*/
public boolean isEvil(Physical P);
/**
* Returns whether the given object has a trap set on it.
* Whether triggered or no.
* @param P the object to check
* @return true if there's a trap, false otherwise
*/
public boolean isTrapped(Physical P);
/**
* Returns whether the given mob is both a non-player
* npc, and is currently being driven (tracking)
* towards something.
* @param M the mob to check
* @return true if its a tracking npc, false otherwise
*/
public boolean isATrackingMonster(MOB M);
/**
* Returns whether the given player or npc mob is being
* driven (tracking) towards something
* @param M the mob to check
* @return true if its a tracking mob, false otherwise
*/
public boolean isTracking(MOB M);
/**
* Returns whether the given mob, item whatever is sneaking
* @param P the object to check
* @return true if its a sneaking mob, false otherwise
*/
public boolean isSneaking(Physical P);
/**
* Returns whether the given mob, item, whatever is flagged
* as being magical.
* @param P the mob/item/whatever to check
* @return true if its flagged magical, false otherwise
*/
public boolean isABonusItems(Physical P);
/**
* Returns whether the given mob, item, whatever is currently
* flagged dark
* @param P the mob/item/whatever to check
* @return true if its the dark, false otherwise
*/
public boolean isInDark(Physical P);
/**
* Returns whether the given mob, item, whatever is currently
* flagged as a light source
* @param P the mob/item/whatever to check
* @return true if its a light source, false otherwise
*/
public boolean isLightSource(Physical P);
/**
* Returns whether the given item has an item rejuv
* actively monitoring it.
* @param I the item to check
* @return true if the item is active rejuv tracked
*/
public boolean isRejuvingItem(Item I);
/**
* Returns whether the given item, mob, whatever is
* glowing.
* @param P the item, mob, whatever to check
* @return true if it is glowing, false otherwise
*/
public boolean isGlowing(Physical P);
/**
* Returns whether the given item, mob, whatever is
* marked as a golem.
* @param P the item, mob, whatever to check
* @return true if it is a golem, false otherwise
*/
public boolean isGolem(Physical P);
/**
* Returns whether the given item, mob, whatever is
* sleeping.
* @param P the item, mob, whatever to check
* @return true if it is sleeping, false otherwise
*/
public boolean isSleeping(Physical P);
/**
* Returns whether the given item, mob, whatever is
* sitting.
* @param P the item, mob, whatever to check
* @return true if it is sitting, false otherwise
*/
public boolean isSitting(Physical P);
/**
* Returns whether the given item, mob, whatever is
* flying.
* @param P the item, mob, whatever to check
* @return true if it is flying, false otherwise
*/
public boolean isFlying(Physical P);
/**
* Returns whether the given item, mob, whatever is
* floating freely and uncontrolled, as when not
* under gravity.
* @param P the item, mob, whatever to check
* @return true if it is floating, false otherwise
*/
public boolean isFloatingFreely(Physical P);
/**
* Returns whether the given item, mob, whatever is
* climbing.
* @param P the item, mob, whatever to check
* @return true if it is climbing, false otherwise
*/
public boolean isClimbing(Physical P);
/**
* Returns whether the given room, area, exit, whatever is
* crawlable (not necc. crawling).
* @param P the room, area, exit, whatever to check
* @return true if it is crawlable, false otherwise
*/
public boolean isCrawlable(Physical P);
/**
* Returns whether the given mob, item, room, whatever is
* in a outdoors non-city room.
* @param P the mob, item, room, whatever to check
* @return true if it is outdoors, false otherwise
*/
public boolean isInWilderness(Physical P);
/**
* Returns whether the given item, mob, whatever is
* marked as swimming/floating.
* @param P the item, mob, whatever to check
* @return true if it is marked swimming, false otherwise
*/
public boolean isSwimming(Physical P);
/**
* Returns whether the given item, mob, whatever is
* swimming/floating in a watery room.
* @param P the item, mob, whatever to check
* @return true if it is swimming in water, false otherwise
*/
public boolean isSwimmingInWater(Physical P);
/**
* Returns whether the given room, whatever is
* airy, such as an in the air, or an open space.
* @param R the room to check
* @return true if it is airy, false otherwise
*/
public boolean isAiryRoom(Room R);
/**
* Returns whether the given room, whatever is
* watery, such as a water surface, underwater, etc.
* @param R the room to check
* @return true if it is watery, false otherwise
*/
public boolean isWateryRoom(Room R);
/**
* Returns whether the given room, whatever is
* watery, such as a water surface, etc.
* @param R the room to check
* @return true if it is water surfacy, false otherwise
*/
public boolean isWaterySurfaceRoom(Room R);
/**
* Returns whether the given room, whatever is
* watery, such as an underwater, etc.
* @param R the room to check
* @return true if it is underwatery, false otherwise
*/
public boolean isUnderWateryRoom(Room R);
/**
* Returns whether the given room, whatever is
* the surface of deep water, such as a water surface, etc.
* with an underwater room
* @param R the room to check
* @return true if it is water surfacy, false otherwise
*/
public boolean isDeepWaterySurfaceRoom(Room R);
/**
* Returns whether the given item, mob, whatever is
* marked as falling.
* @param P the item, mob, whatever to check
* @return true if it is marked falling, false otherwise
*/
public boolean isFalling(Physical P);
/**
* Returns whether the given player is
* executing a command taking longer than 30 seconds
* @param M the mob to check
* @return true if it is long running commanding, false otherwise
*/
public boolean isRunningLongCommand(MOB M);
/**
* Returns whether the given mob is of an undead race type.
* @param mob the mob to check
* @return true if it is an undead type, false otherwise
*/
public boolean isUndead(MOB mob);
/**
* Returns whether the given mob is of a fishy race type.
* @param mob the mob to check
* @return true if it is a fishy type, false otherwise
*/
public boolean isFish(MOB mob);
/**
* Returns whether the given mob is of a marine race type.
* @param mob the mob to check
* @return true if it is a marine type, false otherwise
*/
public boolean isMarine(MOB mob);
/**
* Returns whether the given mob is of an outsider race type.
* @param mob the mob to check
* @return true if it is an outsider type, false otherwise
*/
public boolean isOutsider(MOB mob);
/**
* Returns whether the given mob is of an insect race type.
* @param mob the mob to check
* @return true if it is an insect type, false otherwise
*/
public boolean isInsect(MOB mob);
/**
* Returns whether the given mob is of a vermin race type.
* @param mob the mob to check
* @return true if it is a vermin type, false otherwise
*/
public boolean isVermin(MOB mob);
/**
* Returns whether the given mob is of a vegetable race type.
* @param M the mob to check
* @return true if it is a vegetable type, false otherwise
*/
public boolean isVegetable(MOB M);
/**
* Returns whether the given mob is of a plant-like type.
* @param M the mob to check
* @return true if it is a plant type, false otherwise
*/
public boolean isAPlant(MOB M);
/**
* Returns whether the given item is of a plant-like type.
* @param I the item to check
* @return true if it is a plant type, false otherwise
*/
public boolean isAPlant(Item I);
/**
* Returns whether the given item, mob, whatever is
* marked as unattackable.
* @param P the item, mob, whatever to check
* @return true if it is marked unattackable, false otherwise
*/
public boolean isUnattackable(Physical P);
/**
* Returns whether the given mob is alive, awake, mobile
* and not bound up. With optional explanation!
* @see CMFlagLibrary#isAliveAwakeMobile(MOB, boolean)
* @param mob the mob to check
* @return true if he/she is alive, awake, etc
*/
public boolean isAliveAwakeMobileUnbound(MOB mob, boolean quiet);
/**
* Returns whether the given mob is alive, awake, and mobile.
* With optional explanation!
* @see CMFlagLibrary#isAliveAwakeMobileUnbound(MOB, boolean)
* @param mob the mob to check
* @return true if he/she is alive, awake, etc
*/
public boolean isAliveAwakeMobile(MOB mob, boolean quiet);
/**
* Returns whether the given mob is standing (not sitting
* or sleeping)
* marked as swimming/floating.
* @param mob the mob to check
* @return true if it is standing, false otherwise
*/
public boolean isStanding(MOB mob);
/**
* Returns whether the given item, mob, whatever is
* marked as bound.
* @see CMFlagLibrary#isBoundOrHeld(Physical)
* @param P the item, mob, whatever to check
* @return true if it is marked bound, false otherwise
*/
public boolean isBound(Physical P);
/**
* Returns whether the given item, mob, whatever is
* marked as bound or is paralyzed.
* @see CMFlagLibrary#isBound(Physical)
* @param P the item, mob, whatever to check
* @return true if it is bound or paralyzed, false otherwise
*/
public boolean isBoundOrHeld(Physical P);
/**
* Returns whether the given item, mob, whatever is
* on fire.
* @param seen the item, mob, whatever to check
* @return true if it is on fire, false otherwise
*/
public boolean isOnFire(Physical seen);
/**
* Returns whether the given mob, item, whatever would
* sink or float. If it's water worthy, it will float.
* This checks things like the material of items, the
* swimming status of mobs, the boats they are in, etc.
* @param P the item, mob, whatever to check
* @return true if it is water worthy, false otherwise.
*/
public boolean isWaterWorthy(Physical P);
/**
* Returns whether the given mob, item, whatever would
* fly or fall. If it's flight worthy, it will fly.
* This checks things like the flight status of items,
* and mobs, the vehicles they are in, etc.
* @param P the item, mob, whatever to check
* @return true if it is in flight, false otherwise.
*/
public boolean isInFlight(Physical P);
/**
* Returns whether the given mob is of low animal
* intelligence.
* @param M the mob to check
* @return true if its of animal intelligence, false otherwise
*/
public boolean isAnimalIntelligence(MOB M);
/**
* Returns whether the given mob, item, whatever has a
* behavior making it move around.
* @param P the mob, item, whatever to check
* @return true if the object will move around, false otherwise
*/
public boolean isMobile(PhysicalAgent P);
/**
* Returns whether the first given mob is potentially or
* probably agressive to the second mob.
* @param M the mob who might be aggressive
* @param toM the mob who might be in trouble
* @return true if the first mob might be aggressive
*/
public boolean isAggressiveTo(MOB M, MOB toM);
/**
* Returns whether the first given mob is potentially or
* probably agressive.
* @param M the mob who might be aggressive
* @return true if the mob might be aggressive
*/
public boolean isPossiblyAggressive(MOB M);
/**
* Returns whether the given mob, item (baby) whatever is
* a baby, or a mob child born from something, what its
* age still being tracked by property.
* @param E the potential child
* @return true if its a child, false otherwise
*/
public boolean isChild(Environmental E);
/**
* Returns whether the given mob (item usually) is a
* baby waiting to grow up.
* @param E the item to check
* @return true if its a baby, false otherwise
*/
public boolean isBaby(Environmental E);
/**
* Returns whether the given mob (item usually) is made
* of metal or mithril.
* @param E the item (or mob) to check
* @return true if its made of metal, false otherwise
*/
public boolean isMetal(Environmental E);
/**
* Returns whether the given room, item, whatever has a
* deadly effect, such as a trap, autodeath behavior, or
* a property with a malicious spell in it.
* @param P the room, item, whatever to check
* @return true if it has a potentially malicious effect
*/
public boolean isDeadlyOrMaliciousEffect(final PhysicalAgent P);
/**
* Returns whether the given Area is actually in the game, or is
* just temporary or cached.
* @param E the Area to check
* @param reqInhabitation meaningless
* @return true if the area is in the game, false otherwise
*/
public boolean isInTheGame(Area E, boolean reqInhabitation);
/**
* Returns whether the given Room is actually in the game, or is
* just temporary or cached.
* @param E the Room to check
* @param reqInhabitation meaningless
* @return true if it is in the game, false otherwise
*/
public boolean isInTheGame(Room E, boolean reqInhabitation);
/**
* Returns whether the given Item is actually in the game, and in
* a room, or is just temporary or cached.
* @param E the Item to check
* @param reqInhabitation true if it must be a in room, false otherwise
* @return true if it is in the game, false otherwise
*/
public boolean isInTheGame(Item E, boolean reqInhabitation);
/**
* Returns whether the given MOB is actually in the game, and in
* a room, or is just temporary or cached.
* @param E the MOB to check
* @param reqInhabitation true if it must be a in room, false otherwise
* @return true if it is in the game, false otherwise
*/
public boolean isInTheGame(MOB E, boolean reqInhabitation);
/**
* Returns whether the given mob, item, room, area, whatever is actually
* in the game, and possibly in a room, or is just temporary or cached.
* @param E the mob, item, whatever to check
* @param reqInhabitation true if it must be a in room, false otherwise
* @return true if it is in the game, false otherwise
*/
public boolean isInTheGame(Environmental E, boolean reqInhabitation);
/**
* Returns whether the given item has some effect other than a disease,
* poison, or standard property.
* @param I the item to check
* @return true for a spell or some other enchantment, false otherwise
*/
public boolean isEnchanted(Item I);
/**
* Returns whether the given invoker mob is controlling the
* given mob, who is following the invoker, optionally using
* the given Ability.
* @param invoker the mob who might be the leader
* @param mob the mob who is following the leader
* @param A the ability that might be causing the control
* @return true if the mob is a controlled follower
*/
public boolean isAControlledFollower(MOB invoker, MOB mob, Ability A);
/**
* Returns whether the given invoker mob is controlling a
* mob, who is following the invoker, optionally using
* the given Ability.
* @param invoker the mob who might be the leader
* @param A the ability that might be causing the control
* @return true if the mob is a controlled follower
*/
public boolean hasAControlledFollower(MOB invoker, Ability A);
/**
* Returns the simple word that would describe the alignment
* of the given mob or item or whatever.
* @param E the mob or item or whatever
* @return the name of its alignment, e.g. good, evil, neutral
*/
public String getAlignmentName(Environmental E);
/**
* Deprecated, but returns the total hide detection score
* for the given mob.
* @param seer the mob trying to see hidden
* @return the total hide detection score
*/
public int getDetectScore(MOB seer);
/**
* Deprecated, but returns the total hide score
* for the given mob, item, whatever.
* @param seen the mob, item trying to be hidden
* @return the total hide score
*/
public int getHideScore(Physical seen);
/**
* Returns the list of behaviors that have the given behavior
* flag(s) set.
* @see com.planet_ink.coffee_mud.Behaviors.interfaces.Behavior#FLAG_LEGALBEHAVIOR
* @param P the mob, item, room, whatever
* @param flag the behavior flags
* @return the list of behaviors that have the given flag(s) set.
*/
public List<Behavior> flaggedBehaviors(PhysicalAgent P, long flag);
/**
* Returns the list of effects that have the given ability
* flag(s) set.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#flags()
* @param P the mob, item, room, whatever
* @param flag the ability flags
* @return the list of effects that have the given flag(s) set.
*/
public List<Ability> flaggedAnyAffects(Physical P, long flag);
/**
* Returns the list of effects that have the given ability
* flag(s) set.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#flags()
* @param P the mob, item, room, whatever
* @param flag the ability flags
* @return the list of effects that have the given flag(s) set.
*/
public List<Ability> flaggedAffects(Physical P, long flag);
/**
* Returns the list of Abilities that have the given ability
* flag(s) set.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#flags()
* @param M the mob
* @param flag the ability flags
* @return the list of abilities that have the given flag(s) set.
*/
public List<Ability> flaggedAbilities(MOB M, long flag);
/**
* Returns the list of effects that have are part of the
* given ability domain.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_ABJURATION
* @param P the mob, item, room, whatever
* @param domain the ability domain
* @return the list of effects in the given domain.
*/
public List<Ability> domainAnyAffects(Physical P, int domain);
/**
* Returns the list of effects that have are part of the
* given ability domain.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_ABJURATION
* @param P the mob, item, room, whatever
* @param domain the ability domain
* @return the list of effects in the given domain.
*/
public List<Ability> domainAffects(Physical P, int domain);
/**
* Returns the list of abilities that have are part of the
* given ability domain.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_ABJURATION
* @param M the mob to check
* @param domain the ability domain
* @return the list of abilities in the given domain.
*/
public List<Ability> domainAbilities(MOB M, int domain);
/**
* Returns the list of effects that are on the given physical,
* and were invoked by the given invoker. The ability flag,
* abilityCode, and domain are optional, and may be -1 to ignore.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_ABJURATION
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#flags()
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#ACODE_CHANT
* @param invoker the invoker to search for, or null
* @param P the object to check for effects, REQUIRED
* @param flag -1, or an Ability Flag
* @param abilityCode -1, or an ability Code
* @param domain -1, or an ability domain
* @return the list of effects that match
*/
public List<Ability> matchedAffects(final MOB invoker, final Physical P, final long flag, final int abilityCode, final int domain);
/**
* Returns the ability type/code name for the given Ability.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#ACODE_CHANT
* @param A the Ability
* @return "" or the Ability code of the given Ability
*/
public String getAbilityType(Ability A);
/**
* Returns the ability type/code name for the given Ability.
* This one has any spaces in the type replaced with _
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#ACODE_CHANT
* @param A the Ability
* @return "" or the Ability code of the given Ability
*/
public String getAbilityType_(Ability A);
/**
* Returns the ability domain name for the given Ability.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_DESCS
* @param A the Ability
* @return "" or the Ability domain name of the given Ability
*/
public String getAbilityDomain(Ability A);
/**
* Returns the ability type code for the given ability type name.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#ACODE_CHANT
* @param name the name of the given ability type
* @return the Ability type code of the given name
*/
public int getAbilityType(String name);
/**
* Returns the ability type code for the given ability type name.
* This one has any spaces in the type replaced with _
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#ACODE_CHANT
* @param name the name of the given ability type
* @return the Ability type code of the given name
*/
public int getAbilityType_(String name);
/**
* Returns the ability domain bitmask for the given ability domain name.
* @see com.planet_ink.coffee_mud.Abilities.interfaces.Ability#DOMAIN_DESCS
* @param name the name of the given ability domain
* @return "" or the Ability code of the given name
*/
public int getAbilityDomain(String name);
/**
* Returns the friendly descriptive age of the given mob,
* whether baby, child, player, whatever.
* @param M the mob to check
* @return the friendly age of the mob
*/
public String getAge(MOB M);
/**
* Returns the disposition blurbs that apply to the given seen
* mob, item, room, whatever, as soon by the given seer mob.
* These are friendly colored string
* @param seen the mob, item, room, whatever
* @param seer the one seeing
* @return the disposition blurbs list
*/
public String getDispositionBlurbs(Physical seen , MOB seer);
/**
* Returns whether the two given physical objects appear the exact
* same way to the given seer mob. This is for determining duplicates
* in item lists mostly.
* @param seer the mob who is seeing stuff
* @param seen1 the first object being seen
* @param seen2 the first object being seen
* @return true if the two seens appear the same way
*/
public boolean isSeenTheSameWay(MOB seer, Physical seen1, Physical seen2);
/**
* Returns the present-tense verb that applies to the disposition of the
* given seen thing, given the detail about how they verbbing.
* @param seen the mob (or item) that is verbbing
* @param flag_msgType whether they are arriving, leaving, or sitting there verbbing
* @return the appropriate verb word for their disposition
*/
public String getPresentDispositionVerb(Physical seen, ComingOrGoing flag_msgType);
/**
* Checks the list of ability objects against the effects of the given mob, item
* or whatever.
* @param obj the mob, item, room, whatever
* @param oneOf the list of abilities that might be affects
* @param anyTallF true to return true on ANY, false to return true only for ALL
* @return true if the conditions are met, false otherwise
*/
public boolean isStillAffectedBy(Physical obj, List<Ability> oneOf, boolean anyTallF);
/**
* Returns a command-delimited list of dispassionate description of the disposition
* of the given physical mob, item, whatever.
* @param obj the disposed physical mob, item, whatever
* @param useVerbs true to return an active phrase, flags for a state phrase
* @return the comma-delimited list of descriptive dispositions
*/
public String getDispositionDescList(Physical obj, boolean useVerbs);
/**
* Returns a command-delimited list of dispassionate description of the senses
* of the given physical mob, item, whatever.
* @param obj the sensing physical mob, item, whatever
* @param useVerbs true to return an active phrase, flags for a state phrase
* @return the comma-delimited list of descriptive senses
*/
public String getSensesDescList(Physical obj, boolean useVerbs);
/**
* Returns the enumerated disposition index associated with the given
* disposition name, such as ISSWIMMING, etc.
* @param name the disposition name
* @return the index
*/
public int getDispositionIndex(String name);
/**
* Returns the enumerated senses index associated with the given
* senses name, such as CANSEEDARK, etc.
* @param name the senses name
* @return the index
*/
public int getSensesIndex(String name);
/**
* Returns a comma delimited list of the senses masks
* on the given mob. These are lowercase state phrases.
* @param mob the mob to check
* @return the list of senses mask words
*/
public String getSensesStateList(MOB mob);
/**
* Returns a comma delimited list of the senses masks
* on the given mob. These are lowercase state phrases.
* @param mob the mob to check
* @return the list of senses mask words
*/
public String getDispositionStateList(MOB mob);
/**
* A disposition enum for various flagg methods.
* Helps determine the english phrasing of what's
* returned.
* @author Bo Zimmerman
*
*/
public enum ComingOrGoing
{
ARRIVES,
LEAVES,
IS;
}
}
