Package com.planet_ink.coffee_mud.Abilities.Properties

Class Property

java.lang.Object

com.planet_ink.coffee_mud.Abilities.ThinAbility

com.planet_ink.coffee_mud.Abilities.Properties.Property

All Implemented Interfaces:

Ability, CMObject, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable, java.lang.Cloneable, java.lang.Comparable<CMObject>

Direct Known Subclasses:

Prop_AbilityImmunity, Prop_AbsorbDamage, Prop_AddDamage, Prop_AreaForSale, Prop_Artifact, Prop_AstralSpirit, Prop_ClanEquipment, Prop_Climbable, Prop_CloseCommand, Prop_ClosedDayNight, Prop_ClosedSeason, Prop_CombatAdjuster, Prop_CommonTwister, Prop_Crawlspace, Prop_Doppleganger, Prop_EnlargeRoom, Prop_EnterAdjuster, Prop_Familiar, Prop_Fumble, Prop_HaveAdjuster, Prop_HaveResister, Prop_HaveZapper, Prop_Hidden, Prop_IceBox, Prop_ImproveGather, Prop_InstantDeath, Prop_Invisibility, Prop_ItemBinder, Prop_ItemNoRuin, Prop_ItemSlot, Prop_ItemSlotFiller, Prop_ItemTransporter, Prop_ItemTransReceiver, Prop_LangTranslator, Prop_LanguageSpeaker, Prop_LimitedContents, Prop_LimitedEquip, Prop_LimitedItems, Prop_LocationBound, Prop_MagicFreedom, Prop_MOBEmoter, Prop_ModExperience, Prop_ModFaction, Prop_MoveRestrictor, Prop_MultiEffects, Prop_NarrowLedge, Prop_NewDeathMsg, Prop_NoChannel, Prop_NoCharm, Prop_NoCraftability, Prop_NoDamage, Prop_NoOrdering, Prop_NoPKill, Prop_NoPurge, Prop_NoRecall, Prop_NoSummon, Prop_NoTeleport, Prop_NoTeleportOut, Prop_NoTelling, Prop_OpenCommand, Prop_OpenPassword, Prop_OutfitContainer, Prop_PeaceMaker, Prop_PracticeDummy, Prop_PrivateProperty, Prop_PropSetter, Prop_QuestGiver, Prop_ReqAlignments, Prop_ReqCapacity, Prop_ReqClasses, Prop_ReqEntry, Prop_ReqHeight, Prop_ReqLevels, Prop_ReqNoMOB, Prop_ReqPKill, Prop_ReqRaces, Prop_ReqStat, Prop_ReqTattoo, Prop_ReRollStats, Prop_RestrictSkills, Prop_RestrictSpells, Prop_Retainable, Prop_RoomDark, Prop_RoomForSale, Prop_RoomLit, Prop_RoomRedirect, Prop_RoomUnmappable, Prop_RoomView, Prop_RoomWatch, Prop_SafePet, Prop_ScrapExplode, Prop_ShortEffects, Prop_Smell, Prop_Socials, Prop_Sounder, Prop_SparringRoom, Prop_SpellAdder, Prop_SpellReflecting, Prop_StatAdjuster, Prop_StatTrainer, Prop_StayAboard, Prop_Tattoo, Prop_TattooAdder, Prop_TicketTaker, Prop_Transporter, Prop_Trashcan, Prop_Uncampable, Prop_Unsellable, Prop_UseEmoter, Prop_WeakBridge, Prop_WeaponImmunity, Prop_WearOverride, Prop_Weather, Prop_WizInvis

public class Property
extends ThinAbility

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DESCS_, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_TECH, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CACHEINDEX_CLASSLESS, CACHEINDEX_EXPERTISE, CACHEINDEX_LASTTIME, CACHEINDEX_NORMAL, CACHEINDEX_TOTAL, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, COST_ALL, COST_NORMAL, COST_PCT, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_BUILDINGSKILL, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_COSMOLOGY, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_EDUCATIONLORE, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EPICUREAN, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_ROPEUSE, DOMAIN_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_TRAVEL, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WATERCONTROL, DOMAIN_WATERLORE, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_ADJUSTER, FLAG_AGGROFYING, FLAG_AIRBASED, FLAG_BINDING, FLAG_CASTER, FLAG_CHAOS, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ELECTRICBASED, FLAG_ENABLER, FLAG_FEARING, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_LAW, FLAG_MINDALTERING, FLAG_MODERATE, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NODISENCHANT, FLAG_NONENCHANTMENT, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_STEALING, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, POWER_COST_THRESHOLD, POWER_LEVEL_THRESHOLD, POWER_OVERRIDE_THRESHOLD, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, TICKS_ALMOST_FOREVER, TICKS_FOREVER, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_COUNT, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT, USAGEINDEX_TIMELSW, USAGEINDEX_TOTAL

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Abilities.ThinAbility

affected, amDestroyed, empty, miscText, savable

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
Property()

Method Summary

Modifier and Type	Method	Description
boolean	canAffect(int can_code)	Returns whether, when used as a property/effect, this ability can affect the given type of object.
boolean	canAffect(Physical P)	Returns whether, when used as a property/effect, this ability can affect the given object.
protected int	canAffectCode()	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
boolean	canTarget(int can_code)	Returns whether, when used as a skill, this ability can target itself at an object of the given type.
protected int	canTargetCode()	Designates whether, when invoked as a skill, what sort of objects this ability can effectively target.
int	classificationCode()	Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain.
CMObject	copyOf()	Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String	name()	The nice displayable name of this instance of this object
CMObject	newInstance()	Returns a new instance of this class.
boolean	sameAs(Environmental E)	Whether this object instance is functionally identical to the object passed in.
void	setDescription(java.lang.String newDescription)	Sets the basic description of this object, as shown when the item is directly LOOKed at.
void	setDisplayText(java.lang.String newDisplayText)	Sets the raw string used to show what this object looks like in the room.

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Abilities.ThinAbility

abilityCode, abstractQuality, accountForYourself, adjustedLevel, affectCharState, affectCharStats, affecting, affectPhyStats, amDestroyed, appropriateToMyFactions, autoInvocation, bubbleAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, castingQuality, castingTime, checkedCastingCost, combatCastingTime, compareTo, description, destroy, displayText, enchantQuality, executeMsg, expirationDate, externalFiles, flags, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, getTrainingCost, helpProficiency, image, initializeClass, invoke, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maxRange, mayBeEnchanted, minRange, miscTextFormat, Name, okMessage, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, rawImage, requirements, setAbilityCode, setAffectedOne, setExpirationDate, setImage, setInvoker, setMiscText, setName, setProficiency, setSavable, setStat, startTickDown, teach, text, tick, triggerStrings, unInvoke, unlearn, usageCost, usageType

Constructor Detail

Property

public Property()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class ThinAbility

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Tickable

The nice displayable name of this instance of this object

Specified by:

name in interface CMObject

Specified by:

name in interface Tickable

Overrides:

name in class ThinAbility

Returns:

the displayable name of this object instance

See Also:

Environmental.Name()

canAffectCode

protected int canAffectCode()

Designates whether, when used as a property/effect, what sort of objects this ability can affect. Uses the Ability.CAN_* constants.

Returns:

a mask showing the type of objects this ability can affect

See Also:

Ability

canTargetCode

protected int canTargetCode()

Designates whether, when invoked as a skill, what sort of objects this ability can effectively target. Uses the Ability.CAN_* constants.

Returns:

a mask showing the type of objects this ability can target

See Also:

Ability

canTarget

public boolean canTarget(int can_code)

Description copied from interface: Ability

Returns whether, when used as a skill, this ability can target itself at an object of the given type. This method derives its answer from the protected integer method canTargetCode(), and requires one of the Ability.CAN_* constants.

Specified by:

canTarget in interface Ability

Overrides:

canTarget in class ThinAbility

Parameters:

can_code - a bitmap of one or more Ability.CAN_* constants

Returns:

whether the object type is a valid target

See Also:

StdAbility.canTargetCode()

canAffect

public boolean canAffect(int can_code)

Description copied from interface: Ability

Returns whether, when used as a property/effect, this ability can affect the given type of object. This method derives its answer from the protected integer method canAffectCode(), and requires one of the Ability.CAN_* constants.

Specified by:

canAffect in interface Ability

Overrides:

canAffect in class ThinAbility

Parameters:

can_code - a bitmap of one or more Ability.CAN_* constants

Returns:

whether the object object type may have this as a property/effect

See Also:

Ability, StdAbility.canAffectCode()

setDescription

public void setDescription(java.lang.String newDescription)

Description copied from interface: Environmental

Sets the basic description of this object, as shown when the item is directly LOOKed at.

Specified by:

setDescription in interface Environmental

Overrides:

setDescription in class ThinAbility

Parameters:

newDescription - the basic detail description of this object

setDisplayText

public void setDisplayText(java.lang.String newDisplayText)

Description copied from interface: Environmental

Sets the raw string used to show what this object looks like in the room. May be used as a basis for other methods, such as the title of rooms, and what an exit looks like when open. The value for Items may be null if the item is not displayed when the room is seen.

Specified by:

setDisplayText in interface Environmental

Overrides:

setDisplayText in class ThinAbility

Parameters:

newDisplayText - the string describing how this object looks in the room

classificationCode

public int classificationCode()

Description copied from interface: Ability

Returns a bitmap describing the general classification of the skill (spell, skill, chant, or property, etc) and its domain. It is made up of the ACODE_* constants the Ability interface, and optionally the DOMAIN_* constants also defined in this interface.

Specified by:

classificationCode in interface Ability

Overrides:

classificationCode in class ThinAbility

Returns:

ACODE_* constant classification

See Also:

Ability

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Overrides:

newInstance in class ThinAbility

Returns:

a new instance of this class

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Overrides:

copyOf in class ThinAbility

Returns:

a clone of this object

canAffect

public boolean canAffect(Physical P)

Description copied from interface: Ability

Returns whether, when used as a property/effect, this ability can affect the given object. This method derives its answer from the protected integer method canAffectCode()

Specified by:

canAffect in interface Ability

Overrides:

canAffect in class ThinAbility

Parameters:

P - the potential object to have this as a property/effect

Returns:

whether E is a valid object to have this as a property/effect

See Also:

StdAbility.canAffectCode()

sameAs

public boolean sameAs(Environmental E)

Description copied from interface: Environmental

Whether this object instance is functionally identical to the object passed in. Works by repeatedly calling getStat on both objects and comparing the values.

Specified by:

sameAs in interface Environmental

Overrides:

sameAs in class ThinAbility

Parameters:

E - the object to compare this one to

Returns:

whether this object is the same as the one passed in

See Also:

Modifiable.getStatCodes(), Modifiable.getStat(String)