diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-02-25 15:55:53 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-25 15:55:53 +0100 |
| commit | 4d0f01a78631b7815160dbc29da1ead6fdb4e45b (patch) | |
| tree | 1081cd7f0df185e31d512e91b9d8381e848ee3a1 | |
| parent | 58cb152565c9119a0e5732c26d4caa535a586279 (diff) | |
| parent | 355803db1bfb98c733d8b46dddd19b2be6949ac8 (diff) | |
Merge pull request #46418 from Calinou/doc-os-environment
Improve the `OS.get_environment()`/`OS.set_environment()` documentation
| -rw-r--r-- | core/core_bind.cpp | 6 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 15 |
2 files changed, 12 insertions, 9 deletions
diff --git a/core/core_bind.cpp b/core/core_bind.cpp index 457a110054..4845f5f1ae 100644 --- a/core/core_bind.cpp +++ b/core/core_bind.cpp @@ -715,9 +715,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 6a59f24ac2..de3e9a8e10 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -207,10 +207,11 @@ <method name="get_environment" qualifiers="const"> <return type="String"> </return> - <argument index="0" name="environment" type="String"> + <argument index="0" name="variable" type="String"> </argument> <description> - 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. </description> </method> <method name="get_executable_path" qualifiers="const"> @@ -383,10 +384,11 @@ <method name="has_environment" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="environment" type="String"> + <argument index="0" name="variable" type="String"> </argument> <description> - 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. </description> </method> <method name="has_feature" qualifiers="const"> @@ -504,12 +506,13 @@ <method name="set_environment" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="environment" type="String"> + <argument index="0" name="variable" type="String"> </argument> <argument index="1" name="value" type="String"> </argument> <description> - 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. </description> </method> <method name="set_thread_name"> |