From: Joe Wreschnig <joe.wreschnig@gmail.com>
Date: Wed, 17 Mar 2010 04:19:09 +0000 (-0700)
Subject: Docstrings.
X-Git-Url: https://git.yukkurigames.com/?a=commitdiff_plain;h=5733428dbb7033a5827013cd1f55894a99708bab;p=python-bulletml.git

Docstrings.
---

diff --git a/bulletml/impl.py b/bulletml/impl.py
index 92982db..65d234a 100644
--- a/bulletml/impl.py
+++ b/bulletml/impl.py
@@ -37,6 +37,7 @@ class Action(object):
         self.params = params
         self.rank = rank
         self.pc = -1
+        self.finished = False
         if parent:
             self.copy_state(parent)
 
@@ -44,16 +45,15 @@ class Action(object):
         return "%s(pc=%r, actions=%r)" % (
             type(self).__name__, self.pc, self.actions)
 
-    @property
-    def finished(self):
-        return self.pc is None
-
     def vanish(self):
+        """End this action and its parents."""
         if self.parent:
             self.parent.vanish()
         self.pc = None
+        self.finished = True
 
     def copy_state(self, other):
+        """Copy fire/movement state from other to self."""
         self.direction_frames = other.direction_frames
         self.direction = other.direction
         self.aiming = other.aiming
@@ -66,6 +66,7 @@ class Action(object):
         self.previous_fire_speed = other.previous_fire_speed
 
     def step(self):
+        """Advance by one frame."""
         created = []
 
         if self.speed_frames > 0:
@@ -99,6 +100,7 @@ class Action(object):
                 self.repeat -= 1
                 if self.repeat <= 0:
                     self.pc = None
+                    self.finished = True
                     if self.parent is not None:
                         self.parent.copy_state(self)
                         self.owner.replace(self, self.parent)
@@ -260,6 +262,7 @@ class Bullet(object):
 
     @property
     def finished(self):
+        """Check if this bullet is finished running."""
         for action in self.actions:
             if not action.finished:
                 return False
@@ -273,6 +276,7 @@ class Bullet(object):
         self.actions = []
 
     def replace(self, old, new):
+        """Replace an active action with another."""
         try:
             idx = self.actions.index(old)
         except ValueError:
@@ -281,6 +285,7 @@ class Bullet(object):
             self.actions[idx] = new
 
     def step(self):
+        """Advance by one frame."""
         created = []
 
         for action in self.actions:
diff --git a/bulletml/parser.py b/bulletml/parser.py
index bf850a7..e2b7c80 100644
--- a/bulletml/parser.py
+++ b/bulletml/parser.py
@@ -185,6 +185,7 @@ class Repeat(object):
     
     @classmethod
     def FromElement(cls, doc, element):
+        """Construct using an ElementTree-style element."""
         for subelem in element.getchildren():
             tag = realtag(subelem)
             if tag == "times":