com.electrotank.electroserver4.extensions.api.value
Class RoomValue

java.lang.Object
  com.electrotank.electroserver4.extensions.api.value.RoomValue

public class RoomValue
extends Object

Object to store information about a particular room. A room is a collection of users. Rooms are most commonly used for chatting and playing games, but can be used in any situation where multiple users need to interact.

See Also:

ElectroServer 4 Manual, Rooms, ElectroServerApi.getRoomsInZone, ElectroServerApi.getRoomsInZoneByName

Constructor Summary

RoomValue()

Method Summary

int	getCapacity() Gets the capacity of the room.
String	getDescription() Gets the optional text description of a room.
int	getRoomId() Gets the roomId of the room.
String	getRoomName() Gets the name of the room.
int	getZoneId() Gets the zoneId of the zone in which to this room resides.
boolean	isPersistent() Is this room persistent? Persistent rooms are created using the web-based administrator and always exist.
void	setCapacity(int capacity) Sets the capacity of the room.
void	setDescription(String description) Sets the optional text description of the room.
void	setPersistent(boolean persistent) Sets the room to be persistent or not.
void	setRoomId(int roomId) Sets the roomId of the room.
void	setRoomName(String roomName) Sets the name of the room.
void	setZoneId(int zoneId) Sets the zoneId of the zone in which this room resides.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomValue

public RoomValue()

Method Detail

getCapacity

public int getCapacity()

Gets the capacity of the room. The capacity is the total number of users allowed to join the room. If set to -1 then there is no limit.

Returns:

capacity

setCapacity

public void setCapacity(int capacity)

Sets the capacity of the room.

Parameters:

capacity - total number of users allowed; -1 for no limit

getDescription

public String getDescription()

Gets the optional text description of a room. This description is viewable by any user in the same zone.

Returns:

description

setDescription

public void setDescription(String description)

Sets the optional text description of the room.

Parameters:

description - optional text description of the room

isPersistent

public boolean isPersistent()

Is this room persistent? Persistent rooms are created using the web-based administrator and always exist. Rooms that are not persisten are dynamic, and are automatically removed when there are no more users in them.

Returns:

true if the room is persistent

setPersistent

public void setPersistent(boolean persistent)

Sets the room to be persistent or not.

Parameters:

persistent - true if the room will be persistent

See Also:

isPersistent

getRoomId

public int getRoomId()

Gets the roomId of the room.

Returns:

roomId

setRoomId

public void setRoomId(int roomId)

Sets the roomId of the room.

Parameters:

roomId - roomId

getRoomName

public String getRoomName()

Gets the name of the room. The roomName is a unique name that can be referenced by users or the server to identify the room.

Returns:

roomName

setRoomName

public void setRoomName(String roomName)

Sets the name of the room. The roomName is a unique name that can be referenced by users or the server to identify the room.

Parameters:

roomName - name of the room

getZoneId

public int getZoneId()

Gets the zoneId of the zone in which to this room resides.

Returns:

zoneId

setZoneId

public void setZoneId(int zoneId)

Sets the zoneId of the zone in which this room resides.

Parameters:

zoneId - zoneId of this room