All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class key.Scape

java.lang.Object
   |
   +----key.Atom
           |
           +----key.Container
                   |
                   +----key.Scape

public class Scape

extends Container

implements CommandContainer

allNamesProperty

commandList

Commands that are specific for this particular atom.

numberPlayersProperty

staticCommandList

This is a reference to some sort of 'standard' command list for this _type_ of atom.

Scape()

canSwap()

containsPlayer(Player)

dispose()

This is a method that should be called only once.

evalReadOnlyProperty(ReadOnlyProperty)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

finalize()

getAllNames()

getAllNames(Player)

All the names, except substitute 'you' for player p

getCommandList()

A shortcut, since matching it from the string could be prohibitively slow

getPlayer(Player, String)

Returns the player matched, or, possibly, an instance of a Trie object that contains all the matching players.

getPlayer(Player, StringTokenizer)

getPlayer(String)

getStaticCommandList()

A shortcut, since matching it from the string could be prohibitively slow

getTotalScapes()

linkPlayer(Player)

Add this player to the list of players

numberPlayers()

players()

splash(Effect, SuppressionList)

A general way of saying that the people in this scape should be notified of the supplied Effect.

splashExcept(Effect, Atom, SuppressionList)

Sends the splash to everyone except the listed atom

splashExcept(Effect, Atom[], SuppressionList)

Sends the splash to everyone except the listed atoms

splashToPlayer(Player, Effect, SuppressionList)

unlinkPlayer(Player)

Take this player out of the list of players

 protected ReadOnlyProperty numberPlayersProperty

 protected ReadOnlyProperty allNamesProperty

 protected AtomicProperty commandList

Commands that are specific for this particular atom. Examples might be custom commands in rooms, such as 'look' (if its overridden to give different messages each time you type it)

 protected ReferenceProperty staticCommandList

This is a reference to some sort of 'standard' command list for this _type_ of atom. It will generally be set when the atom is created or loaded, and left to its own devices after that.

 public Scape()

 public void linkPlayer(Player p) throws NonUniqueKeyException, BadKeyException

Add this player to the list of players

Parameters:

p - the player to add to the list

Throws: NonUniqueKeyException

if there is already a player in with this name

Throws: BadKeyException

if this players name is malformed somehow

 public void unlinkPlayer(Player p) throws NonUniqueKeyException, NoSuchElementException, BadKeyException

Take this player out of the list of players

Parameters:

p - the player to remove from the list

Throws: NoSuchElementException

if the player is not in the list

Throws: BadKeyException

if the players name is malformed somehow

 public final Object getPlayer(Player p,
                               String match)

Returns the player matched, or, possibly, an instance of a Trie object that contains all the matching players.

A null is returned if no matches were found at all. The match string is searched until the end of the string or a non-alphabetical character is found.

If you specify a comma seperated list of players, a scape containing the players will be returned. Such a scape can also contain errors when individual multiple matches are caught

Parameters:

match - the start or whole string to match from

Returns:

A player object, referring to the sole match, or a Trie

 public final Object getPlayer(String match)

 protected final Object getPlayer(Player p,
                                  StringTokenizer st)

 public final Enumeration players()

 public final boolean containsPlayer(Player p)

 public void dispose()

This is a method that should be called only once.

Overrides:

dispose in class Container

 public final String getAllNames()

 public final String getAllNames(Player p)

All the names, except substitute 'you' for player p

 public final int numberPlayers()

 public Object evalReadOnlyProperty(ReadOnlyProperty p)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

Overrides:

evalReadOnlyProperty in class Container

 public void splash(Effect t,
                    SuppressionList s)

A general way of saying that the people in this scape should be notified of the supplied Effect.

Overrides:

splash in class Atom

 protected final void splashToPlayer(Player p,
                                     Effect t,
                                     SuppressionList sl)

 public void splashExcept(Effect t,
                          Atom except,
                          SuppressionList sl)

Sends the splash to everyone except the listed atom

 public void splashExcept(Effect t,
                          Atom except[],
                          SuppressionList sl)

Sends the splash to everyone except the listed atoms

 public final CommandList getCommandList()

A shortcut, since matching it from the string could be prohibitively slow

 public final CommandList getStaticCommandList()

A shortcut, since matching it from the string could be prohibitively slow

 public static int getTotalScapes()

 protected void finalize() throws Throwable

Overrides:

finalize in class Container

 public boolean canSwap()

Overrides:

canSwap in class Atom

All Packages  Class Hierarchy  This Package  Previous  Next  Index