Serialized Form

Package MapObjects
- Class MapObjects.Animal extends Interactable implements Serializable
  - Serialized Fields
    - curDir
```
Direction curDir
```
      Current Direction of the Animal
    - speed
```
int speed
```
      Speed of the Animal
    - health
```
int health
```
      Health of the Animal
- Class MapObjects.Interactable extends java.lang.Object implements Serializable
  - Serialized Fields
    - xLocation
```
int xLocation
```
      The x-location of the object
    - yLocation
```
int yLocation
```
      The y-location of the object
    - width
```
int width
```
      The width of the object
    - height
```
int height
```
      The height of the object
    - relativeCollisionBox
```
java.awt.Rectangle relativeCollisionBox
```
      The collision box used by the object. Definition is relative to the 0,0 position of the object.
- Class MapObjects.Litter extends Interactable implements Serializable
  - Serialized Fields
    - imgID
```
int imgID
```
      Number generated randomly that later maps to A SpriteID to paint it with.
    - lType
```
LitterType lType
```
      Enum from LitterType that represents the type of Litter this object is
- Class MapObjects.Plant extends Interactable implements Serializable
  - Serialized Fields
    - health
```
int health
```
    - randPlant
```
int randPlant
```
- Class MapObjects.Receptacle extends Interactable implements Serializable
  - Serialized Fields
    - rType
```
ReceptacleType rType
```
      The type of Receptacle this object is.
- Class MapObjects.River extends Interactable implements Serializable
Package MVC
- Class MVC.Model extends java.lang.Object implements Serializable
  - Serialized Fields
    - player
```
Player player
```
      The only controllable object in the game.
      
      See Also:
      
      Player
    - gamePhase
```
GamePhase gamePhase
```
      The current game phase
    - tutorialState
```
TutorialState tutorialState
```
      Current state of the tutorial
    - hasLitter
```
boolean hasLitter
```
      Whether the Player is carrying Litter.
    - spacePressed
```
boolean spacePressed
```
      Whether the space key is currently pressed down.
    - crabDirection
```
int crabDirection
```
      The current movement direction of the Model.crab.
    - plantDamage
```
int plantDamage
```
      The amount of health to detract from the Plant every time it is damaged
    - tBin
```
Receptacle tBin
```
      The trash bin
    - rBin
```
Receptacle rBin
```
      The recycle bin
    - trashVictory
```
boolean trashVictory
```
      Whether the trash bin recently received a piece of Litter
    - recycleVictory
```
boolean recycleVictory
```
      Whether the recycle bin recently received a piece of Litter
    - trashGlow
```
int trashGlow
```
      A count of the number of frames the trash bin has been in glowing victory state for
    - recycleGlow
```
int recycleGlow
```
      A count of the number of frames the recycle bin has been in glowing victory state for
    - crab
```
Animal crab
```
      The Crab, currently the only Animal in the game.
    - animals
```
java.util.HashSet<E> animals
```
      Every animal in the world. Currently only the crab.
    - litterSet
```
java.util.HashSet<E> litterSet
```
      HashSet of all of the current Litter objects in the game
    - litterAttrSet
```
java.util.HashSet<E> litterAttrSet
```
      HashSet where every element is an ArrayList containing the x and y coordinates of the Litter objects, as well as the imgID and LitterType to send to View
    - animalXIncr
```
int animalXIncr
```
      The horizontal speed of the Crab
    - animalYIncr
```
int animalYIncr
```
      The vertical speed of the Crab
    - hasLost
```
boolean hasLost
```
      Whether the player has lost
    - playerMove
```
boolean playerMove
```
      Whether the player is allowed to move this frame. Set to false under specific circumstances, i.e. when colliding with an Animal
    - pickedUp
```
Litter pickedUp
```
      The last Litter to be picked up by the Model.player
    - pickedUpAttr
```
java.util.ArrayList<E> pickedUpAttr
```
      ArrayList of Litter imgID and LitterType of Model.pickedUp Litter attribute to send to View
    - animalEatenLitter
```
Litter animalEatenLitter
```
      The last Litter to be picked up by an animal
    - plants
```
java.util.ArrayList<E> plants
```
      Contains plant objects
    - randPlant
```
int randPlant
```
      Random index of next plant
    - tutorialPlantGrown
```
boolean tutorialPlantGrown
```
      Boolean variable that represents whether the player has planted the plant that despawns in the tutorial
    - tutorialAnimalAteLitter
```
boolean tutorialAnimalAteLitter
```
      Boolean variable that represents whether the animal has eaten the Litter in the tutorial
    - tutorialArrowKeyPrompt
```
boolean tutorialArrowKeyPrompt
```
      Boolean that represents whether the arrow key prompt should be shown on screen.
    - tutorialHoverLitter
```
boolean tutorialHoverLitter
```
      Boolean that represents whether or not the Player is hovering, but not picking up a Litter object
    - river
```
River river
```
      onscreen river
    - startTime
```
long startTime
```
      The time in milliseconds that the game has begun
    - endTimeMilli
```
int endTimeMilli
```
      How many milliseconds the game should last
    - totalLitterCollected
```
int totalLitterCollected
```
      The number of Litter objects that the Player has picked up throughout the game
    - totalPlantsPlanted
```
int totalPlantsPlanted
```
      The number of Plants that the Player has replanted throughout the game
- Class MVC.View extends javax.swing.JPanel implements Serializable
  - Serialized Fields
    - frame
```
javax.swing.JFrame frame
```
      The JFrame housing this View.
    - pickedUpAttr
```
java.util.ArrayList<E> pickedUpAttr
```
      The image attributes of the Litter object most recently held by the Player
    - hasLitter
```
boolean hasLitter
```
      Whether the player is holding on to litter
    - litterAttrSet
```
java.util.HashSet<E> litterAttrSet
```
      Contains all Litter objects to be rendered onscreen, maps them to a Sprite.ID.
    - plants
```
java.util.ArrayList<E> plants
```
      Contains all plant objects onscreen
    - litterSet
```
java.util.HashSet<E> litterSet
```
      contains all of the Litter objects on-screen
    - tutorialState
```
TutorialState tutorialState
```
      Gamestate variable that represents the current stage of the tutorial the player is at
    - tGlow
```
boolean tGlow
```
      A Boolean to decide if the trash bin is in the glowing deposit state
    - rGlow
```
boolean rGlow
```
      A Boolean to decide if the recycling bin is in the glowing deposit state
    - playerHealth
```
int playerHealth
```
      The current health of the player
    - animalHealth
```
int animalHealth
```
      The current health of the animal
    - river
```
River river
```
      The river
    - startTime
```
long startTime
```
      A long representing when the game started in order to draw the truck timer in the correct spot
    - endTime
```
int endTime
```
      A long representing when the game should end in order to draw the truck timer in the correct spot
    - arrowKeyPrompt
```
boolean arrowKeyPrompt
```
      Boolean that determines whether the arrow key prompt should be shown on screen.
    - hoverLitter
```
boolean hoverLitter
```
      Boolean that represents whether or not the Player is hovering, but not picking up a Litter object
    - fontWorldToPt
```
java.util.Map<K,V> fontWorldToPt
```
      Stores font sizes calculated using binary search. Should be reset whenever View is resized.
    - gamePhase
```
GamePhase gamePhase
```
      The current phase of the game
    - endScreenTimestamp
```
long endScreenTimestamp
```
      The time that the phase GamePhase.GAME_END was entered. -1 when not in GAME_END.
    - totalLitterCollected
```
int totalLitterCollected
```
      The number of Litter objects that the Player has picked up throughout the game
    - totalPlantsPlanted
```
int totalPlantsPlanted
```
      The number of Plants that the Player has replanted throughout the game
    - hasLost
```
boolean hasLost
```
      Whether the player has lost or won the game. True if lost, false if won.
    - riverTexturePixels
```
int[] riverTexturePixels
```
      A array of every pixel in the image Sprite.ID.RIVER_TEXTURE, set the first time View.drawRiver(java.awt.Graphics2D, int) is run.
    - riverAlphaMapPixels
```
int[] riverAlphaMapPixels
```
      A array of every pixel in the image Sprite.ID.RIVER_ALPHA, set the first time View.drawRiver(java.awt.Graphics2D, int) os run.
Package Player
- Class Player.Player extends Interactable implements Serializable
  - Serialized Fields
    - dx
```
int dx
```
      Horizontal movement direction. -1 for moving left, 0 for horizontally stable (initial value), 1 for moving right.
    - dy
```
int dy
```
      Vertical movement direction. -1 for moving up, 0 for vertically stable (initial value), 1 for moving down.
    - SPEED
```
int SPEED
```
      Movement speed
    - direction
```
Direction direction
```
      Movement direction. Gets recalculated when Player.dx and Player.dy are changed to match their behaviour. Initial value is EAST.
    - status
```
PlayerStatus status
```
      Player status, i.e. IDLE or WALKING, etc. Gets recalculated when Player.dx and Player.dy are changed to match their behaviour. Initial value is IDLE.
    - health
```
int health
```
      Player's health

Serialized Form

Package MapObjects

Class MapObjects.Animal extends Interactable implements Serializable

Serialized Fields

curDir

speed

health

Class MapObjects.Interactable extends java.lang.Object implements Serializable

Serialized Fields

xLocation

yLocation

width

height

relativeCollisionBox

Class MapObjects.Litter extends Interactable implements Serializable

Serialized Fields

imgID

lType

Class MapObjects.Plant extends Interactable implements Serializable

Serialized Fields

health

randPlant

Class MapObjects.Receptacle extends Interactable implements Serializable

Serialized Fields

rType

Class MapObjects.River extends Interactable implements Serializable

Package MVC

Class MVC.Model extends java.lang.Object implements Serializable

Serialized Fields

player

gamePhase

tutorialState

hasLitter

spacePressed

crabDirection

plantDamage

tBin

rBin

trashVictory

recycleVictory

trashGlow

recycleGlow

crab

animals

litterSet

litterAttrSet

animalXIncr

animalYIncr

hasLost

playerMove

pickedUp

pickedUpAttr

animalEatenLitter

plants

randPlant

tutorialPlantGrown

tutorialAnimalAteLitter

tutorialArrowKeyPrompt

tutorialHoverLitter

river

startTime

endTimeMilli

totalLitterCollected

totalPlantsPlanted

Class MVC.View extends javax.swing.JPanel implements Serializable

Serialized Fields

frame

pickedUpAttr

hasLitter

litterAttrSet

plants

litterSet

tutorialState

tGlow

rGlow

playerHealth

animalHealth

river

startTime

endTime