From 8b5bb7eeeaf666dc7bb390a16599c6674d34a8ed Mon Sep 17 00:00:00 2001
From: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
Date: Tue, 13 Sep 2022 18:37:11 +0200
Subject: [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?).
---
 doc/classes/OS.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'doc/classes')

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" />
-- 
cgit v1.2.3