Merge lp:virqua into lp:virqua/preview

[Daniel Phillips]

Updated preview due to changes in how the environment will interact with the fish.

update() is the only method in a fish class that should move the rect or change the fish's direction.

The other methods are just to provide info to the environment or obtain updated information from the environment. The new info is used the next time update() runs. See decofish.py for an almost-complete fish.

Also, everything has moved into the same directory level so ignore the mention of fish/ in readme.txt.

[Daniel Phillips (daniel-phillips)]

Approved since people need to know how to write fish the right way.

Using anything other then update() to tell the fish to move would make the environment code a lot more work.

Basically, I can shove all the fish in pygame sprite-groups then call update() on the sprite-group which will automatically call update() on each of the fish.

Also, I can call draw() on the sprite-group to easily repaint all the fish.

review: Approve

=== modified file 'config.py'
--- config.py	2011-09-28 17:17:19 +0000
+++ config.py	2011-09-29 20:37:48 +0000
@@ -1,6 +1,6 @@
 # Virtual Aquarium
 # Settings
-# Build 0002
+# MIT License FTW
 
 WINDOW_WIDTH = 800
 WINDOW_HEIGHT = 600

=== modified file 'constants.py'
--- constants.py	2011-09-28 17:17:19 +0000
+++ constants.py	2011-09-29 20:37:48 +0000
@@ -1,10 +1,26 @@
 # Virtual Aquarium
 # Written by Daniel Phillips
+# MIT License FTW
 #
 # Constants
-# Build 0002
 #
 # DO NOT CHANGE THIS FILE
 # Changes here will prevent your fish from working on the display computer
 
+# vertical direction
+VERTICAL_UP = 1
+VERTICAL_SAME = 0
+VERTICAL_DOWN = -1
+
+# horizontal direction
+HORIZ_RIGHT = 1
+HORIZ_SAME = 0
+HORIZ_LEFT = -1
+
+# wall identifiers (think clock positions
+WALL_RIGHT = 3
+WALL_BOTTOM = 6
+WALL_LEFT = 9
+WALL_TOP = 12
+
 # colours
\ No newline at end of file

=== added file 'decofish.py'
--- decofish.py	1970-01-01 00:00:00 +0000
+++ decofish.py	2011-09-29 20:37:48 +0000
@@ -0,0 +1,62 @@
+# Virtual Aquarium
+# Written by Daniel Phillips
+# MIT License FTW
+#
+# The standard decoration fish
+#
+# Use this as a starting point for writing decoration fish
+#
+# Must have all the methods listed here
+# Methods not here will be ignored by environment code
+#
+# The sprite must be loaded into self.image
+# The bounding must be stored in self.rect
+# Use of other names for the sprite and rect 
+# will cause pygame to throw exceptions.
+
+import constants
+import functions
+
+# local constants
+SPRITE_PATH = "decofish.gif"
+
+class deco_fish:
+   # Constructor
+   def __init__(self, point, v_dir, h_dir):
+      self.image, self.rect = functions.load_image(SPRITE_PATH)
+      self.rect.topleft = point
+      self.vertical_direction = v_dir
+      self.horizontal_direction = h_dir
+      self.food_target = None
+      self.health = 3
+      
+   # Check for starvation
+   def is_dead(self):
+      return self.health == 0
+   
+   # Lose health from hunger
+   def notify_day_elapsed(self):
+      self.health -= 1
+   
+   # Tell fish food's been dropped in the tank
+   def notify_food_drop(self, direction):
+      self.food_target = direction
+   
+   # Tell fish it collided with food
+   def notify_food_eaten(self):
+      self.food_target = None
+      if self.health < 3:
+         self.health += 1
+   
+   # Tell the fish it hit the wall
+   def notify_wall_collide(self, edge_id):
+      if edge_id in (constants.WALL_TOP, constants.WALL_BOTTOM):
+         self.vertical_direction = -self.vertical_direction
+      elif edge_id in (constants.WALL_RIGHT, constants.WALL_LEFT):
+         self.horizontal_direction = -self.horizontal_direction
+
+   # Determine the new position of the fish and move the rect
+   def update(self, *args):
+      pass
+      
+      
\ No newline at end of file

=== added file 'exfighter.py'
--- exfighter.py	1970-01-01 00:00:00 +0000
+++ exfighter.py	2011-09-29 20:37:48 +0000
@@ -0,0 +1,9 @@
+# Virtual Aquarium
+# Written by Daniel Phillips
+# MIT License FTW
+#
+# Example of a basic fighter
+
+import functions
+
+# TODO

=== added file 'exhunter.py'
--- exhunter.py	1970-01-01 00:00:00 +0000
+++ exhunter.py	2011-09-29 20:37:48 +0000
@@ -0,0 +1,9 @@
+# Virtual Aquarium
+# Written by Daniel Phillips
+# MIT License FTW
+#
+# Example of a basic hunter
+
+import functions
+
+# TODO
\ No newline at end of file

=== added file 'exprey.py'
--- exprey.py	1970-01-01 00:00:00 +0000
+++ exprey.py	2011-09-29 20:37:48 +0000
@@ -0,0 +1,9 @@
+# Virtual Aquarium
+# Written by Daniel Phillips
+# MIT License FTW
+#
+# Example of a basic prey fish
+
+import functions
+
+# TODO
\ No newline at end of file

=== removed directory 'fish'
=== added file 'fish.py'
--- fish.py	1970-01-01 00:00:00 +0000
+++ fish.py	2011-09-29 20:37:48 +0000
@@ -0,0 +1,14 @@
+# Virtual Aquarium
+# Written by Daniel Phillips
+# MIT License FTW
+#
+# Fish module - provide access to fish
+
+# import fish modules
+import decofish
+
+# add classes to lists for use by main.py
+deco_fish = [decofish.deco_fish]
+prey_fish = []
+hunters = []
+fighters = []
\ No newline at end of file

=== removed file 'fish/__init__.py'
--- fish/__init__.py	2011-09-28 17:17:19 +0000
+++ fish/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,14 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# Fish module - provide access to fish
-# Build 0002
-
-# import fish modules
-import decofish
-
-# add classes to lists for use by main.py
-deco_fish = [decofish.deco_fish]
-prey_fish = []
-hunters = []
-fighters = []
\ No newline at end of file

=== removed file 'fish/cloak.py'
--- fish/cloak.py	2011-09-28 17:17:19 +0000
+++ fish/cloak.py	1970-01-01 00:00:00 +0000
@@ -1,10 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# A trolling fighter that looks like a decofish
-# while it waits for a foe to appear
-# Build 0002
-
-import functions
-
-# TODO
\ No newline at end of file

=== removed file 'fish/decofish.py'
--- fish/decofish.py	2011-09-28 17:17:19 +0000
+++ fish/decofish.py	1970-01-01 00:00:00 +0000
@@ -1,51 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# The standard decoration fish
-# Build 0002
-
-import functions
-
-class deco_fish:
-   def __init__(point):
-      self.position = point
-      self.current_direction = 0.0
-      self.next_direction = 0.0
-      self.food_target = None
-      self.health = 3
-   
-   def get_position():
-      return self.position
-   
-   # return a pair, change in X and change in Y   
-   def get_current_direction():
-      return self.current_direction
-   
-   # return a pair, change in X and change in Y
-   def get_next_direction():
-      return self.next_direction
-   
-   # takes a pair, change in X and change in Y   
-   def set_current_direction(dir):
-      self.current_direction = dir   
-      
-   def set_position(point):
-      self.position = point
-   
-   def move():
-      if self.food_target:
-         pass
-      else:
-         pass
-   
-   def notify_day_elapsed():
-      health -= 1
-   
-   def notify_food_drop(point):
-      self.food_target = point
-   
-   def notify_food_eaten():
-      self.food_target = None
-      if self.health < 3:
-         self.health += 1
-

=== removed file 'fish/exfighter.py'
--- fish/exfighter.py	2011-09-28 17:17:19 +0000
+++ fish/exfighter.py	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# Example of a basic fighter
-# Build 0002
-
-import functions
-
-# TODO

=== removed file 'fish/exhunter.py'
--- fish/exhunter.py	2011-09-28 17:17:19 +0000
+++ fish/exhunter.py	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# Example of a basic hunter
-# Build 0002
-
-import functions
-
-# TODO
\ No newline at end of file

=== removed file 'fish/exprey.py'
--- fish/exprey.py	2011-09-28 17:17:19 +0000
+++ fish/exprey.py	1970-01-01 00:00:00 +0000
@@ -1,9 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# Example of a basic prey fish
-# Build 0002
-
-import functions
-
-# TODO
\ No newline at end of file

=== removed file 'fish/functions.py'
--- fish/functions.py	2011-09-28 17:17:19 +0000
+++ fish/functions.py	1970-01-01 00:00:00 +0000
@@ -1,32 +0,0 @@
-# Virtual Aquarium
-# Written by Daniel Phillips
-#
-# Utility functions
-# Build 0002
-#
-# These functions, and only these functions,
-# will be available on the display computer
-
-# python/pygame imports
-import os
-import pygame
-import sys
-from pygame.locals import *
-
-# local imports
-import constants
-import config
-
-# Read image from file
-def load_image(name, colorkey=None):
-  try:
-    image = pygame.image.load(name)
-  except pygame.error, message:
-    print "Cannot load image: ", name
-    raise SystemExit, message
-  image = image.convert()
-  if colorkey is not None:
-    if colorkey is -1:
-      colorkey = image.get_at((0,0))
-    image.set_colorkey(colorkey, RLEACCEL)
-  return image, image.get_rect()

=== modified file 'functions.py'
--- functions.py	2011-09-28 17:17:19 +0000
+++ functions.py	2011-09-29 20:37:48 +0000
@@ -1,8 +1,8 @@
 # Virtual Aquarium
 # Written by Daniel Phillips
+# MIT License FTW
 #
 # Utility functions
-# Build 0002
 #
 # These functions, and only these functions,
 # will be available on the display computer

=== modified file 'main.py'
--- main.py	2011-09-28 17:17:19 +0000
+++ main.py	2011-09-29 20:37:48 +0000
@@ -1,8 +1,10 @@
+#!/usr/bin/env python
+#
 # Virtual Aquarium
 # Written by Daniel Phillips
+# MIT License FTW
 #
 # Entry point - setup and event loop
-# Build 0002
 #
 # DO NOT CHANGE THIS FILE
 # Changes here will prevent your fish from working on the display computer
@@ -48,7 +50,7 @@
 
 # load fish
 
-# process events
+# input event handler
 def input(events):
   for event in events:
     if event.type == pygame.QUIT:
@@ -61,10 +63,21 @@
 
 # event loop
 while True:
-  # handle input
+  # handle input events
   input(pygame.event.get())
 
-  # update fish
+  # process collisions
+  
+  # update time
+  
+  # remove dead fish
+  
+  # drop food if enough time has passed
+  
+  # geometry
+  
+  # move fish
+  # -just call update() on the groups which calls update() on the fish
 
   # update display
   pygame.display.flip()