org.starhope.appius.game
Interface AbstractZone

All Known Implementing Classes:

RemoteZone, Zone

public interface AbstractZone

TODO: The documentation for this type (AbstractZone) is incomplete. (brpocock, Nov 5, 2009)

Author:

brpocock

Method Summary

void	activate() Adds the zone to the global zones index (via AppiusClaudiusCaecus.addZone), making it available for users to see.
void	add(Room room) Add a new room into the Zone, once it has been constructed.
void	destroy() This is an overriding method.
void	destroyRoom(Room room)
Collection<User>	getAllUsersInZone()
int	getMaxUsers()
String	getName()
Room	getRoom(Integer room)
Room	getRoomByName(String string)
Collection<Room>	getRoomList()
String	getRoomListSFSXML() Get the room list in the bizarre format for a Smart Fox Server XML room list stream
int	getRoomMaxUsers()
User	getUserByName(String buddy)
Room	getUserRoom(User user) TODO: document this method (brpocock, Oct 28, 2009)
org.json.JSONObject	getZoneData_JSON(User user) TODO: document this method (brpocock, Nov 16, 2009)
void	init() This is an overriding method.
void	remove(User user)
void	setAutoJoinRoom(int id)
String	spawnNewZone() Create a new zone if one is needed
void	trace(String string)

Method Detail

activate

void activate()

Adds the zone to the global zones index (via AppiusClaudiusCaecus.addZone), making it available for users to see.

add

void add(Room room)

Add a new room into the Zone, once it has been constructed. Places the room into the indices by ID and moniker.

Parameters:

room - The room to be added.

destroy

void destroy()

This is an overriding method.

destroyRoom

void destroyRoom(Room room)

Parameters:

room - WRITEME

getAllUsersInZone

Collection<User> getAllUsersInZone()

Returns:

A Collection of all users currently in the Zone

getMaxUsers

int getMaxUsers()

Returns:

WRITEME

getName

String getName()

Returns:

WRITEME

getRoom

Room getRoom(Integer room)

Parameters:

room - WRITEME

Returns:

WRITEME

getRoomByName

Room getRoomByName(String string)

Parameters:

string - WRITEME

Returns:

WRITEME

getRoomList

Collection<Room> getRoomList()

Returns:

WRITEME

getRoomListSFSXML

String getRoomListSFSXML()

Get the room list in the bizarre format for a Smart Fox Server XML room list stream

Returns:

a string of the SFS - XML format

getRoomMaxUsers

int getRoomMaxUsers()

Returns:

WRITEME

getUserByName

User getUserByName(String buddy)

Parameters:

buddy - WRITEME

Returns:

WRITEME

getUserRoom

Room getUserRoom(User user)

TODO: document this method (brpocock, Oct 28, 2009)

Parameters:

user - WRITEME

Returns:

where the user is according to me

getZoneData_JSON

org.json.JSONObject getZoneData_JSON(User user)
                                     throws org.json.JSONException

TODO: document this method (brpocock, Nov 16, 2009)

Parameters:

user - WRITEME

Returns:

WRITEME

Throws:

org.json.JSONException - if I can't do it right

init

void init()

This is an overriding method.

remove

void remove(User user)

Parameters:

user - WRITEME

setAutoJoinRoom

void setAutoJoinRoom(int id)

Parameters:

id - WRITEME

spawnNewZone

String spawnNewZone()

Create a new zone if one is needed

Returns:

WRITEME

trace

void trace(String string)

Parameters:

string - WRITEME