renpy/doc/reference/functions/Pan - Ren'Py

documentation index ◦ reference manual ◦ function index

# Pan

Function: | Pan | (startpos, endpos, time, repeat=False, bounce=False, time_warp=None, **properties):

Pan, when given the appropriate arguments, gives an object that can be passed to the at clause of an image to cause the image to be panned on the screen. The parameters startpos and endpos are tuples, containing the x and y coordinates of the upper-left hand corner of the screen relative to the image. time is the time it will take this position to move from startpos to endpos. repeat, bounce, and time_warp are as for Motion.

As the current implementation of Ren'Py is quite limited, there are quite a few restrictions that we put on pan. The big one is that there always must be a screen's worth of pixels to the right and below the start and end positions. Failure to ensure this may lead to inconsistent rendering.

Please note that the pan will be immediately displayed, and that Ren'Py will not wait for it to complete before moving on to the next statement. This may lead to the pan being overlayed with text or dialogue. You may want to use a call to renpy.pause to delay for the time it will take to complete the pan.

Finally, also note that when a pan is completed, the image locks into the ending position.

## Example

    "For this example, assume that the screen is 800 x 600, and that the image
     marspan is 2400 x 600 pixels in size. We want to take 10 seconds to pan
     from left to right on the image."

    scene marspan at Pan((0, 0), (1600, 0), 10.0)

documentation index ◦ reference manual ◦ function index