Statement Equivalents link
To allow Ren'Py to be scripted in Python, each Ren'Py statement has a Python equivalent. This usually consists of a Python function, but may also consist of a pattern of Python calls that perform an action equivalent to the statement.
Note that using statement equivalents in lieu of the original statements usually removes any possible Lint checks and prediction optimizations, making your game less easily checkable and possibly less fluid. It can also disable features in certain cases.
Dialogue link
Warning
Several features, such as skipping already-seen dialogues, are not available using the python version and only enabled when using the native say statement.
The Ren'Py Say Statement is equivalent to calling the character
object (when any is present) as a function. Displaying narration (meaning when
no character is supplied) can be done the same way, by using the narrator
character.
e "Hello, world."
$ e("Hello, world.")
"And then the sun exploded."
$ narrator("And then the sun exploded.")
Proxy functions link
This equivalence of characters and function objects works in the other direction as well. It is possible to declare a Python function, and then use that function in the place of a character object in a native say statement. For example, the following function uses a variable to choose between two characters.
define lucy_normal = Character("Lucy")
define lucy_evil = Character("Evil Lucy")
init python:
def l(what, **kwargs):
if lucy_is_evil:
lucy_evil(what, **kwargs)
else:
lucy_normal(what, **kwargs)
label start:
$ lucy_is_evil = False
l "Usually, I feel quite normal."
$ lucy_is_evil = True
l "But sometimes, I get really mad!"
A function used in this way should either ignore unknown keyword arguments, or pass them to a character function. Doing this will allow the game to continue working if future versions of Ren'Py add additional keyword arguments to character calls.
Note that unlike other possible arguments, interact=True
will always be
passed to the function - unless manually passing (interact=False)
. A
Say with Arguments sees the arguments (including the supplementary
interact) passed to the function. For example:
e "Hello, world." (what_size=32)
resolves to the following call:
e("Hello, world.", what_size=32, interact=True)
Note that it's not required to pass interact=True
when calling a Character
object for it to work as intended. The following works just as well:
$ e("Hello, world.", what_size=32)
When e is a Character, this is further equivalent to:
$ Character(kind=e, what_size=32)("Hello, world.")
But it's possible to use config.say_arguments_callback
or
have e
wrap a character to do things differently.
There is one additional way of replacing the say statement using Python:
Dialogue Window Management link
Window management is performed by setting
the _window
and _window_auto
variables, and by using the following
two functions:
Displaying Images link
The image, scene, show, and hide statements each have an equivalent Python function (see Displaying Images for the original statements).
Transitions link
The equivalent of the With Statement is the renpy.with_statement()
function.
Jump link
The equivalent of the Jump Statement is the renpy.jump()
function.
Call link
The equivalent of the Call Statement is the renpy.call()
function.
Pause link
The equivalent of the Pause Statement is the renpy.pause()
function.
Layeredimage link
The Layeredimage statement has Python equivalents. The group
statement does not: the name of the group is supplied to Attribute
,
and the auto
feature can be implemented using renpy.list_images()
.