Class TinyMudCommands

java.lang.Object
  |
  +--mstar.Commands
        |
        +--TinyMudCommands

public class TinyMudCommands

extends Commands

Implements the Commands class for TinyMud's.

Version:

1.1

Author:

Thaddeus O. Cooper (cooper@tweenproject.org)

Constructor Summary

TinyMudCommands()

Method Summary

void	describe(java.lang.String description) Sends the describe command to the collaborative environment.
void	emote(java.lang.String who, java.lang.String what) Sends an emote command to the collaborative environment.
java.lang.String	getHowPages() Deprecated.
java.lang.String	getHowSays() Deprecated.
java.lang.String	getHowWhispers() Deprecated.
void	go(java.lang.String where) Send the go command to the collaborative environment.
void	goHome() A special case of the go command to send a player back to his or her default room in the collaborative environment.
void	inventory() Sends the inventory command to the collaborative environment.
void	look(java.lang.String at) Send the look command to the collaborative environment.
void	mutter(java.lang.String who, java.lang.String what) Sends a muttered message to everyone except the character in the collaborative environment.
void	page(java.lang.String who, java.lang.String what) Sends a page to a specific character in the collaborative environment.
void	pose(java.lang.String what) Send the pose command to the collaborative environment.
void	quit() Sends the command to the collaborative environment to end the current session.
void	say(java.lang.String what) Send the say command to the collaborative environment.
void	set(java.lang.String what, java.lang.String flag) Sends the set command to the collaborative environment.
void	setOutputPrefix(java.lang.String what) Sends the OUTPUTPREFIX command to the collaborative environment.
void	setOutputSuffix(java.lang.String what) Sends the OUTPUTSUFFIX command to the collaborative environment.
void	whisper(java.lang.String who, java.lang.String what) Sends a whispered message to a specific character in the collaborative environment.
void	yell(java.lang.String what) Send the yell command to the collaborative environment.

Methods inherited from class mstar.Commands

getInputStream, getOutputStream, setInputStream, setOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

TinyMudCommands

public TinyMudCommands()

Method Detail

look

public void look(java.lang.String at)

Send the look command to the collaborative environment.

Overrides:

look in class Commands

Parameters:

at - the object in the collaborative environment to look at. This parameter may be null.

say

public void say(java.lang.String what)

Send the say command to the collaborative environment.

Overrides:

say in class Commands

Parameters:

what - to say.

yell

public void yell(java.lang.String what)

Send the yell command to the collaborative environment.

Overrides:

yell in class Commands

Parameters:

what - to yell.

pose

public void pose(java.lang.String what)

Send the pose command to the collaborative environment.

Overrides:

pose in class Commands

Parameters:

what - fake action to perform.

page

public void page(java.lang.String who,
                 java.lang.String what)

Sends a page to a specific character in the collaborative environment.

Overrides:

page in class Commands

Parameters:

who - to send the page to.

what - the message is. What may be null. If it is null then the character being paged will receive a message similar to: foo is looking for you in somewhere

whisper

public void whisper(java.lang.String who,
                    java.lang.String what)

Sends a whispered message to a specific character in the collaborative environment.

Overrides:

whisper in class Commands

Parameters:

who - to send the whisper to.

what - the message is.

mutter

public void mutter(java.lang.String who,
                   java.lang.String what)

Sends a muttered message to everyone except the character in the collaborative environment.

Overrides:

mutter in class Commands

Parameters:

who - not to send the message to.

what - the message is.

emote

public void emote(java.lang.String who,
                  java.lang.String what)

Sends an emote command to the collaborative environment. An emote command is a cross between a page and a pose command and can be used to express actions to other players at a distance.

Overrides:

emote in class Commands

Parameters:

who - to send the emote to.

what - the emoted action is.

go

public void go(java.lang.String where)

Send the go command to the collaborative environment. The go command is how characters navigate from room to room in the collaborative environment.

Overrides:

go in class Commands

Parameters:

where - the direction to go.

goHome

public void goHome()

A special case of the go command to send a player back to his or her default room in the collaborative environment.

Overrides:

goHome in class Commands

quit

public void quit()

Sends the command to the collaborative environment to end the current session.

Overrides:

quit in class Commands

set

public void set(java.lang.String what,
                java.lang.String flag)

Sends the set command to the collaborative environment. The set command lets players change attributes of themselves and other objects in the collaborative environment.

Overrides:

set in class Commands

Parameters:

what - to set.

flag - the value to set on the object.

inventory

public void inventory()

Sends the inventory command to the collaborative environment. This command tells the collaborative environment to list the objects that the character is carrying.

Overrides:

inventory in class Commands

setOutputPrefix

public void setOutputPrefix(java.lang.String what)

Sends the OUTPUTPREFIX command to the collaborative environment. This command is used to tell the collaborative environment to send a particular string at the beginning of each command that is generated by the character.

Overrides:

setOutputPrefix in class Commands

Parameters:

what - the string to prefix the output of a command with.

setOutputSuffix

public void setOutputSuffix(java.lang.String what)

Sends the OUTPUTSUFFIX command to the collaborative environment. This command is used to tell the collaborative environment to send a particular string at the end of each command that is generated by the character.

Overrides:

setOutputSuffix in class Commands

Parameters:

what - the string to suffix the output of a command with.

describe

public void describe(java.lang.String description)

Sends the describe command to the collaborative environment. The describe command is used to set descriptions on players and objects in the collaborative environment.

Overrides:

describe in class Commands

Parameters:

description - the description to set.

getHowSays

public java.lang.String getHowSays()

Deprecated.

Overrides:

getHowSays in class Commands

getHowPages

public java.lang.String getHowPages()

Deprecated.

Overrides:

getHowPages in class Commands

getHowWhispers

public java.lang.String getHowWhispers()

Deprecated.

Overrides:

getHowWhispers in class Commands