Browsing English (United Kingdom) translation

1.

Creator-Defined Displayables

2.

The most complex, but most powerful, way of customizing Ren'Py's behavior is to use a creator-defined displayable. A creator-defined displayable is allowed to take arbitrary pygame events. It can also render other displayables, and place them at arbitrary locations on the screen. This makes it suitable for creating 2D mini-games that cannot be expressed with the tools Ren'Py gives you. (But see also the section :ref:`sprites <sprites>`, which describes a higher-level way of accomplishing many of the same things.)

3.

Creator-defined displayables are programmed entirely in Python, and we encourage you to have a reasonable degree of skill at object-oriented Python programming before you begin creating one.

4.

Example

5.

Here's an example of a creator-defined displayable. This displayable changes renders its child with an alpha that is determined by the distance of the mouse pointer from the center of the child. ::

6.

To use the creator-defined displayable, we can create an instance of it, and add that instance to the screen. ::

7.

renpy.Displayable

8.

A creator-defined displayable is created by subclassing the renpy.Displayable class. A creator-defined displayable must override the render method, and may override other methods as well.

9.

A displayable object must be pickleable, which means it may not contain references to objects that cannot be pickled. Most notably, Render objects cannot be stored in a creator-defined displayable.

10.

Since we expect you to override the methods of the displayable class, we'll present them with the `self` parameter.