|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectit.gotoandplay.smartfoxserver.data.Room
public class Room
Room Class
Field Summary | |
---|---|
java.util.HashMap |
properties
|
Constructor Summary | |
---|---|
Room(java.lang.String name,
int maxUsers,
boolean isTemp,
boolean isGame,
boolean isPrivate,
java.lang.String password,
java.lang.String zone)
Full Constructor |
|
Room(java.lang.String name,
int maxUsers,
boolean isTemp,
java.lang.String zone)
Basic Constructor |
Method Summary | |
---|---|
boolean |
contains(java.lang.String name)
Check if the room contains a certain user |
boolean |
deleteVariable(java.lang.String vName,
User owner)
|
void |
destroyExtensions()
Destroy all extensions for this room |
User[] |
getAllUsers()
Get all the users in the Room |
java.util.LinkedList |
getChannellList()
Get a list of the SocketChannels in this room |
java.nio.channels.SocketChannel |
getCreator()
|
it.gotoandplay.smartfoxserver.extensions.ExtensionManager |
getExtManager()
|
int |
getId()
Get room id |
int |
getMaxSpectator()
|
int |
getMaxUsers()
Get the max number of users allowed |
java.lang.String |
getName()
getName() |
java.lang.String |
getPassword()
Get the optional room password |
int |
getSpectatorCount()
|
boolean |
getUcountUpdates()
Get the status of the "uCount" server updates |
int |
getUserCount()
|
java.lang.Object[] |
getUserList()
Return an array of users |
RoomVariable |
getVariable(java.lang.String varName)
Get a room variable |
java.util.LinkedList |
getVariableNames()
|
java.util.HashMap |
getVariables()
Get a map of variables |
java.lang.String |
getXmlUserList()
Get xml formatted userList XML format is: |
java.lang.String |
getXmlVariable(java.lang.String varName)
|
java.lang.String |
getXmlVarList()
|
java.lang.String |
getZone()
Get the parent zone |
int |
howManyUsers()
|
boolean |
isGame()
|
boolean |
isLimbo()
|
boolean |
isPrivate()
|
boolean |
isTemp()
|
void |
join(User u,
java.lang.String pwd,
boolean isSpectator)
|
boolean |
removeUser(User u,
boolean updateUserRoomList,
boolean destroyVars)
|
static void |
resetRoomStaticData()
Reset the autoId when the server is restarted |
void |
setCreator(java.nio.channels.SocketChannel ch)
|
void |
setGame()
Set as a game room |
void |
setLimbo(boolean isLimbo)
|
void |
setMaxSpectators(int s)
Set the max number of spectators |
void |
setName(java.lang.String name)
setName() |
void |
setPassword(java.lang.String pw)
Set the room password |
void |
setUcountUpdates(boolean b)
Turn on/off the "uCount" server updates |
boolean |
setVariable(java.lang.String vn,
java.lang.String vt,
java.lang.String vv,
boolean pr,
boolean ps,
User owner,
boolean setOwnership)
Set a Room Variable |
int |
switchSpectator(User u)
Switch a user from spectator to player (available only in game rooms with spectators) |
void |
updateUserCount()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public java.util.HashMap properties
Constructor Detail |
---|
public Room(java.lang.String name, int maxUsers, boolean isTemp, java.lang.String zone)
name
- = room namemaxUsers
- = max number of users allowedisTemp
- = marks the room as temporary if = truepublic Room(java.lang.String name, int maxUsers, boolean isTemp, boolean isGame, boolean isPrivate, java.lang.String password, java.lang.String zone)
name
- the room namemaxUsers
- max number of users allowed in the roomisTemp
- temp roomisGame
- game roomisPrivate
- private roompassword
- an optional passwordzone
- the zone nameMethod Detail |
---|
public void destroyExtensions()
public int switchSpectator(User u)
u
- the User
public void setMaxSpectators(int s)
s
- public int getMaxSpectator()
public void setUcountUpdates(boolean b)
b
- public boolean getUcountUpdates()
public it.gotoandplay.smartfoxserver.extensions.ExtensionManager getExtManager()
public void join(User u, java.lang.String pwd, boolean isSpectator) throws it.gotoandplay.smartfoxserver.exceptions.JoinRoomException
it.gotoandplay.smartfoxserver.exceptions.JoinRoomException
public java.lang.String getXmlUserList()
public java.lang.Object[] getUserList()
public User[] getAllUsers()
public java.lang.String getXmlVarList()
public java.lang.String getXmlVariable(java.lang.String varName)
public java.util.LinkedList getVariableNames()
public java.util.HashMap getVariables()
public RoomVariable getVariable(java.lang.String varName)
varName
- the name of the variable
public int getId()
public java.lang.String getZone()
public java.lang.String getPassword()
public java.util.LinkedList getChannellList()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name of the roompublic boolean isPrivate()
public boolean isTemp()
public boolean isGame()
public void setGame()
public void setPassword(java.lang.String pw)
pw
- the passwordpublic int getMaxUsers()
public int getUserCount()
public int getSpectatorCount()
public boolean removeUser(User u, boolean updateUserRoomList, boolean destroyVars)
public boolean setVariable(java.lang.String vn, java.lang.String vt, java.lang.String vv, boolean pr, boolean ps, User owner, boolean setOwnership)
vn
- var namevt
- var typevv
- var valuepr
- persistent flagps
- private flagowner
- the owner UsersetOwnership
- change the ownership flag
public boolean deleteVariable(java.lang.String vName, User owner)
public void updateUserCount()
public int howManyUsers()
public void setCreator(java.nio.channels.SocketChannel ch)
public java.nio.channels.SocketChannel getCreator()
public boolean contains(java.lang.String name)
name
- the user name
public static void resetRoomStaticData()
public boolean isLimbo()
public void setLimbo(boolean isLimbo)
isLimbo
- The isLimbo to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |