jurpe.dungeon.furnishing
Class Door

java.lang.Object
  extended by jurpe.dungeon.furnishing.Door
All Implemented Interfaces:
java.io.Serializable

public class Door
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Constructor Summary
Door()
          Constructor for a door.
 
Method Summary
 boolean close()
          Closes a door
 OpenClose getStatus()
          Status (opened/closed/locked) of the door
 boolean isOpen()
           
 boolean lock()
          Locks a door
 boolean open()
          Opens a door.
 void setStatus(OpenClose sStatus)
          Set the door open or closed
 java.lang.String toString()
          Return a representation of the door: - DC door closed - DO door opened - DL door locked
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Door

public Door()
Constructor for a door. By default the door is closed.

Method Detail

open

public boolean open()
Opens a door. If it is locked, it must be unclocked first

Returns:
true if the door was successfully opened

close

public boolean close()
Closes a door

Returns:

lock

public boolean lock()
Locks a door

Returns:
True if the door has been succesfully locked

isOpen

public boolean isOpen()
Returns:
boolean

getStatus

public OpenClose getStatus()
Status (opened/closed/locked) of the door

Returns:
Status of the door

setStatus

public void setStatus(OpenClose sStatus)
Set the door open or closed

Parameters:
status - Door status

toString

public java.lang.String toString()
Return a representation of the door: - DC door closed - DO door opened - DL door locked

Overrides:
toString in class java.lang.Object
Returns:
a representation of the door

Jurpe - Java Universal Role Playing Engine - http://jurpe.sourceforge.net