handy helpers for looking up "my scene", "my layer" and killing something

r1chardj0n3s · r1chardj0n3s · commit 0fbddc1b098a · 2010-07-05T09:43:23.000Z
diff --git a/cocos/actions/instant_actions.py b/cocos/actions/instant_actions.py
@@ -160,7 +160,7 @@ class DoAction(InstantAction):
     Example::
 
         action = Repeat( dance )
-        sprite.do( go_home + DoAction( dance ) )
+        sprite.do( go_home + DoAction( action ) )
     """
     def init(self, action):
         self.action = action
diff --git a/cocos/cocosnode.py b/cocos/cocosnode.py
@@ -336,6 +336,26 @@ def get_ancestor(self, klass):
         if parent:
             return parent.get_ancestor( klass )
 
+    @property
+    def scene(self):
+        '''Get the Scene this cocosnode (eventually) belongs to.
+
+        Is None if there is no Scene ancestor.
+        '''
+        # late import to avoid circular reference
+        from cocos import scene
+        return self.get_ancestor(scene.Scene)
+
+    @property
+    def layer(self):
+        '''Get the Layer this cocosnode (eventually) belongs to.
+
+        Is None if there is no Layer ancestor.
+        '''
+        # late import to avoid circular reference
+        from cocos import layer
+        return self.get_ancestor(layer.Layer)
+
     #
     # Transform properties
     #
@@ -417,6 +437,12 @@ def add(self, child, z=0, name=None ):
             child.on_enter()
         return self
 
+    def kill(self):
+        '''Remove this object from its parent, and thus most likely from
+        everything.
+        '''
+        self.parent.remove(self)
+
     def remove( self, obj ):
         """Removes a child from the container given its name or object
 
diff --git a/cocos/scene.py b/cocos/scene.py
@@ -103,6 +103,13 @@ def __init__(self, *children):
         self.music = None
         self.music_playing = False
 
+        self.init()
+
+    def init(self):
+        '''Perform scene initialisation at creation time.
+        '''
+        pass
+
     def on_enter(self):
         for c in self.get_children():
             c.parent = self
