Ren'Py Documentation
7.3.5
Home Page
Online Documentation
Site
Quickstart
GUI Customization Guide
Language Basics
Labels & Control Flow
Dialogue and Narration
Displaying Images
In-Game Menus
Python Statements
Conditional Statements
Audio
Movie
Voice
Text
Translation
Displayables
Transforms
Transitions
Animation and Transformation Language
Layered Images
Styles
Style Properties
Screens and Screen Language
Screen Actions, Values, and Functions
Special Screen Names
Screen Language Optimization
Configuration Variables
Preference Variables
Store Variables
Developer Tools
Interactive Director
NVL-Mode Tutorial
Text Input
Side Images
Image Gallery, Music Room, and Replay Actions
Drag and Drop
Sprites
Customizing the Keymap
Achievements
Dialogue History
Multiple Character Dialogue
Statement Equivalents
Saving, Loading, and Rollback
Persistent Data
Transforms and Transitions in Python
Advanced GUI
Screens and Python
Modes
Creator-Defined Displayables
Creator-Defined Statements
Custom Text Tags
Character Callbacks
File Access
Color Class
Other Functions and Variables
Building Distributions
Web Updater
Android
Chrome OS / Chrome Browser
iOS
In-App Purchasing
Gestures
Raspberry Pi
Dealing with Problems
Environment Variables
Self-Voicing
Text Editor Integration
Skins
Translating Ren’Py
Full Changelog
Incompatible Changes
Distributor Notes
License
Credits
Ren’Py Development Sponsors
Script of The Question
NVL-mode script for The Question
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
Symbols
# (text tag)
_
_() (built-in function)
__() (built-in function)
__call__() (Action method)
__init__() (renpy.Displayable method)
_confirm_quit (variable)
_dismiss_pause (variable)
_game_menu_screen (variable)
_history (variable)
_history_list (variable)
_ignore_action (variable)
_in_replay (variable)
_menu (variable)
_preferences.language (variable)
_quit_slot (variable)
_rollback (variable)
_skipping (variable)
_version (variable)
_window (variable)
_window_auto (variable)
_window_subtitle (variable)
A
a (text tag)
action
Action (built-in class)
activate_sound (style property)
additive (transform property)
adjust_spacing (style property)
adv (variable)
advance() (Lexer method)
align (style property)
(transform property)
alignaround (transform property)
alpha (text tag)
(transform property)
alt (style property)
(variable)
altruby_style (style property)
anchor (style property)
(transform property)
angle (transform property)
antialias (style property)
area (style property)
args
arguments() (Lexer method)
around (transform property)
art (text tag)
B
b (text tag)
background (style property)
bar_invert (style property)
bar_resizing (style property)
bar_vertical (style property)
BarValue (built-in class)
base_bar (style property)
begin() (Editor method)
black_color (style property)
blinds (variable)
blit() (renpy.Render method)
bold (style property)
bottom_bar (style property)
bottom_gutter (style property)
bottom_margin (style property)
bottom_padding (style property)
box_reverse (style property)
box_wrap (style property)
box_wrap_spacing (style property)
build.allow_integrated_gpu (variable)
build.destination (variable)
build.directory_name (variable)
build.exclude_empty_directories (variable)
build.executable_name (variable)
build.google_play_key (variable)
build.google_play_salt (variable)
build.include_old_themes (variable)
build.itch_project (variable)
build.name (variable)
C
canvas() (renpy.Render method)
caption
caret (style property)
catch_error() (Lexer method)
center (variable)
checkpoint() (Lexer method)
child (style property)
chosen
clear (text tag)
clear() (Style method)
color (style property)
(text tag)
config.adjust_view_size (variable)
config.adv_nvl_transition (variable)
config.afm_bonus (variable)
config.afm_callback (variable)
config.afm_characters (variable)
config.afm_voice_delay (variable)
config.after_load_callbacks (variable)
config.after_load_transition (variable)
config.after_replay_callback (variable)
config.all_character_callbacks (variable)
config.allow_skipping (variable)
config.archives (variable)
config.auto_channels (variable)
config.auto_choice_delay (variable)
config.auto_load (variable)
config.auto_voice (variable)
config.automatic_images (variable)
config.automatic_images_strip (variable)
config.autoreload (variable)
config.autosave_frequency (variable)
config.autosave_on_choice (variable)
config.autosave_on_quit (variable)
config.autosave_slots (variable)
config.cache_surfaces (variable)
config.character_callback (variable)
config.character_id_prefixes (variable)
config.choice_layer (variable)
config.clear_layers (variable)
config.conditionswitch_predict_all (variable)
config.context_callback (variable)
config.context_clear_layers (variable)
config.context_copy_remove_screens (variable)
config.custom_text_tags (variable)
config.debug (variable)
config.debug_image_cache (variable)
config.debug_sound (variable)
config.debug_text_overflow (variable)
config.default_music_volume (variable)
config.default_sfx_volume (variable)
config.default_tag_layer (variable)
config.default_transform (variable)
config.default_voice_volume (variable)
config.defer_styles (variable)
config.descriptive_text_character (variable)
config.developer (variable)
config.disable_input (variable)
config.dispatch_gesture (variable)
config.displayable_prefix (variable)
config.emphasize_audio_channels (variable)
config.emphasize_audio_time (variable)
config.emphasize_audio_volume (variable)
config.empty_window (variable)
config.enable_language_autodetect (variable)
config.end_game_transition (variable)
config.end_splash_transition (variable)
config.enter_replay_transition (variable)
config.enter_sound (variable)
config.enter_transition (variable)
config.enter_yesno_transition (variable)
config.exception_handler (variable)
config.exit_replay_transition (variable)
config.exit_sound (variable)
config.exit_transition (variable)
config.exit_yesno_transition (variable)
config.fade_music (variable)
config.fast_skipping (variable)
config.file_open_callback (variable)
config.fix_rollback_without_choice (variable)
config.focus_crossrange_penalty (variable)
config.font_replacement_map (variable)
config.game_main_transition (variable)
config.game_menu (variable)
config.game_menu_music (variable)
config.gc_print_unreachable (variable)
config.gc_thresholds (variable)
config.gestures (variable)
config.gl_clear_color (variable)
config.gl_enable (variable)
config.gl_resize (variable)
config.gl_test_image (variable)
config.hard_rollback_limit (variable)
config.has_autosave (variable)
config.help (variable)
config.hide (variable)
config.history_callbacks (variable)
config.history_length (variable)
,
[1]
config.hw_video (variable)
config.hyperlink_handlers (variable)
config.hyperlink_protocol (variable)
config.idle_gc_count (variable)
config.image_cache_size (variable)
config.image_cache_size_mb (variable)
config.imagemap_auto_function (variable)
config.imagemap_cache (variable)
config.implicit_with_none (variable)
config.interact_callbacks (variable)
config.intra_transition (variable)
config.keep_running_transform (variable)
config.keep_side_render_order (variable)
config.key_repeat (variable)
config.keymap (variable)
config.label_callback (variable)
config.label_overrides (variable)
config.language (variable)
config.layer_clipping (variable)
config.layers (variable)
config.lint_hooks (variable)
config.load_before_transition (variable)
config.load_failed_label (variable)
config.loadable_callback (variable)
config.locale_to_language_function (variable)
config.log (variable)
config.log_width (variable)
config.longpress_duration (variable)
config.longpress_radius (variable)
config.longpress_vibrate (variable)
config.main_game_transition (variable)
config.main_menu (variable)
config.main_menu_music (variable)
config.manage_gc (variable)
config.menu_arguments_callback (variable)
config.menu_clear_layers (variable)
config.menu_include_disabled (variable)
config.menu_window_subtitle (variable)
config.minimum_presplash_time (variable)
config.missing_background (variable)
config.missing_image_callback (variable)
config.missing_label_callback (variable)
config.mode_callbacks (variable)
config.mouse (variable)
config.mouse_hide_time (variable)
config.movie_mixer (variable)
config.name (variable)
config.narrator_menu (variable)
config.nearest_neighbor (variable)
config.new_substitutions (variable)
config.new_translate_order (variable)
config.notify (variable)
config.nvl_adv_transition (variable)
config.nvl_layer (variable)
config.nvl_list_length (variable)
config.nvl_page_ctc (variable)
config.nvl_page_ctc_position (variable)
config.nvl_paged_rollback (variable)
config.old_substitutions (variable)
config.optimize_texture_bounds (variable)
config.overlay_during_with (variable)
config.overlay_functions (variable)
config.overlay_layers (variable)
config.overlay_screens (variable)
config.per_frame_screens (variable)
config.periodic_callback (variable)
config.play_channel (variable)
config.predict_statements (variable)
config.preload_fonts (variable)
config.profile (variable)
config.python_callbacks (variable)
config.quicksave_slots (variable)
config.quit_action (variable)
config.quit_on_mobile_background (variable)
config.reload_modules (variable)
config.replace_text (variable)
config.replay_scope (variable)
config.rollback_enabled (variable)
config.rollback_length (variable)
config.rollback_side_size (variable)
config.save_directory (variable)
config.save_dump (variable)
config.save_json_callbacks (variable)
config.save_on_mobile_background (variable)
config.save_physical_size (variable)
config.savedir (variable)
config.say_allow_dismiss (variable)
config.say_arguments_callback (variable)
config.say_attribute_transition (variable)
config.say_attribute_transition_callback (variable)
config.say_attribute_transition_layer (variable)
config.say_layer (variable)
config.say_menu_text_filter (variable)
config.say_sustain_callbacks (variable)
config.scene (variable)
config.screen_height (variable)
config.screen_width (variable)
config.screenshot_callback (variable)
config.screenshot_crop (variable)
config.screenshot_pattern (variable)
config.script_version (variable)
config.search_prefixes (variable)
config.searchpath (variable)
config.self_closing_custom_text_tags (variable)
config.show (variable)
config.side_image_change_transform (variable)
config.side_image_null (variable)
config.side_image_only_not_showing (variable)
config.side_image_prefix_tag (variable)
config.side_image_same_transform (variable)
config.side_image_tag (variable)
config.skip_delay (variable)
config.skip_indicator (variable)
config.skip_sounds (variable)
config.sound (variable)
config.sound_sample_rate (variable)
config.speaking_attribute (variable)
config.start_callbacks (variable)
config.start_interact_callbacks (variable)
config.tag_layer (variable)
config.tag_transform (variable)
config.tag_zorder (variable)
config.thumbnail_height (variable)
,
[1]
config.thumbnail_width (variable)
,
[1]
config.top_layers (variable)
config.transform_uses_child_position (variable)
config.transient_layers (variable)
config.transition_screens (variable)
config.translate_clean_stores (variable)
config.tts_voice (variable)
config.variants (variable)
config.version (variable)
config.voice_filename_format (variable)
config.window (variable)
config.window_auto_hide (variable)
config.window_auto_show (variable)
config.window_hide_transition (variable)
config.window_icon (variable)
config.window_overlay_functions (variable)
config.window_show_transition (variable)
config.window_title (variable)
config.with_callback (variable)
corner1 (transform property)
corner2 (transform property)
cps (text tag)
crop (transform property)
crop_relative (transform property)
current
D
default (InputValue attribute)
(variable)
delay (transform property)
delimited_python() (Lexer method)
director.audio_channel_patterns (variable)
director.audio_channels (variable)
director.audio_patterns (variable)
director.button (variable)
director.director_spacing (variable)
director.other_spacing (variable)
director.scene_tags (variable)
director.show_tags (variable)
director.spacing (variable)
director.tag_blacklist (variable)
director.transforms (variable)
director.transitions (variable)
director.viewport_height (variable)
director.voice_channel (variable)
Disable() (InputValue method)
dissolve (variable)
E
ease (variable)
Editor (built-in class)
Enable() (InputValue method)
end() (Editor method)
enter() (InputValue method)
eol() (Lexer method)
error() (Lexer method)
event() (renpy.Displayable method)
events (transform property)
expect_block() (Lexer method)
expect_eol() (Lexer method)
expect_noblock() (Lexer method)
F
fade (variable)
fast (text tag)
first_indent (style property)
first_spacing (style property)
fit_first (style property)
float() (Lexer method)
focus_mask (style property)
font (style property)
(text tag)
foreground (style property)
G
get_adjustment() (BarValue method)
get_selected() (Action method)
get_sensitive() (Action method)
get_size() (renpy.Render method)
get_style() (BarValue method)
get_text() (InputValue method)
get_tooltip() (Action method)
(BarValue method)
gui.accent_color (variable)
gui.bar_borders (variable)
gui.bar_size (variable)
gui.bar_tile (variable)
gui.button_borders (variable)
gui.button_height (variable)
gui.button_image_extension (variable)
gui.button_text_font (variable)
gui.button_text_hover_color (variable)
gui.button_text_idle_color (variable)
gui.button_text_insensitive_color (variable)
gui.button_text_selected_color (variable)
gui.button_text_size (variable)
gui.button_text_xalign (variable)
gui.button_tile (variable)
gui.button_width (variable)
gui.check_button_borders (variable)
gui.choice_button_text_idle_color (variable)
gui.choice_text_hover_color (variable)
gui.confirm_frame_borders (variable)
gui.dialogue_text_xalign (variable)
gui.dialogue_width (variable)
gui.dialogue_xpos (variable)
gui.dialogue_ypos (variable)
gui.file_slot_cols (variable)
gui.file_slot_rows (variable)
gui.FONT_SCALE (variable)
gui.frame_borders (variable)
gui.frame_tile (variable)
gui.glyph_font (variable)
gui.history_height (variable)
gui.history_name_width (variable)
gui.history_name_xalign (variable)
gui.history_name_xpos (variable)
gui.history_name_ypos (variable)
gui.history_text_width (variable)
gui.history_text_xalign (variable)
gui.history_text_xpos (variable)
gui.history_text_ypos (variable)
gui.hover_color (variable)
gui.hover_muted_color (variable)
gui.idle_color (variable)
gui.idle_small_color (variable)
gui.insensitive_color (variable)
gui.interface_text_color (variable)
gui.interface_text_font (variable)
gui.interface_text_size (variable)
gui.kind_text_color (variable)
gui.kind_text_font (variable)
gui.kind_text_size (variable)
gui.label_text_size (variable)
gui.LIGHT_FONT (variable)
gui.muted_color (variable)
gui.name_text_size (variable)
gui.name_xalign (variable)
gui.name_xpos (variable)
gui.name_ypos (variable)
gui.namebox_borders (variable)
gui.namebox_height (variable)
gui.namebox_tile (variable)
gui.namebox_width (variable)
gui.navigation_button_width (variable)
gui.notify_frame_borders (variable)
gui.notify_text_size (variable)
gui.notify_ypos (variable)
gui.nvl_borders (variable)
gui.nvl_button_xalign (variable)
gui.nvl_button_xpos (variable)
gui.nvl_height (variable)
gui.nvl_name_width (variable)
gui.nvl_name_xalign (variable)
gui.nvl_name_xpos (variable)
gui.nvl_name_ypos (variable)
gui.nvl_spacing (variable)
gui.nvl_text_width (variable)
gui.nvl_text_xalign (variable)
gui.nvl_text_xpos (variable)
gui.nvl_text_ypos (variable)
gui.nvl_thought_width (variable)
gui.nvl_thought_xalign (variable)
gui.nvl_thought_xpos (variable)
gui.nvl_thought_ypos (variable)
gui.radio_button_borders (variable)
gui.REGULAR_BOLD (variable)
gui.REGULAR_FONT (variable)
gui.scrollbar_borders (variable)
gui.scrollbar_size (variable)
gui.scrollbar_tile (variable)
gui.selected_color (variable)
gui.skip_frame_borders (variable)
gui.skip_ypos (variable)
gui.slider_borders (variable)
gui.slider_size (variable)
gui.slider_tile (variable)
gui.slot_button_borders (variable)
gui.slot_button_height (variable)
gui.slot_button_width (variable)
gui.text_color (variable)
gui.text_font (variable)
gui.text_size (variable)
gui.textbox_height (variable)
gui.title_text_size (variable)
gui.unscrollable (variable)
gui.vbar_borders (variable)
gui.vscrollbar_borders (variable)
gui.vslider_borders (variable)
H
has_block() (Lexer method)
hide_request (Transform attribute)
hide_response (Transform attribute)
hinting (style property)
HistoryEntry (built-in class)
horiz (text tag)
hover_sound (style property)
hpunch (variable)
hyperlink_functions (style property)
I
i (text tag)
image (text tag)
image_name_component() (Lexer method)
image_tag (HistoryEntry attribute)
InputValue (built-in class)
integer() (Lexer method)
irisin (variable)
italic (style property)
J
justify (style property)
K
k (text tag)
kerning (style property)
key_events (style property)
keyboard_focus (style property)
keyboard_focus_alt (style property)
keyword() (Lexer method)
kind (HistoryEntry attribute)
kwargs
L
label_name() (Lexer method)
language (style property)
layout (style property)
left (variable)
left_bar (style property)
left_gutter (style property)
left_margin (style property)
left_padding (style property)
Lexer (built-in class)
line_leading (style property)
line_overlap_split (style property)
line_spacing (style property)
M
main_menu (variable)
margin (style property)
match() (Lexer method)
maximum (style property)
maxsize (transform property)
menu (variable)
min_width (style property)
minimum (style property)
mouse (style property)
mouse_alt (style property)
mouse_visible (variable)
move (variable)
moveinright (variable)
moveoutright (variable)
MultiPersistent (built-in class)
multiple
N
name() (Lexer method)
name_only (variable)
narrator (variable)
nearest (transform property)
newline_indent (style property)
nw (text tag)
O
offscreenleft (variable)
offscreenright (variable)
offset (style property)
open() (Editor method)
order_reverse (style property)
outlinecolor (text tag)
outlines (style property)
P
p (text tag)
padding (style property)
per_interact() (renpy.Displayable method)
periodic() (Action method)
(BarValue method)
pixellate (variable)
place() (renpy.Render method)
plain (text tag)
pos (style property)
(transform property)
preferences.afm_after_click (variable)
preferences.afm_enable (variable)
preferences.afm_time (variable)
preferences.desktop_rollback_side (variable)
preferences.emphasize_audio (variable)
preferences.fullscreen (variable)
preferences.gl_framerate (variable)
preferences.gl_powersave (variable)
preferences.gl_tearing (variable)
preferences.mobile_rollback_side (variable)
preferences.mouse_move (variable)
preferences.show_empty_window (variable)
preferences.skip_after_choices (variable)
preferences.skip_unseen (variable)
preferences.text_cps (variable)
preferences.transitions (variable)
preferences.video_image_fallback (variable)
preferences.voice_sustain (variable)
preferences.wait_voice (variable)
pushright (variable)
Python Enhancement Proposals
PEP 3101
PEP 3102
,
[1]
R
radius (transform property)
rb (text tag)
render() (renpy.Displayable method)
renpy.android (variable)
renpy.Displayable (built-in class)
renpy.emscripten (variable)
renpy.ios (variable)
renpy.license (variable)
renpy.linux (variable)
renpy.macintosh (variable)
renpy.mobile (variable)
renpy.redraw() (built-in function)
renpy.Render (built-in class)
renpy.version_name (variable)
renpy.version_only (variable)
renpy.version_string (variable)
renpy.version_tuple (variable)
renpy.windows (variable)
renpy_block() (Lexer method)
renpy_statement() (Lexer method)
replaces() (BarValue method)
require() (Lexer method)
reset (variable)
rest() (Lexer method)
rest_indent (style property)
revert() (Lexer method)
right (variable)
right_bar (style property)
right_gutter (style property)
right_margin (style property)
right_padding (style property)
rollback_identifier (HistoryEntry attribute)
rotate (transform property)
rotate_pad (transform property)
rt (text tag)
ruby_style (style property)
S
s (text tag)
Sample() (built-in function)
save() (MultiPersistent method)
save_name (variable)
,
[1]
say (variable)
set_child() (Transform method)
set_parent() (Style method)
set_text() (InputValue method)
show_args (HistoryEntry attribute)
simple_expression() (Lexer method)
size (style property)
(text tag)
(transform property)
size_group (style property)
slideawayleft (variable)
slideleft (variable)
slow_abortable (style property)
slow_cps (style property)
slow_cps_multiplier (style property)
space (text tag)
spacing (style property)
spacing_alt (style property)
squares (variable)
strikethrough (style property)
string() (Lexer method)
Style (built-in class)
style.rebuild() (built-in function)
subblock_lexer() (Lexer method)
subpixel (transform property)
subsurface() (renpy.Render method)
T
take() (Style method)
text_align (style property)
thumb (style property)
thumb_offset (style property)
thumb_shadow (style property)
Toggle() (InputValue method)
top (variable)
top_bar (style property)
top_gutter (style property)
top_margin (style property)
top_padding (style property)
topleft (variable)
topright (variable)
Transform (built-in class)
transform_anchor (transform property)
translate_define() (built-in function)
translate_font() (built-in function)
truecenter (variable)
U
u (text tag)
underline (style property)
unhovered() (Action method)
unscrollable (style property)
update() (Transform method)
V
vert (text tag)
vertical (style property)
visit() (renpy.Displayable method)
voice (HistoryEntry attribute)
vpunch (variable)
vspace (text tag)
W
w (text tag)
what
(HistoryEntry attribute)
what_args (HistoryEntry attribute)
who
(HistoryEntry attribute)
who_args (HistoryEntry attribute)
window_args (HistoryEntry attribute)
wipeleft (variable)
word() (Lexer method)
X
xalign (style property)
(transform property)
xanchor (style property)
(transform property)
xcenter (style property)
(transform property)
xfill (style property)
xfit (style property)
xmargin (style property)
xmaximum (style property)
xminimum (style property)
xoffset (style property)
(transform property)
xpadding (style property)
xpan (transform property)
xpos (style property)
(transform property)
xsize (style property)
xspacing (style property)
xtile (transform property)
xysize (style property)
xzoom (transform property)
Y
yalign (style property)
(transform property)
yanchor (style property)
(transform property)
ycenter (style property)
(transform property)
yfill (style property)
yfit (style property)
ymargin (style property)
ymaximum (style property)
yminimum (style property)
yoffset (style property)
(transform property)
ypadding (style property)
ypan (transform property)
ypos (style property)
(transform property)
ysize (style property)
yspacing (style property)
ytile (transform property)
yzoom (transform property)
Z
zoom (transform property)
zoom() (renpy.Render method)
zoomin (variable)
zoominout (variable)
zoomout (variable)