Skip to content

Prop arrays docs#63

Merged
tudddorrr merged 2 commits intomainfrom
prop-arrays
Mar 27, 2026
Merged

Prop arrays docs#63
tudddorrr merged 2 commits intomainfrom
prop-arrays

Conversation

@tudddorrr
Copy link
Copy Markdown
Contributor

No description provided.

@tudddorrr tudddorrr added the enhancement New feature or request label Mar 21, 2026
@claude
Copy link
Copy Markdown

claude bot commented Mar 21, 2026

Documentation Review -- PR #63: Prop arrays docs

This PR adds clear, well-structured documentation for prop arrays and fills in missing code examples for existing prop functions. The character limit callouts and update parameter explanation are great additions.


Clarity and Readability

The "Setting props" code block conflates two separate examples

The current block (identical in both Unity and Godot) looks like sequential code but actually contains two independent examples. If read sequentially, level is set and synced, then immediately set again (no sync) to the same value -- which is redundant and confusing.

Suggested fix -- split into two distinct examples:

Talo.current_player.set_prop("level", "5")

Talo.current_player.set_prop("level", "5", false)
Talo.current_player.set_prop("class", "warrior", false)
Talo.current_player.set_prop("xp", "1200")

Accuracy and Completeness

"Inserting into prop arrays" -- ambiguous behaviour for non-existent arrays

"Use insert_into_prop_array() to add a single value to an existing prop array."

The word "existing" raises an immediate question: what happens if the array has not been created yet? A developer starting from scratch would naturally reach for insert_into_prop_array first and might get stuck.

  • If it auto-creates: "...to add a single value to a prop array, creating it if it does not already exist."
  • If prior creation is required: add a note pointing to set_prop_array().

Code Examples

Ambiguous constraint in set_prop_array docs

"Duplicate and empty values are ignored. The array must not be empty."

It is unclear whether "must not be empty" refers to the raw input or the array after filtering. For example, would ["sword", "sword"] be valid (resulting in ["sword"]), or would it be rejected?

Suggested: "Duplicate and empty values are ignored. The resulting array (after filtering) must not be empty."


Everything else looks good

Structure, cross-references, GDScript and C# syntax, the :::info callout about [] key suffixes, and the character limit additions are all clear and accurate.

@tudddorrr tudddorrr removed the enhancement New feature or request label Mar 22, 2026
@tudddorrr tudddorrr merged commit 163cc9d into main Mar 27, 2026
1 check passed
@tudddorrr tudddorrr deleted the prop-arrays branch March 27, 2026 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant