anim.TransitionAnimation - Ren'Py Visual Novel Engine

documentation index ◦ reference manual ◦ function index

# anim.TransitionAnimation

Function: | anim.TransitionAnimation | (*args, **kwargs):

A displayable that draws an animation with each frame separated by a transition.

This takes arguments such that the 1st, 4th, 7th, ... arguments are displayables, the 2nd, 5th, 8th, ... arguments are times, and the 3rd, 6th, 9th, ... are transitions.

This displays the first displayable for the given time, then transitions to the second displayable using the given transition, and shows it for the given time (the time of the transition is taken out of the time the frame is shown), and so on.

A transition may be None, to specify no transition should be used.

The last argument may be a transition (in which case that transition is used to transition back to the first frame), or a displayable (which is shown forever).

Not all transitions can be used with this. (Most notably, the various forms of MoveTransition can't.)

There is one keyword argument, apart from the usual style properties:

anim_timebase - If True, the default, use the animation timebase. Otherwise, use the displayable timebase.

## Example

    init:
        image my_animation = anim.TransitionAnimation("frame1.png", 2.0, dissolve,
                                                      "frame2.png", 2.0, dissolve)

documentation index ◦ reference manual ◦ function index