com.electrotank.electroserver.plugins.entities
Class RoomStub

java.lang.Object
  com.electrotank.electroserver.plugins.entities.RoomStub

public class RoomStub

extends Object

The RoomStub object is a read only representation of a Room. It is created internally by the server and returned from several extension helper method calls.

Constructor Summary

RoomStub(Room room)
Creates a new instance of RoomStub.

Method Summary

String	getName() Gets the name of the room represented by this stub
String	getPassowrd()
boolean	isHidden() Gets the hidden or visible status of this room.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomStub

public RoomStub(Room room)

Creates a new instance of RoomStub. This is an ElectroServer internal method.

Parameters:

room - the room this stub will be based on

Method Detail

getName

public String getName()

Gets the name of the room represented by this stub

Returns:

the name of the zone represented by this stub

isHidden

public boolean isHidden()

Gets the hidden or visible status of this room.

Returns:

true if this room is hidden, false otherwise

getPassowrd

public String getPassowrd()