Document typed dictionaries in GDScript #10747
Open
+56
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
added
enhancement
topic:gdscript
area:manual
mhilbrunner
approved these changes
Mar 5, 2025
Piralein
reviewed
Mar 5, 2025
| Typed dictionaries have the syntax ``Array[KeyType, ValueType]``, where ``KeyType`` and ``ValueType`` | ||
| can be any ``Variant`` type, native or user class, or enum. Both the key and value type **must** be specified, | ||
| but you can use ``Variant`` to make either of them untyped. | ||
| Nested dictionary types (like ``Dictionary[String, Dictionary[String, int]]``) |
There was a problem hiding this comment.
The error message thrown says Nested typed collections are not supported., this includes both Dictionary and Array.
It could be misunderstood as "Dictionary" as a type cant be used, instead of typed dictionary.
Suggested change
| Nested dictionary types (like ``Dictionary[String, Dictionary[String, int]]``) | |
| Nested typed collections (like ``Dictionary[String, Dictionary[String, int]]``) |
The wording in the typed array section should probably be updated, too.
same with static_typing.rst line 242
idbrii
reviewed
Mar 10, 2025
| keys or values. The GDScript static analyzer takes typed dictionaries into account. However, | ||
| dictionary methods that return values still have the ``Variant`` return type. | ||
|
|
||
| Typed dictionaries have the syntax ``Array[KeyType, ValueType]``, where ``KeyType`` and ``ValueType`` |
There was a problem hiding this comment.
Based on the other files it looks like Array is a typo here. Should it be:
Typed dictionaries have the syntax ``Dictionary[KeyType, ValueType]``
idbrii
reviewed
Mar 10, 2025
| A dictionary's value type applies to ``for`` loop variables, as well as some operators like | ||
| ``[]`` and ``[]=``. Dictionary methods that return values and other operators | ||
| (such as ``==``) are still untyped. Built-in types, native and custom classes, | ||
| and enums may be used as element types. Nested array types |
There was a problem hiding this comment.
Suggested change
| and enums may be used as element types. Nested array types | |
| and enums may be used as element types. Nested dictionary types |
idbrii
reviewed
Mar 10, 2025
| var vehicles: Dictionary[String, Node] = { "car": $Car, "plane": $Plane } | ||
| var item_tiles: Dictionary[Vector2i, Item] = { Vector2i(0, 0): Item.new(), Vector2i(0, 1): Item.new() } | ||
| var dictionary_of_dictionaries: Dictionary[String, Dictionary] = { { } } | ||
| # var arrays: Dictionary[String, Dictionary[String, int]] -- disallowed |
There was a problem hiding this comment.
Suggested change
| # var arrays: Dictionary[String, Dictionary[String, int]] -- disallowed | |
| # var dicts: Dictionary[String, Dictionary[String, int]] -- disallowed |
idbrii
reviewed
Mar 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is copied (and adapted) from the related array documentation.