

Toggles the value of the variable called name in the current screen. ToggleScreenVariable ( name, true_value=None, false_value=None ) link false_value If not None, then this is the false value used. true_value If not None, then this is the true value used. In - it can't be passed in from somewhere else. ToggleScreenVariable() should be preferred, as it allows more Toggles the value of the variable called name in the current local context. ToggleLocalVariable ( name, true_value=None, false_value=None ) link 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. Value of that field when the action is performed. ToggleField ( object, field, true_value=None, false_value=None ) link Toggling means to invert the value when the action is performed. Lists, in which case key is the index of the value to toggle. ToggleDict ( dict, key, true_value=None, false_value=None ) link One with dots separating the variable from fields, like "hero.strength" The name argument must be a string, and can be a simple name like "strength", or SetVariable ( name, value ) linkĬauses the variable called name to be set to value. To set variables within a used screen, and only in thatĬase, use SetLocalVariable() instead. Of the screen containing the used one(s). In a used screen, this action sets the variable in the context SetScreenVariable ( name, value ) linkĬauses the variable called name associated with the current screen This must be created in the context that the variable is set SetScreenVariable() should be preferred, as it allows more This function is only useful in a screen that has been used byĪnother screen, as it provides a way of setting the value of a SetLocalVariable ( name, value ) linkĬauses the variable called name to be set to value in the current 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. This also works with lists, where key is the index at which 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 This action takes the _layer, _zorder and _tag keywordĪrguments, which have the same meaning as in the If not None, transition is used to show the new screen. 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, given as a string. _layer This is passed as the layer argument to renpy.hide_screen(). transition If not None, a transition that occurs when hiding the screen. screen Either a string giving the name of the screen to be hidden, or This causes a screen to be hidden if it is shown. Hide ( screen=None, transition=None, _layer=None ) link Call ( label, *args, **kwargs ) linkĮnds the current statement, and calls label, given as a string.Īrguments and keyword arguments are passed to renpy.call().

These are actions that manage screens, interaction results, and control flow.
