core.script_api:input_bool()

Ask user to answer a yes/no question.

Usage

Source

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

Parameters

query: str

Question to ask the user.

timeout: float or None = None

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

default_value: str = "yes"

Value to return if timeout occurs. Default is yes.

Returns

bool

True if the user answers yes, False otherwise.