From b2725cb4b9127c3b3af05af386a74f774e4cd3cd Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 25 Feb 2021 15:12:43 +0100 Subject: [PATCH] Improve the `OS.get_environment()`/`OS.set_environment()` documentation (cherry picked from commit 355803db1bfb98c733d8b46dddd19b2be6949ac8) --- core/bind/core_bind.cpp | 6 +++--- doc/classes/OS.xml | 15 +++++++++------ 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/core/bind/core_bind.cpp b/core/bind/core_bind.cpp index 22de9d8ac35..58fb44d2cce 100644 --- a/core/bind/core_bind.cpp +++ b/core/bind/core_bind.cpp @@ -1347,9 +1347,9 @@ void _OS::_bind_methods() { ClassDB::bind_method(D_METHOD("shell_open", "uri"), &_OS::shell_open); ClassDB::bind_method(D_METHOD("get_process_id"), &_OS::get_process_id); - ClassDB::bind_method(D_METHOD("get_environment", "environment"), &_OS::get_environment); - ClassDB::bind_method(D_METHOD("set_environment", "environment", "value"), &_OS::set_environment); - ClassDB::bind_method(D_METHOD("has_environment", "environment"), &_OS::has_environment); + ClassDB::bind_method(D_METHOD("get_environment", "variable"), &_OS::get_environment); + ClassDB::bind_method(D_METHOD("set_environment", "variable", "value"), &_OS::set_environment); + ClassDB::bind_method(D_METHOD("has_environment", "variable"), &_OS::has_environment); ClassDB::bind_method(D_METHOD("get_name"), &_OS::get_name); ClassDB::bind_method(D_METHOD("get_cmdline_args"), &_OS::get_cmdline_args); diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 9ede31bffbb..2278835f381 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -222,10 +222,11 @@ - + - Returns an environment variable. + Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist. + [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -643,10 +644,11 @@ - + - Returns [code]true[/code] if an environment variable exists. + Returns [code]true[/code] if the environment variable with the name [code]variable[/code] exists. + [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. @@ -917,12 +919,13 @@ - + - Change the value of an environment variable. + Sets the value of the environment variable [code]variable[/code] to [code]value[/code]. The environment variable will be set for the Godot process and any process executed with [method execute] after running [method set_environment]. The environment variable will [i]not[/i] persist to processes run after the Godot process was terminated. + [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows.