key.java

Vyger offers a D & D and Rogue-like environment in a graphical online roleplay game.

/*
 * Light And Shadow. A Persistent Universe based on Robert Jordan's Wheel of Time Books.
 * Copyright (C) 2001 - WOTLAS Team
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
package wotlas.common.objects.usefuls;

import wotlas.common.objects.interfaces.*;

import wotlas.common.objects.valueds.ValuedObject;
import wotlas.common.Player;
import wotlas.common.objects.BaseObject;

/** 
 * The keys class.
 * 
 * @author Elann
 * @see wotlas.common.objects.usefuls.UsefulObject
 * @see wotlas.common.objects.interfaces.LockableInterface
 * @see wotlas.common.objects.interfaces.TransportableInterface 
 */

public class Key extends UsefulObject implements TransportableInterface 
{

 /*------------------------------------------------------------------------------------*/

 /** Key identifier.
  */
  	protected int iKeyID;
	
 /** Key string identifier.
  */
  	protected String sKeyID; 																						
	  
 /** Is it on ?
  */
  private boolean equipped;
	  
 /*------------------------------------------------------------------------------------*/
 
  /** The default constructor.
   */			
    public Key()
	{
	 super();
	 
	 this.className="Key";
	 this.objectName="default key";
	}															
	
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

  /** Use the object.<br>
   * For a key, needs a target.  
   */
    public void use()
	{
	 /* no op */
	}

  /** Ready the key for usage.
   */
    public void ready()
	{
	 /* no op */
	}

    public void equip()
	{	   
	 equipped=true;
	}
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
 
   /** Gets rid of the object. The object is dropped on the ground.
   */
    public void discard()
	{
	 /* no op */
	}

  /** Sells the object to somebody.
  	  @param buyer The Player who buy the object. 
  	  @return the prize paid.
   */
    public ValuedObject sellTo(Player buyer)
	{
	 /* no op */
	 return new ValuedObject();
	}

  /** Gives the object to somebody.
  	  @param receiver The Player who receive the object.
   */
    public void giveTo(Player receiver)
	{
	 /* no op */
	}
	
  /** Trade the object to somebody.<br>
    * Here the transaction is already accepted.
  	* @param buyer The Player who buy the object. 
  	* @return the object given by the other player.
    */
    public BaseObject tradeTo(Player buyer)
	{
	 /* no op */
	 return new BaseObject();
	}

 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
 
 
 /** Get the key integer identifier.
  * @return iKeyID
  */
  	public int getIKeyID()
	{
	 return iKeyID;
	}
	
 /** Set the key integer identifier.
  * @param iKeyID the new key identifier
  */
    public void setIKeyID(int iKeyID)
	{
	 this.iKeyID=iKeyID;
	} 
 
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

 /** Get the key string identifier.
  * @return sKeyID
  */
  	public String getSKeyID()
	{
	 return sKeyID;
	}
	
 /** Set the key string identifier.
  * @param sKeyID the new key identifier
  */
    public void setSKeyID(String sKeyID)
	{
	 this.sKeyID=sKeyID;
	} 
 
 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/

}