/*
 Tiamat - a role-playing game framework
 LocationExit.java - represents an exit from a location
 
 Copyright  (C) 2006 Hugues Johnson
 
 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 com.huguesjohnson.tiamat;

/**  LocationExit - represents an exit from a location
 * @author Hugues Johnson
 */
public class LocationExit{
/* begin public properties */
    //the direction of this exit
    private String direction;
    /** Returns the direction of this exit.
     * @return The direction of this exit.
     */
    public String getDirection(){
        return(this.direction);
    }
    /** Sets the direction of this exit.
     * @param direction The direction of this exit.
     */
    public void setDirection(String direction){
        this.direction=new String(direction);
    }
    //the name of the Area where this exit leads
    private String name;
    /** Returns the name of the Area where this exit leads.
     * @return The name of the Area where this exit leads.
     */
    public String getName(){
        return(this.name);
    }
    /** Sets the name of the Area where this exit leads.
     * @param name The name of the Area where this exit leads.
     */
    public void setName(String name){
        this.name=new String(name);
    }
/* end public properties */
    
/* begin constructors */    
    /** Creates a new LocationExit.
     * @param direction The direction of this exit.
     * @param name The name of the Area where this exit leads.
     */
    public LocationExit(String direction,String name){
        this.setDirection(direction);
        this.setName(name);
    }
/* end constructors */    
}