renpy.input - Ren'Py Visual Novel Engine

documentation index ◦ reference manual ◦ function index

# renpy.input

Function: | renpy.input | (prompt, default=, allow=None, exclude='{}', length=None, with_none=None):

This pops up a window requesting that the user enter in some text. It returns the entered text.

prompt - A prompt that is used to ask the user for the text.

default - A default for the text that this input can return.

length - If given, a limit to the amount of text that this function will return.

allow - If not None, then if an input character is not in this string, it is ignored.

exclude - If not None, then if an input character is in this set, it is ignored.

with_none - If True, causes a "with None" statement to be run after each interaction. If None (the default), checks config.implicit_with_none to determine if a "with None" should be run.

## Example

    $ name = renpy.input("What is your name?", "Joe User", length=20)

    e "Pleased to meet you, %(name)s."

documentation index ◦ reference manual ◦ function index