Document typed dictionaries and arrays in the class reference #107071
Conversation
This file contains hidden or 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
Member
Calinou
commented
Jun 3, 2025
Calinou
commented
- This closes Add documentation about Typed Dictionaries godot-docs#10981.
Calinou
added
enhancement
documentation
cherrypick:4.4
Calinou
commented
Jun 3, 2025
|
|
||
| // This array can only contain integers. | ||
| // Attempting to add any other type will result in an error. | ||
| Godot.Collections.Array<int> typedArray = [1, 2, 3]; |
There was a problem hiding this comment.
Is this valid C# syntax, or do we need to go the long way and use new Godot.Collections.Array for the righthand side?
There was a problem hiding this comment.
Godot.Collections.Array implements IEnumerable and has an Add method with an appropriate signature, so it should be able to support this syntax (which is called "collection expressions". added in C# 12).
Although this is a somewhat recent addition to C#, so it might be better to avoid using it.
|
Hold on. See also: |
Mickeon
reviewed
Jun 3, 2025
| @@ -4,7 +4,7 @@ | |||
| A built-in data structure that holds a sequence of elements. | |||
| </brief_description> | |||
| <description> | |||
| An array data structure that can contain a sequence of elements of any [Variant] type. Elements are accessed by a numerical index starting at [code]0[/code]. Negative indices are used to count from the back ([code]-1[/code] is the last element, [code]-2[/code] is the second to last, etc.). | |||
| An array data structure that can contain a sequence of elements of any [Variant] type (untyped array), or a specific type (typed array). Elements are accessed by a numerical index starting at [code]0[/code]. Negative indices are used to count from the back ([code]-1[/code] is the last element, [code]-2[/code] is the second to last, etc.). | |||
There was a problem hiding this comment.
I can't look more in-depth as of writing this, but I would not add these parenthesis. Rather, I'd expand briefly on what a typed array is with a new sentence.
GlitchedCode922
approved these changes
Jun 9, 2025
| # Attempting to use any other type for keys or values will result in an error. | ||
| var typed_dict: Dictionary[String, int] = { | ||
| "some_key": 1, | ||
| "some_other_key": 2 |
There was a problem hiding this comment.
Suggested change
| "some_other_key": 2 | |
| "some_other_key": 2, |
Per the style guide
| # Attempting to use any other type for keys will result in an error. | ||
| var typed_dict_key_only: Dictionary[String, Variant] = { | ||
| "some_key": 12.34, | ||
| "some_other_key": "string" |
There was a problem hiding this comment.
Suggested change
| "some_other_key": "string" | |
| "some_other_key": "string", |
| // Attempting to use any other type for keys or values will result in an error. | ||
| var typedDict = new Godot.Collections.Dictionary<String, int> { | ||
| {"some_key", 1}, | ||
| {"some_other_key", 2} |
There was a problem hiding this comment.
Suggested change
| {"some_other_key", 2} | |
| {"some_other_key", 2}, |
| // Attempting to use any other type for keys will result in an error. | ||
| var typedDictKeyOnly = new Godot.Collections.Dictionary<String, Variant> { | ||
| {"some_key", 12.34}, | ||
| {"some_other_key", "string"} |
There was a problem hiding this comment.
Suggested change
| {"some_other_key", "string"} | |
| {"some_other_key", "string"}, |
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.