diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-09-16 13:18:32 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-09-16 13:18:32 +0200 |
| commit | 55bed82b0541c5dbefcf402cc0974fe5d05e7576 (patch) | |
| tree | 4fbb6b2de0149fa74f6038408fb930b57def2d34 /doc/classes | |
| parent | bda63e1b5aa420617259f151a0570ca0780c0c7d (diff) | |
| parent | ac9786c52534cc98c107edf568656f33a81fa2a0 (diff) | |
Merge pull request #65525 from MJacred/os/distribution
Add get_distribution_name() and get_version() to OS
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/OS.xml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 059766656f..54f31d7918 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -216,6 +216,15 @@ Not to be confused with [method get_user_data_dir], which returns the [i]project-specific[/i] user data path. </description> </method> + <method name="get_distribution_name" qualifiers="const"> + <return type="String" /> + <description> + Returns the name of the distribution for Linux and BSD platforms (e.g. Ubuntu, Manjaro, OpenBSD, etc.). + Returns the same value as [method get_name] for stock Android ROMs, but attempts to return the custom ROM name for popular Android derivatives such as LineageOS. + Returns the same value as [method get_name] for other platforms. + [b]Note:[/b] This method is not supported on the web platform. It returns an empty string. + </description> + </method> <method name="get_environment" qualifiers="const"> <return type="String" /> <param index="0" name="variable" type="String" /> @@ -430,6 +439,18 @@ Not to be confused with [method get_data_dir], which returns the [i]global[/i] (non-project-specific) user home directory. </description> </method> + <method name="get_version" qualifiers="const"> + <return type="String" /> + <description> + Returns the exact production and build version of the operating system. This is different from the branded version used in marketing. This helps to distinguish between different releases of operating systems, including minor versions, and insider and custom builds. + For Windows, the major and minor version are returned, as well as the build number. For example, the returned string can look like [code]10.0.9926[/code] for a build of Windows 10, and it can look like [code]6.1.7601[/code] for a build of Windows 7 SP1. + For rolling distributions, such as Arch Linux, an empty string is returned. + For macOS and iOS, the major and minor version are returned, as well as the patch number. + For UWP, the device family version is returned. + For Android, the SDK version and the incremental build number are returned. If it's a custom ROM, it attempts to return its version instead. + [b]Note:[/b] This method is not supported on the web platform. It returns an empty string. + </description> + </method> <method name="has_environment" qualifiers="const"> <return type="bool" /> <param index="0" name="variable" type="String" /> |