documentation index ◦ reference manual ◦ function index
Preferences can be updated using the following variables and functions.
| Variable: | _preferences.fullscreen | = False |
True if Ren'Py should be run in a fullscreen mode. See config.default_fullscreen for a simple way to set the default value of this the first time a user runs your game.
| Variable: | _preferences.transitions | = 2 |
The kinds of transitions to show. 0 for no transitons, 2 for all transitions. A lesser-used value is 1, which shows all transitions except default transitions.
| Variable: | _preferences.text_cps | = 0 |
The number of characters per second to show slow text at. 0 means to show infinitely fast. A sensible range is between 1 and 150. The default value of this can be set with config.default_text_cps.
| Variable: | _preferences.afm_time | = 0 |
The number of seconds to delay after showing config.afm_characters (default 250) characters in auto-forward mode. A sensible range is between 1 and 40 seconds. If set to 0, auto-forward mode is disabled.
| Variable: | _preferences.skip_unseen | = False |
If True, skipping will skip unseen messages. If False, only seen messages will be skipped.
| Variable: | _preferences.skip_after_choices | = False |
If True, skipping continues past menus. If False, skipping stops a menus.
| Function: | _preferences.set_volume | (mixer, volume): |
Sets the volume of the given mixer to the given volume. mixer is usually 'sfx', 'voice', or 'music', volume ranges between 0 and 1.0.
| Function: | _preferences.get_volume | (mixer): |
Gets the volume of mixer, which is usually 'sfx', 'voice', or 'music'. The returned volume ranges between 0 and 1.0.