summaryrefslogtreecommitdiff
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-05-09 14:28:19 +0200
committerGitHub <noreply@github.com>2021-05-09 14:28:19 +0200
commit009674e5d5b8a72f48f83dea2d93eb5268eabed7 (patch)
treeac25c7dab10538e1e6c3f45f542d00f42c9c4f1f /doc/classes/OS.xml
parenta8a51cd75c94268b7ca8fa1a82a144fd9da9d69e (diff)
parent7350f90c579ce6db0be3cf67175778546459322e (diff)
Merge pull request #48583 from Calinou/doc-os-get-unique-id-caveats
Document caveats of `OS.get_unique_id()`
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index d997073849..cb95deb9a0 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -348,6 +348,7 @@
</return>
<description>
Returns a string that is unique to the device.
+ [b]Note:[/b] This string may change without notice if the user reinstalls/upgrades their operating system or changes their hardware. This means it should generally not be used to encrypt persistent data as the data saved prior to an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by [method get_unique_id] for security purposes.
[b]Note:[/b] Returns an empty string on HTML5 and UWP, as this method isn't implemented on those platforms yet.
</description>
</method>