com.tootsville.env
Class ShadeHook

java.lang.Object
  com.tootsville.env.ShadeHook

All Implemented Interfaces:

RoomListener

public class ShadeHook
extends Object
implements RoomListener

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Constructor Summary

ShadeHook()

Method Summary

void	acceptGameAction(AbstractUser u, org.json.JSONObject jso) Broadcast message of a game action taking place
void	acceptGameStateChange(GameEvent gameCode, GameStateFlag gameState) Notification of a GameEvent changing state for the room
void	acceptObjectJoinRoom(Room room, RoomListener object) Notification that someone has entered the room.
void	acceptObjectPartRoom(Room room, RoomListener thing) Notification that someone has left a room
void	acceptOutOfBandMessage(AbstractUser sender, Room room, org.json.JSONObject body) Accept an out-of-band communications packet that was broadcast to a room in which this Listener is listening.
void	acceptPublicMessage(AbstractUser sender, Room room, String message) Accept a public chat message or /emote.
void	acceptPublicMessage(AbstractUser from, String message) Accept a public chat message.
void	acceptUserAction(Room r, AbstractUser u) User actions (go/do actions) propagate through this channel.
void	acceptUserVariableUpdate(AbstractUser user, String varName, String varValue) Receive notification of the change of an user variable
Room	getRoom() WRITEME: document this method (brpocock@star-hope.org, Oct 31, 2009)
Zone	getZone() WRITEME: document this method (brpocock@star-hope.org, Oct 31, 2009)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadeHook

public ShadeHook()

Method Detail

acceptGameAction

public void acceptGameAction(AbstractUser u,
                             org.json.JSONObject jso)

Description copied from interface: RoomListener

Broadcast message of a game action taking place

Specified by:

acceptGameAction in interface RoomListener

Parameters:

u - the sender

jso - The game action. The verb is in action.getString("action").

See Also:

RoomListener.acceptGameAction(org.starhope.appius.user.AbstractUser, org.json.JSONObject)

acceptGameStateChange

public void acceptGameStateChange(GameEvent gameCode,
                                  GameStateFlag gameState)

Description copied from interface: RoomListener

Notification of a GameEvent changing state for the room

Specified by:

acceptGameStateChange in interface RoomListener

Parameters:

gameCode - The GameEvent whose state is changing

gameState - The new state

See Also:

RoomListener.acceptGameStateChange(org.starhope.appius.game.GameEvent, org.starhope.appius.game.GameStateFlag)

acceptObjectJoinRoom

public void acceptObjectJoinRoom(Room room,
                                 RoomListener object)

Description copied from interface: RoomListener

Notification that someone has entered the room.

Specified by:

acceptObjectJoinRoom in interface RoomListener

Parameters:

room - The room

object - The thing (probably user) entering

See Also:

RoomListener.acceptObjectJoinRoom(org.starhope.appius.game.Room, org.starhope.appius.game.RoomListener)

acceptObjectPartRoom

public void acceptObjectPartRoom(Room room,
                                 RoomListener thing)

Description copied from interface: RoomListener

Notification that someone has left a room

Specified by:

acceptObjectPartRoom in interface RoomListener

Parameters:

room - The room

thing - The thing (probably user) departing

See Also:

RoomListener.acceptObjectPartRoom(org.starhope.appius.game.Room, org.starhope.appius.game.RoomListener)

acceptOutOfBandMessage

public void acceptOutOfBandMessage(AbstractUser sender,
                                   Room room,
                                   org.json.JSONObject body)

Description copied from interface: RoomListener

Accept an out-of-band communications packet that was broadcast to a room in which this Listener is listening.

Specified by:

acceptOutOfBandMessage in interface RoomListener

Parameters:

sender - The sender of the OOB message

room - The room in which the OOB message is being broadcast

body - A JSON object containing the OOB message. The contents of this message are not constrained.

See Also:

RoomListener.acceptOutOfBandMessage(org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room, org.json.JSONObject)

acceptPublicMessage

public void acceptPublicMessage(AbstractUser sender,
                                Room room,
                                String message)

Description copied from interface: RoomListener

Accept a public chat message or /emote.

Specified by:

acceptPublicMessage in interface RoomListener

Parameters:

sender - The speaker

room - The room in which the words were spoken

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(org.starhope.appius.user.AbstractUser, org.starhope.appius.game.Room, java.lang.String)

acceptPublicMessage

public void acceptPublicMessage(AbstractUser from,
                                String message)

Description copied from interface: RoomListener

Accept a public chat message. This prototype does not specify the room, on the (potentially invalid) assumption that the room listener doesn't care from which room the speech was made.

Specified by:

acceptPublicMessage in interface RoomListener

Parameters:

from - The speaker

message - The spoken text or /emote

See Also:

RoomListener.acceptPublicMessage(org.starhope.appius.user.AbstractUser, java.lang.String)

acceptUserAction

public void acceptUserAction(Room r,
                             AbstractUser u)

Description copied from interface: RoomListener

User actions (go/do actions) propagate through this channel.

Specified by:

acceptUserAction in interface RoomListener

Parameters:

r - the room in which the user is taking an action

u - the user taking an action

See Also:

RoomListener.acceptUserAction(org.starhope.appius.game.Room, org.starhope.appius.user.AbstractUser)

acceptUserVariableUpdate

public void acceptUserVariableUpdate(AbstractUser user,
                                     String varName,
                                     String varValue)

Description copied from interface: RoomListener

Receive notification of the change of an user variable

Specified by:

acceptUserVariableUpdate in interface RoomListener

Parameters:

user - The user updating their variable

varName - The name of the variable (key)

varValue - The new value (null if unset)

See Also:

RoomListener.acceptUserVariableUpdate(org.starhope.appius.user.AbstractUser, java.lang.String, java.lang.String)

getRoom

public Room getRoom()

Description copied from interface: RoomListener

WRITEME: document this method (brpocock@star-hope.org, Oct 31, 2009)

Specified by:

getRoom in interface RoomListener

Returns:

the Room in which this NPC can be found. This can be null.

See Also:

RoomListener.getRoom()

getZone

public Zone getZone()

Description copied from interface: RoomListener

WRITEME: document this method (brpocock@star-hope.org, Oct 31, 2009)

Specified by:

getZone in interface RoomListener

Returns:

the Zone in which this listener can be found

See Also:

RoomListener.getZone()