Clarify identical hash() return values due to collisions

This commit is contained in:
Hugo Locurcio 2022-02-12 22:17:35 +01:00
parent d3a6b6daaa
commit 08541fe11d
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
4 changed files with 8 additions and 5 deletions

View file

@ -259,7 +259,7 @@
<method name="hash" qualifiers="const">
<return type="int" />
<description>
Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value:
Returns a hashed 32-bit integer value representing the dictionary contents. This can be used to compare dictionaries by value:
[codeblocks]
[gdscript]
var dict1 = {0: 10}
@ -276,6 +276,7 @@
[/csharp]
[/codeblocks]
[b]Note:[/b] Dictionaries with the same keys/values but in a different order will have a different hash.
[b]Note:[/b] Dictionaries with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values does [i]not[/i] imply the dictionaries are equal, because different dictionaries can have identical hash values due to hash collisions.
</description>
</method>
<method name="is_empty" qualifiers="const">