[ogs-changes] dist/java/ogs/core/details Maturity.java,NONE,1.1

[<ele...@us...>]

Update of /cvsroot/ogs/dist/java/ogs/core/details
In directory sc8-pr-cvs1:/tmp/cvs-serv9450/java/ogs/core/details

Added Files:
	Maturity.java 
Log Message:
See ChangeLog files (Apr 3-4) for details.


--- NEW FILE: Maturity.java ---
/*
 * Maturity.java -- interface declaration for maturity ranges
 * Copyright (C) 2003  Eric Lemings <ele...@us...>
 *
 * This software 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 software 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 software; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA
 *
 * RCS: $Id: Maturity.java,v 1.1 2003/04/04 20:22:53 elemings Exp $
 */

package ogs.core.details;

import ogs.core.Die;
import ogs.core.Detail;

/**
 * The various stages of life for a creature.  The <code>Maturity</code>
 * class is an interface that determines the longevity or lifespan of a
 * creature.  This class is implemented by <code>Creature</code> classes
 * such as <code>Human</code> that can be used as a player character
 * (PC) race.  It provides players and referees with average age ranges
 * such as adult, starting, middle, old, venerable, and maximum.  Each
 * of these stages have effects that are applied once a creature reaches
 * that age.  The pure virtual member functions should behave the same
 * for all instances of a <code>Creature</code> class (i.e., as static
 * member functions).  All ages are expressed in years by default.
 */
public interface Maturity {
  /**
   * Determine the average adult age for this type of creature.  The
   * adult age is the base value for determining the starting age of
   * a PC.
   *
   * @return Average adult age of a creature.
   */
  public int getAdultAge ();

  /**
   * Determine the average middle age for this type of creature.  At
   * middle age, a character recieves a -1 modifier to physical
   * abilities (Strength, Constitution, and Dexterity) and a +1
   * modifier to mental abilities (Intelligence, Wisdom, and
   * Charisma).
   *
   * @return Average middle age of a creature.
   */
  public int getMiddleAge ();

  /**
   * Determine the average old age for this type of creature.  At old
   * age, a character recieves a -2 modifier to physical abilities and
   * a +1 modifier to mental abilities.
   *
   * @return Average old age of a creature.
   */
  public int getOldAge ();

  /**
   * Determine the average venerable age for this type of creature.
   * At venerable age, a character recieves a -3 modifier to physical
   * abilities and a +1 modifier to mental abilities.  The venerable
   * age is also used as the base value for determining maximum age.
   *
   * @return Average venerable age of a creature.
   */
  public int getVenerableAge ();

  /**
   * Access the die used to roll a random maximum age for a PC.  The
   * modifier of this die is the same as the venerage age.  A PC dies of
   * natural causes when he or she reaches this maximum age.
   *
   * @return Die used to roll random maximum ages.
   */
  public Die getMaximumAge ();
}