Callbacks
================

.. function:: callbackFunction()

   Signature of a default callback function.

   The default callback function takes no arguments, and is thus the simplest
   callback function possible. There are several Scribbler Adventure objects
   purely designed to allow the use of this simple callback function in favor
   of more powerful, but more complicated, alternatives.


.. function:: onClick(obj, event)

   Signature of the function that handles click events.

   Args:
       obj: the object being clicked.

       event: the event triggering the click.
	

.. function:: onCollision(myFixture, otherFixture, contact)

   Signature of the function that handles collisions.

   Args:
       myFixture: The :class:`.Fixture` of the object on which 
           this collision function is installed. 

       otherFixture: The :class:`.Fixture` of the object colliding
           with the object on which this collision function was installed.

       contact: The :class:`.Contact` object associated with this collision.


.. function:: onSeparation(myFixture, otherFixture)

   Signature of the function that handles separation events.

   Args:
       myFixture: The :class:`.Fixture` of the object on which 
           this separation function is installed. 

       otherFixture: The :class:`.Fixture` of the object separating from
           the object on which this collision function was installed.


.. function:: actorOnUse(actor)

   Signature of the onUsecallbacks used by Scribbler adventure actors.

   Args:
       actor: The actor of which the use action is called.


.. function:: actorOnInteract(actor, items)

   Signature of the onInteract callbacks used by Scribbler adventure actors.

   Args:
      actor: The actor of which the use action is called.
      
      items: The list of items that passed to the use function when the user
           interacted with this Actor.