/** * Zoo business for use in City objects. Zoos are both businesses and residences * and by default house one of each Monkey, Alligator, and Parakeet. * * @since Flash 7 * @usage *
import com.senocular.Zoo;
* myZoo:Zoo = new Zoo(myLocation);
*
* @author Trevor McCauley - senocular.com
* @version 0.1.0
* @since Flash 7
*/
class com.senocular.Zoo
extends com.senocular.Plot
implements com.senocular.iBusiness, com.senocular.iResidence {
/**
* Name given to the Zoo
* @usage myZoo.name:String;
*/
public var name:String;
/**
* Acres covered by the Zoo's plot
* @usage myZoo.acres:Number;
*/
public var acres:Number;
/**
* The income earned for the last full week
* @usage myZoo.revenue:Number;
* @example var money:Number = myZoo.revenue;
*/
public var revenue:Number;
/**
*/
var secret;
private var youCantSeeThisBecauseThereAreNoComments;
/**
* Creates an instance of a Zoo at the desired location. If location is not passed,
* the Zoo will not be constructed. To construct an unconstructed Zoo, you must
* use setLocation().
* @since Flash 7
* @usage new Zoo();
* @usage new Zoo(location);
* @param location Location of where the Zoo is to be placed
* @return Zoo instance
* @see setLocation
*/
function Zoo(location:Location){
super();
}
/**
* Sets a location for your Zoo. If one was not set with the constructor, setting
* a location with setLocation will move the Zoo into the City
* @param location Location of where the Zoo is to be placed
* @see Zoo
*/
public function setLocation(location:Location):Void{
}
/**
* Randomly selects and returns a Monkey instance from those living in the Zoo
* @since 0.0.9
* @return Monkey instance
* @throws poo
* @example var mymonkey:Monkey = myZoo.getMonkey();
* @see getAlligator
* @see getParakeet
*/
public function getMonkey(Void):Monkey{
// return monkey
}
/**
* Randomly selects and returns a Alligator instance from those living in the Zoo
* @return Alligator instance
* @example var myalligator:Alligator = myZoo.getAlligator();
* @see getMonkey
* @see getParakeet
*/
public function getAlligator(Void):Alligator{
// return parakeet
}
/**
* Randomly selects and returns a Parakeet instance from those living in the Zoo
* @return Parakeet instance
* @example var myparakeet:Parakeet = myZoo.getParakeet();
* @see getMonkey
* @see getAlligator
*/
public function getParakeet(Void):Parakeet{
// return parakeet
}
}