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

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

public class ZoneConfiguration
extends Object

Object class that holds the configuration of a single zone. A zone is a collection of rooms. Every room must exist in a zone. A room cannot exist in more than one zone. A zone is defined by a unique name and has no other properties. A zone is not created by itself. During the room creation, a zone is specified. If that zone does not exist, then it is created.

See Also:

GameConfiguration, RoomConfiguration

Constructor Summary

ZoneConfiguration()
Constructs a new instance of ZoneConfiguration.

Method Summary

void	addRoom(RoomConfiguration room) Adds a room to the zone.
List<RoomConfiguration>	getRooms() Gets a list of the configurations of all the rooms in this zone.
String	getZoneName() Gets the unique name of the zone.
void	setZoneName(String zoneName) Sets the name of the zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoneConfiguration

public ZoneConfiguration()

Constructs a new instance of ZoneConfiguration.

Method Detail

getZoneName

public String getZoneName()

Gets the unique name of the zone.

Returns:

zoneName

setZoneName

public void setZoneName(String zoneName)

Sets the name of the zone.

Parameters:

zoneName - unique identifier for this zone

getRooms

public List<RoomConfiguration> getRooms()

Gets a list of the configurations of all the rooms in this zone.

Returns:

list of rooms in the zone

addRoom

public void addRoom(RoomConfiguration room)

Adds a room to the zone.

Parameters:

room - RoomConfiguration for the room