summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-05-09 13:23:53 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-05-09 13:23:53 +0200
commit7350f90c579ce6db0be3cf67175778546459322e (patch)
tree8369dedf0d84eabed8dd0a08e1e0c977da0076ba /doc
parent7050e4d3077c278bda35d21ed60d7068cc4bc9e9 (diff)
Document caveats of `OS.get_unique_id()`
Diffstat (limited to 'doc')
-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>