All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class key.Command

java.lang.Object
   |
   +----key.Atom
           |
           +----key.Command

public abstract class Command

extends Atom

Command()

getElementInside(InteractiveConnection, String, Container)

getElementInside(InteractiveConnection, String, Type, Container)

getOnlinePlayer(Player, InteractiveConnection, String)

The basic concept is this: The routine returns a player, or null.

getPlayer(InteractiveConnection, String)

This routine will return a Player or null.

getPlayerInside(Player, InteractiveConnection, String, Scape)

An atom is returned in case they are like 'player,player,player', so it will return a scape

getSymbol(InteractiveConnection, String)

A slightly higher level routine - will match the symbol and give error messages as appropriate.

getSymbol(InteractiveConnection, String, Type)

getSymbolInside(InteractiveConnection, String, Atom)

getSymbolInside(InteractiveConnection, String, Type, Atom)

getTagElementInside(InteractiveConnection, String, Container)

getTagSymbolInside(InteractiveConnection, String, Atom)

run(Player, StringTokenizer, String, ModalCommand, InteractiveConnection, Flags)

If this method is not overridden, it calls the others.

setOrDefault(DataProperty, DataProperty)

Returns self if its non-null, else main (string properties only)

usage(InteractiveConnection)

 public Command()

 public void usage(InteractiveConnection ic)

 public abstract void run(Player p,
                          StringTokenizer args,
                          String fullLine,
                          ModalCommand caller,
                          InteractiveConnection ic,
                          Flags flags) throws IOException

If this method is not overridden, it calls the others. Only override *one*, depending on what arguments you want to recieve

Presumably you'll want to do one or the other, overload the method you'd prefer

Parameters:

p - the player who is executing the command

args - a tokenizer (whitespace) for the command arguments

fullLine - the complete line that was typed

caller - the parent ModalCommand that contains this command

ic - the interactiveConnection to send the results to

 public final Atom getPlayerInside(Player p,
                                   InteractiveConnection ic,
                                   String name,
                                   Scape inside)

An atom is returned in case they are like 'player,player,player', so it will return a scape

 public final Atom getOnlinePlayer(Player p,
                                   InteractiveConnection ic,
                                   String name)

The basic concept is this: The routine returns a player, or null. If it returns null, it has already output an error message to the player involved, so you don't have to. (just return) An atom is returned in case they are like 'player,player,player', so it will return a scape

 public final Symbol getTagSymbolInside(InteractiveConnection ic,
                                        String s,
                                        Atom inside)

 public final Atom getSymbolInside(InteractiveConnection ic,
                                   String s,
                                   Atom inside)

 public final Atom getSymbol(InteractiveConnection ic,
                             String s)

A slightly higher level routine - will match the symbol and give error messages as appropriate. It is not necessary to check for anything other than the return being null, in which case an error has already been sent to the provided connection.

 public final Tag getTagElementInside(InteractiveConnection ic,
                                      String s,
                                      Container inside)

 public final Atom getElementInside(InteractiveConnection ic,
                                    String s,
                                    Type type,
                                    Container inside)

 public final Atom getElementInside(InteractiveConnection ic,
                                    String s,
                                    Container inside)

 public final Atom getSymbolInside(InteractiveConnection ic,
                                   String s,
                                   Type type,
                                   Atom i)

 public final Atom getSymbol(InteractiveConnection ic,
                             String s,
                             Type type)

 public final Player getPlayer(InteractiveConnection ic,
                               String name)

This routine will return a Player or null.

 protected final String setOrDefault(DataProperty self,
                                     DataProperty main)

Returns self if its non-null, else main (string properties only)

All Packages  Class Hierarchy  This Package  Previous  Next  Index