Field Detail

readableText

Constructor Detail

GenPersonalShield

Method Detail

ID

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.

isGeneric

Whether the fields of this item are set in code, or set by builders. Generic means that
they are set by builders, in which case XML is returned by the text() method containing
all of the values for all the fields.

text

For objects which have false for their isGeneric method, this is used to set any internally
coded strings to change the nature or behavior of the object. For objects which have true
for their isGeneric method, this is used to set and parse the XML which will be used to
fill out the fields in this object. Since Ability objects are never Generic, this will always
be where parameters are read from an Ability instance.

setMiscText

For objects which have false for their isGeneric method, this is used to set any internally
coded strings to change the nature or behavior of the object. For objects which have true
for their isGeneric method, this is used to set and parse the XML which will be used to
fill out the fields in this object. Since Ability objects are never Generic, this will always
be where parameters are read from an Ability instance.

getStat

An alternative means of retreiving the values of those fields on this object which are modifiable at
run-time by builders. See getStatCodes() for possible values for the code passed to this method.
Values returned are always strings, even if the field itself is numeric or a list.

setStat

An alternative means of setting the values of those fields on this object which are modifiable at
run-time by builders. See getStatCodes() for possible values for the code passed to this method.
The value passed in is always a string, even if the field itself is numeric or a list.