Preference Variables link
Preference variables store the values of Ren'Py preferences. While the value
of a preference should be set at runtime using the
preference variables should be used in conjunction with the default statement
to set the default value of a preference.
default preferences.text_cps = 40
sets the default text speed to 40 characters per second. The default statement only sets the value of the preference if the default has changed since the preference was set. For example, if the player changes the speed to 50, it will remain at 50 over future runs of the game. If, in an upgrade, the default is set to 42, the player's setting will be changed to 42. (The player can then change it again.)
- preferences.afm_after_click = False link
If True, the auto-forward mode will be continued after a click. If False, a click will end auto-forward mode. The equivalent of the "auto-forward after click" preference.
- preferences.afm_enable = False link
If True, auto-forward move is enabled, otherwise False. The equivalent of the "auto-forward time" preference.
- preferences.afm_time = 15 link
The amount of time to wait for auto-forward mode. Bigger numbers are slower, though the conversion to wall time is complicated, as the speed takes into account line length. The equivalent of the "auto-forward" preference.
- preferences.desktop_rollback_side = "disable" link
When on a desktop platform, touches or clicks to this side of the window cause rollback to occur. One of "left", "right", or "disable". This is the equivalend of the "rollback side" preference when on a desktop platform.
- preferences.mobile_rollback_side = "disable" link
When on a mobile platform, touches or clicks to this side of the window cause rollback to occur. One of "left", "right", or "disable". This is the equivalend of the "rollback side" preference when on a mobile platform.
- preferences.language = None link
The language that the player has selected to use when running the game. This is None for the default language or a string containing a language the game is translated to.
This can be used to set the default language, and can be read to determine the current language. The
Language()action can be used to change the language.
See Translation for more information.
- preferences.emphasize_audio = False link
If True, Ren'Py will emphasize the audio channels found in
config.emphasize_audio_channelsby reducing the volume of other channels. (For example, reducing the music volume when voice is playing.) If False, this doesn't happen.
- preferences.fullscreen = False link
This is True when Ren'Py is in fullscreen mode, and False when it is running in a window. The equivalent of the "display" preference.
- preferences.gl_framerate = None link
This is either an integer, or None. If not None, it's a target framerate that Ren'Py will attempt to achieve. If this is set low (for example, to 30), on a monitor with a high framerate (say, 60 frames per second), Ren'Py will only draw on every other frame.
If None, Ren'Py will attempt to draw at the monitor's full framerate.
- preferences.gl_powersave = "auto" link
This determines how often Ren'Py will redraw an unchanging screen. If True, Ren'Py will only draw the screen 5 times a second. If False, it will always draw at the full framerate possible. If "auto", it will draw at full speed when the device is powered, and 5hz when it is running on battery.
- preferences.gl_tearing = False link
This determines if tearing (True) or frameskip (False) is the preferred behavior when the game can't keep up with its intended framerate.
- preferences.mouse_move = True link
If True, the mouse will automatically move to a selected button. If False, it will not. The equivalent of the "automatic move" preference.
- preferences.show_empty_window = True link
If True, the window show and window auto statements will function. If False, those statements are disabled. The equivalent of the "show empty window" preference.
- preferences.skip_after_choices = False link
If True, skipping will resume after a choice. If False, a choice will prevent Ren'Py from skipping. The equivalent of the "after choices" preference.
- preferences.skip_unseen = False link
When True, Ren'Py will skip all text. When False, Ren'Py will only skip text that has been read by the player in any session. The equivalent of the "skip" preference.
- preferences.text_cps = 0 link
The speed of text display. 0 is infinite, otherwise this is the number of characters per second to show. The equivalent of the "text speed" preference.
- preferences.transitions = 2 link
Determines which transitions should be shown. 2 shows all transitions, 0 shows no transitions. (1 is reserved.) The equivalent of the "transitions" preference.
- preferences.video_image_fallback = False link
If True, images are displayed instead of videosprites. If False, video sprites are displayed normally. The equivalent (inverted) of the "video sprites" preference.
- preferences.voice_sustain = False link
If True, voice keeps playing until finished, or another voice line replaces it. If False, the voice line ends when the line of dialogue advances. The equivalent of the "voice sustain" preference.
- preferences.wait_voice = True link
If True, auto-forward mode will wait for voice files and self-voicing to finish before advancing. If False, it will not. The equivalent of the "wait for voice" preference.
- preferences.system_cursor = False link
- preferences.audio_when_minimized = True link
If False, audio channels are stopped when the window is minimized, and resumed when the window is restored. If True, window state will have no effect on audio. The equivalent of the "audio when minimized" preference.
- preferences.audio_when_unfocused = True link
If False, audio channels are stopped when the window loses keyboard focus, and resumed when the window regains keyboard focus. If True, keyboard focus will have no effect on audio. The equivalent of the "audio when unfocused" preference.
- preferences.web_cache_preload = False link
If True the game files will be loaded into the web browser's cache, allowing the game to be played offline. If False, the game files will not be loaded into the web browser's cache, and the game will require internet access to play. The equivalent of the "web cache preload" preference.
If True, voice will continue playing after the game menu is shown. If False, voice will be stopped when the game menu is shown. The equivalent of the "voice after menu" preference.
Mixer Functions link
See Volume for more details about mixers.
- preferences.set_mixer(mixer, volume) link
Sets mixer to volume.
A string giving the name of the mixer. By default, the mixers are "main", "music", "sfx", and "voice" ("main" being a special mixer).
A number between 0.0 and 1.0, where 0.0 is -40 dB (power), and 1.0 is 0 dB (power).
- preferences.get_mixer(mixer) link
Gets the volume for mixer. If the mixer is muted, this returns 0.0. The is returns a number between 0.0 and 1.0, where 0.0 is -40 dB (power) and 1.0 is 0 dB (power).
- preferences.set_mute(mixer, mute) link
Sets the mute setting for mixer. If mute is true, the mixer is muted. If mute is false, the mixer's volume is reverted to its value before it was muted.
- preferences.get_mute(mixer) link
Gets the mute setting for mixer.
Audio Channel Defaults link
These config variables set the default volumes on various audio mixers.
- define config.default_music_volume = 1.0 link
The default volume of the music mixer, which is used for the music and movie channels. This should be a number between 0.0 and 1.0, with 1.0 being full volume.
- define config.default_sfx_volume = 1.0 link
The default volume of the sfx mixer, which is used for the sound and audio channels. This should be a number between 0.0 and 1.0, with 1.0 being full volume.
- define config.default_voice_volume = 1.0 link
The default volume of the voice mixer, which is used for the voice channel (and hence the voice statement, auto-voice, etc.). This should be a number between 0.0 and 1.0, with 1.0 being full volume.