Store Variables - Ren'Py

documentation index ◦ reference manual ◦ function index

# Store Variables

This is a list of special store variables that control aspects of gameplay. These are variables that are placed in the store (the default scope of python code), and so can be updated during the course of the game. You must be careful to ensure that the values of these variables can be pickled. (For example, one should create a function with a different name inside an init block, and then assign it to one of these variables.)

## Variable List

Variable: | adv | = ...

This is the template adv-mode character, and the default character used when we are in adv-mode.

Variable: | default_transition | = None

If not None, a default transition that is used when no transition is specified. Don't use this, it's really annoying.

Variable: | menu | = renpy.display_menu

The function that's called to display the menu. It should take the same arguments as renpy.display_menu. Assigning nvl_menu to this is often done in nvl mode.

Variable: | mouse_visible | = True

Controls if the mouse is visible. This is automatically set to true when entering the standard game menus.

Variable: | name_only | = ...

This is the character that is used as a base for dialogue spoken by characters with names given as a just a string. This is used by the say function.

Variable: | narrator | = ...

This is the character that will say narration (that is, say statements consisting of only a single string).

Variable: | nvl | = ...

This is the default kind of character for NVL-mode characters.

Variable: | predict_menu | = ...

This is called with no arguments, and is expected to return a list of displayables used by the menu function.

Variable: | predict_say | = ...

This is used to predict the images used by say. It's called with the same two arguments, and is expected to return a list of displayables used.

Variable: | say | = ...

A function that is called when the say statement is called with a string for a name. The default behavior of this function creates a copy of the name_only object with the supplied name, and then uses that to display the dialogue. The function takes two arguments, given the name of the character and the line of dialogue.

Variable: | save_name | = ""

This is a name that's used when data is saved.

Variable: | suppress_overlay | = False

When true, overlay functions will not be called and the overlay will not be displayed. Defaults to true, but is set to false upon entering the out-of-game menus.

Variable: | _window_subtitle | =

This is appended to config.window_title to produce the caption for the game window. (new in 6.7.1)

Variables and functions specific to menu customization are documented at Customizing the Main and Game Menus.

documentation index ◦ reference manual ◦ function index