core.script_api:input_numerical()

Ask user to answer a yes/no question.

Usage

Source

core.script_api:input_numerical(
    query,
    timeout=None,
    default_value=0.0,
    min_value=-100000000000.0,
    max_value=100000000000.0,
    step=1.0,
    decimals=2,
)

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: float = 0.0

Value to return if timeout occurs. Default is 0.0.

min_value: float = -100000000000.0

Minimal input value. Default is -1e9

max_value: float = 100000000000.0

Maximum input value. Default is 1e9

step: float = 1.0

Allowed steps between user input values. Default is 1.0

decimals: int = 2

Number of decimals of the input number

Returns

float

numerical user input value.