Transitions can be used as part of the with statement, as well as in other parts of Ren'Py, to apply effects to changes in the scene. Ren'Py comes with a small number of pre-defined transitions, which can be given directly to the with statement. It also includes transition classes, which can be used to create new transitions.
Pre-defined transitions can be given directly to the with statement. For example:
show bg washington with dissolve
Takes 0.5 seconds to fade to black, and then 0.5 seconds to
fade to the new screen. An instance of the
Takes 0.5 seconds to dissolve from the old to the new screen. An
instance of the
Dissolve() transition class.
Pixellates the old scene for .5 seconds, and the new scene for
another .5 seconds. An instance of the
Takes 0.5 seconds to the move images that have changed location to
their new locations. An instance of the
Also: moveinleft, moveintop, moveinbottom
These move entering images onto the screen from the appropriate side, taking 0.5 seconds to do so.
Also: moveoutleft, moveouttop, moveoutbottom
These move leaving images off the screen via the appropriate side, taking 0.5 seconds to do so.
Also: easeinright, easeinleft, easeintop, easeinbottom, easeoutright, easeoutleft, easeouttop, easeoutbottom
These are similar to the move- family of transitions, except that they use a cosine-based curve to slow down the start and end of the transition.
This zooms in entering images, taking 0.5 seconds to do so.
This zooms out leaving images, taking 0.5 seconds to do so.
This zooms in entering images and zooms out leaving images, taking 0.5 seconds to do so.
When invoked, this transition shakes the screen vertically for a quarter second.
When invoked, this transition shakes the screen horizontally for a quarter second.
Transitions the screen in a vertical blinds effect lasting 1
second. An instance of the
ImageDissolve() transition class.
Transitions the screen in a squares effect lasting 1 second.
Also: wiperight, wipeup, wipedown
Wipes the scene in the given direction. Instances of the
CropMove() transition class.
Also: slideright, slideup, slidedown
Slides the new scene in the given direction. Instances of the
CropMove() transition class.
Also: slideawayright, slideawayup, slideawaydown
Slides the old scene in the given direction. Instances of the
CropMove() transition class.
Also: pushleft, pushtop, pushbottom
These use the new scene to slide the old scene out the named
side. Instances of the
PushMove() transition class.
Transition classes are functions that can be called to create new transitions. These functions are parameterized, allowing entire families of transitions to be created.
Calling transition classes can be done as part of the with statement. For example:
# A very long dissolve. with Dissolve(10.0)
If we find ourselves calling the same transition class repeatedly, we can use the define statement to assign the transition to a variable:
define annoytheuser = Dissolve(1.0) label start: show bg washington with annoytheuser
AlphaDissolve(control, delay=0.0, alpha=False, reverse=False) link
Returns a transition that uses a control displayable (almost always some sort of animated transform) to transition from one screen to another. The transform is evaluated. The new screen is used where the transform is opaque, and the old image is used when it is transparent.
ComposeTransition(trans, before, after) link
Returns a transition that composes up to three transitions. If not None, the before and after transitions are applied to the old and new scenes, respectively. These updated old and new scenes are then supplied to the trans transition.
# Move the images in and out while dissolving. (This is a fairly expensive transition.) define moveinoutdissolve = ComposeTransition(dissolve, before=moveoutleft, after=moveinright)
CropMove(time, mode="slideright", startcrop=(0.0, 0.0, 0.0, 1.0), startpos=(0.0, 0.0), endcrop=(0.0, 0.0, 1.0, 1.0), endpos=(0.0, 0.0), topnew=True) link
Returns a transition that works by cropping a scene and positioning it on the screen. This can be used to implement a variety of effects, all of which involved changing rectangular slices of scenes.
The name of the mode of the transition. There are three groups of modes: wipes, slides, and other. This can also be "custom", to allow a custom mode to be defined.
In a wipe, the image stays fixed, and more of it is revealed as the transition progresses. For example, in "wiperight", a wipe from left to right, first the left edge of the image is revealed at the left edge of the screen, then the center of the image, and finally the right side of the image at the right of the screen. Other supported wipes are "wipeleft", "wipedown", and "wipeup".
In a slide, the image moves. So in a "slideright", the right edge of the image starts at the left edge of the screen, and moves to the right as the transition progresses. Other slides are "slideleft", "slidedown", and "slideup".
There are also slideaways, in which the old image moves on top of the new image. Slideaways include "slideawayright", "slideawayleft", "slideawayup", and "slideawaydown".
We also support a rectangular iris in with "irisin" and a rectangular iris out with "irisout".
The following parameters are only respected if the mode is "custom". Positions are relative to the size of the screen, while the crops are relative to the size of the image. So a crop of (0.25, 0.0, 0.5, 1.0) takes the middle half of an image.
define wiperight = CropMove(1.0, "wiperight") define wipeleft = CropMove(1.0, "wipeleft") define wipeup = CropMove(1.0, "wipeup") define wipedown = CropMove(1.0, "wipedown") define slideright = CropMove(1.0, "slideright") define slideleft = CropMove(1.0, "slideleft") define slideup = CropMove(1.0, "slideup") define slidedown = CropMove(1.0, "slidedown") define slideawayright = CropMove(1.0, "slideawayright") define slideawayleft = CropMove(1.0, "slideawayleft") define slideawayup = CropMove(1.0, "slideawayup") define slideawaydown = CropMove(1.0, "slideawaydown") define irisout = CropMove(1.0, "irisout") define irisin = CropMove(1.0, "irisin")
Dissolve(time, alpha=False, time_warp=None) link
Returns a transition that dissolves from the old scene to the new scene.
Fade(out_time, hold_time, in_time, color="#000") link
Returns a transition that takes out_time seconds to fade to a screen filled with color, holds at that screen for hold_time seconds, and then takes in_time to fade to then new screen.
# Fade to black and back. define fade = Fade(0.5, 0.0, 0.5) # Hold at black for a bit. define fadehold = Fade(0.5, 1.0, 0.5) # Camera flash - quickly fades to white, then back to the scene. define flash = Fade(0.1, 0.0, 0.5, color="#fff")
ImageDissolve(image, time, ramplen=8, reverse=False, alpha=True, time_warp=None) link
Returns a transition that dissolves the old scene into the new scene, using an image to control the dissolve process. This means that white pixels will dissolve in first, and black pixels will dissolve in last.
define circirisout = ImageDissolve("circiris.png", 1.0) define circirisin = ImageDissolve("circiris.png", 1.0, reverse=True) define circiristbigramp = ImageDissolve("circiris.png", 1.0, ramplen=256)
MoveTransition(delay, enter=None, leave=None, old=False, layers=['master'], time_warp=None, enter_time_warp=None, leave_time_warp=None) link
Returns a transition that interpolates the position of images (with the same tag) in the old and new scenes.
Returns a transition that allows multiple transitions to be displayed, one after the other.
A list containing an odd number of items. The first, third, and other odd-numbered items must be scenes, and the even items must be transitions. A scene can be one of:
Almost always, the first argument will be False and the last True.
The transitions in args are applied in order. For each transition, the old scene is the screen preceding it, and the new scene is the scene following it. For example:
define logodissolve = MultipleTransition([ False, Dissolve(0.5), "logo.jpg", Pause(1.0), "logo.jpg", dissolve, True])
This example will dissolve to logo.jpg, wait 1 second, and then dissolve to the new scene.
Returns a transition that only displays the new screen for delay seconds. It can be useful as part of a MultipleTransition.
Pixellate(time, steps) link
Returns a transition that pixellates out the old screen, and then pixellates in the new screen.
PushMove(time, mode="pushright") link
Returns a transition that works by taking the new scene and using it to "push" the old scene off the screen.
define pushright = PushMove(1.0, "pushright") define pushleft = PushMove(1.0, "pushleft") define pushup = PushMove(1.0, "pushup") define pushdown = PushMove(1.0, "pushdown")
Transition families are functions that define a large family of related transitions.
move_transitions(prefix, delay, time_warp=None, in_time_warp=None, out_time_warp=None, old=False, layers=[u'master'], **kwargs) link
This defines a family of move transitions, similar to the move and ease transitions. For a given prefix, this defines the transitions:
Time warp functions that are given a time from 0.0 to 1.0 representing the fraction of the move complete, and return a value in the same range giving the fraction of a linear move that is complete.
This can be used to define functions that ease the images around, rather than moving them at a constant speed.
The three argument are used for images remaining on the screen, newly shown images, and newly hidden images, respectively.
# This defines all of the pre-defined transitions beginning # with "move". init python: define.move_transitions("move", 0.5)