diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-09-13 18:37:11 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-09-13 18:37:11 +0200 |
| commit | 8b5bb7eeeaf666dc7bb390a16599c6674d34a8ed (patch) | |
| tree | b54125263c31ee4e72ee8bdf858c23419b6f9bc3 /doc | |
| parent | f6b36f54e50cff518b4085cf665405ad1b5f6d44 (diff) | |
[OS] Expose get_stdin_string to Scripting.
Exposed as read_string_from_stdin so it's clear it's not retrieving a
property.
The method is kept with the block parameter, but a note is added to the
docs specifying that is not implemented on any platform (should we just
remove it?).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/OS.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 059766656f..56fd4ade47 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -517,6 +517,14 @@ [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> + <method name="read_string_from_stdin"> + <return type="String" /> + <param index="0" name="block" type="bool" default="true" /> + <description> + Reads a user input string from the standard input (usually the terminal). + [b]Note:[/b] This method is implemented on Linux, macOS and Windows. Non-blocking reads are not currently supported on any platform. + </description> + </method> <method name="request_permission"> <return type="bool" /> <param index="0" name="name" type="String" /> |