Current revision

Introduction

There are a number of interfaces in cs and cel which can serve as callbacks to discover things happening in engine. To be able to use this functionality, one must inherit from special python base classes.

There are two modules in csexternal repository that provide such classes, one for cs and one for cel: cscallback and celcallback.

In general for a given interface, there is a base class, with the naming convention of prefixing with py instead of i as is normal for interfaces.

In the cscallback module there are also a couple classes (see tables below) that can be inherited from, these don't need any name change.

Example

For example, in iMovableListener this would be pyMovableListener. To use it just declare your class inheriting from this, and implement the needed interface functions in your class.

from cscallback import pyMovableListener

class MyMovableListener(pyMovableListener):
    # constructor
    def __init__(self):
        pyMovableListener.__init__(self,ObjectRegistry)
    # callback functions
    def MovableChanged(self,movable):
        print "movable changed"
    def MovableDestroyed(self,movable):
        print "movable destroyed"

movlistener = MyMovableListener()
Movable.AddListener(movlistener)

Note how the constructor for all callback classes requires that you pass the object registry (in the previous example, it is assumed ObjectRegistry is the object registry, and Movable a valid movable).

Supported interfaces

cscallback

interfaces

classes

classes that can be directly inherited.

celcallback

interfaces

Back to PyCrystal