core.script_api:input()

Ask user to provide some free text input.

Usage

Source

core.script_api:input(
    query,
    timeout=None,
    default_value="",
)

Parameters

query: str

Query string presented to the user so they know what to enter.

timeout: float or None = None

Max. time in seconds to wait for user input (default=None, no timeout).

default_value: str = ""

Value to return if timeout occurs. Default is empty string.

Returns

str

User input.