JS-AURA

For immortals Also: JAVASCRIPT-ROOM

The Aura object represents auras.

Class Methods:

byName( name )   Returns the aura object that goes by the given name.  For
                 example: Aura.byName( "detect-invisibility" );

Class Properties:

list             Returns an array of the mud's auras.
  list.length    Contains the total number of auras on the mud.
  list[ num ]    Returns the aura at position "num".

Properties:

db               The database object for this aura (see JS-DB).  Note
                 that all auras of the same type share the same db object.
                 For example, two "stat" auras will share the same db object.
keyName          The key name of this aura.
shortDesc        The short description of this aura.
longDesc         The long description of this aura.
args             Returns an object which contains the arguments passed to
                 this aura.
  args.length    Contains the number of arguments passed to this aura.
  args[ num ]    Returns the given argument where "num" is a number between
                 0 and 9.  (The first argument is argument #0.)
on               This returns the character or object that this aura is
                 currently placed on.  If an aura is placed directly on
                 a character, it will return the character.  If the aura
                 is part of an item, on will return that (though you can
                 still use "on.bearer()" to get the character even for
                 auras from objects).
controller       Who is this aura's controller? (see JS-CONTROLLER)
type             Returns the type of this aura.  See AURA-TYPES.

Methods:

isActive()          Returns true if the aura is active.
isAura()            Returns true
isMobile()          Returns false
isObj()             Returns false
isRoom()            Returns false
isControlledByPC()  Returns true if this aura is under the control of a PC.
like()              See JS-LIKE.
toString()          Returns the name of the room.
damage()            Does damage.  See JS-ELEMENT-DAMAGE.
valueOf()           Returns the name of the room.
isAvailableTo( t )  Returns true if this aura is available to the character t.
hasAura( n )        Returns true if this aura has this aura.
                    (Yes, auras can contain other auras.)
                    This method supports cardinalities -- see JS-CARDINALITY.
addAura()           See JS-ELEMENT.
removeAura()        See JS-ELEMENT.
addAuraCat()        See JS-ELEMENT.
removeAuraCat()     See JS-ELEMENT.