Zoo Documentation

Author: Trevor McCauley - senocular.com
Last Modified: 4/05/08 3:16:02


Summary

Zoo class:

- description

Zoo Properties:

- name
- acres
- revenue
- secret

Zoo Methods:

- setLocation
- getMonkey
- getAlligator
- getParakeet


Zoo class

version: 0.1.0

description:

Zoo business for use in City objects. Zoos are both businesses and residences and by default house one of each Monkey, Alligator, and Parakeet.

usage:

new Zoo(location);

parameters:


Zoo Properties:

name

Name given to the Zoo

acres

Acres covered by the Zoo's plot

revenue

The income earned for the last full week

secret

No description provided


Zoo Methods:

setLocation

description: 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

usage: No usage provided

parameters:

returns: No return specified

getMonkey

description: Randomly selects and returns a Monkey instance from those living in the Zoo

usage: No usage provided

parameters:

returns: Monkey instance

getAlligator

description: Randomly selects and returns a Alligator instance from those living in the Zoo

usage: No usage provided

parameters:

returns: Alligator instance

getParakeet

description: Randomly selects and returns a Parakeet instance from those living in the Zoo

usage: No usage provided

parameters:

returns: Parakeet instance