summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-10-03 14:08:00 +0200
committerGitHub <noreply@github.com>2022-10-03 14:08:00 +0200
commit04a28763c01e88f6e5758d3182810a6a7ddab4e9 (patch)
tree3742a3541912151f7321bfd61f0747bc35cad0ce /doc/classes
parent9e50007df60defa9b2222621edb298ddf06472a4 (diff)
parent8b5bb7eeeaf666dc7bb390a16599c6674d34a8ed (diff)
Merge pull request #65751 from Faless/os/4.x_expose_read_from_stdin
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/OS.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 313f3ab6db..a3fd27c00f 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -544,6 +544,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" />