


confirm If true and not at the main menu, prompt for confirmation before loading the file. FileLoad ( name, confirm=True, page=None, newest=True ) link confirm If true, prompts before deleting a file. FileDelete ( name, confirm=True, page=None ) linkĭeletes the file. Other keyword arguments are passed to FileLoad or FileSave. page The page that the file will be saved to or loaded from. (a large number based on the current time) will be used. name The name of the slot to save to or load from. Load screen is showing (current screen is named "load"), and saving FileAction ( name, page=None, **kwargs ) link

If None, the page is determinedĪutomatically, based on a persistent page number. It'sĬombined with the page to create the filename. These actions handle saving, loading, and deleting of files. Start("foo") - Start at the "foo" label.The main use of this is to start a new game from the ShowMenu without an argument will enter the game menu at theĭefault screen, taken from _game_menu_screen.Įxtra arguments and keyword arguments are passed on to the screen Start ( label=u'start' ) linkĬauses Ren'Py to jump out of the menu context to the named ForĮxample, if one has a "stats" screen defined, one can This can also be used to show user-defined menu screens. Is appended to it, and that label is jumped to. If the screen doesn't exist, then "_screen" Screen is usually the name of a screen, which is shown using If weĪre in the game menu, then this shows a screen or jumps to a label. ShowMenu ( screen=None, *args, **kwargs ) linkĬauses us to enter the game menu, if we're not there already. confirm If true, prompts the user if he wants to quit, rather Return to the main menu, rather than returning confirm If true, causes Ren'Py to ask the user if he wishes to MainMenu ( confirm=True ) linkĬauses Ren'Py to return to the main menu.

These actions invoke menus, or are primarily useful while in the main false_value If not None, then this is the false value we use. true_value If not None, then this is the true value we use. ToggleVariable ( variable, true_value=None, false_value=None ) link In theĬase of a list, new items are appended. Otherwise, it is removed.īuttons with this action are marked as selected if and only if the Toggles the value of the variable name in the current screen. ToggleScreenVariable ( name, true_value=None, false_value=None ) link Value of that field when the action is performed. ToggleField ( object, field, true_value=None, false_value=None ) link ToggleDict ( dict, key, true_value=None, false_value=None ) link SetVariable ( variable, value ) linkĬauses variable to be set to value. SetScreenVariable ( name, value ) linkĬauses the variable name associated with the current screen toīe set to value. object is the object, field is a string giving the name of theįield to set, and value is the value to set it to. SetField ( object, field, value ) linkĬauses the a field on an object to be set to a given value. SetDict ( dict, key, value ) linkĬauses the value of key in dict to be set to value. This may be a python set or list, in whichĬase the value is appended to the list. AddToSet ( set, value ) linkĪdds value to set. If not None, transition is use to show and hide the screen. Shown, the screen is shown with the provided arguments. ToggleScreen ( screen, transition=None, *args, **kwargs ) link If not None, transition is use to show the new screen. ShowTransient ( screen, transition=None, *args, **kwargs ) link None in this case.) Show ( screen, transition=None, *args, **kwargs ) link When in a menu, this returns from the menu. Was called using the call screen statement, the return value Select what the return value of the interaction is. This is often used with menus and imagemaps, to Return ( value=None ) linkĬauses the current interaction to return the supplied value, which This can be used to make a button responsive to hover/unhover events, Jump ( label ) linkĬauses control to transfer to label. transition If not None, a transition that occurs when hiding the screen. This causes the screen named screen to be hidden, if it is shown. Keyword arguments are passed to renpy.call(). Call ( label, *args, **kwargs ) linkĮnds the current statement, and calls label. These are actions that manage screens, interaction results, and control flow. Image Gallery, Music Room, and Replay Actions.
