Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a Description field to Statescript nodes (intended for editor tooltips/docs) and standardizes a node name by renaming ExpressionConditionNode to ExpressionNode.
Changes:
- Introduce
Node.Description(virtual) and add/override descriptions on core and concrete node types. - Rename
ExpressionConditionNodetoExpressionNode. - Update unit tests to use the renamed node type.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| Forge/Statescript/Node.cs | Adds base Description property for editor/tooling metadata. |
| Forge/Statescript/Nodes/StateNode.cs | Adds default description for state-node base type. |
| Forge/Statescript/Nodes/State/TimerNode.cs | Adds concrete node description override. |
| Forge/Statescript/Nodes/EntryNode.cs | Adds concrete node description override. |
| Forge/Statescript/Nodes/ExitNode.cs | Adds concrete node description override. |
| Forge/Statescript/Nodes/ConditionNode.cs | Adds default description for condition-node base type. |
| Forge/Statescript/Nodes/Condition/ExpressionNode.cs | Renames ExpressionConditionNode to ExpressionNode and adds description override. |
| Forge/Statescript/Nodes/ActionNode.cs | Adds default description for action-node base type. |
| Forge/Statescript/Nodes/Action/SetVariableNode.cs | Adds concrete node description override. |
| Forge.Tests/Statescript/ExpressionResolverTests.cs | Updates tests to use ExpressionNode. |
Comments suppressed due to low confidence (1)
Forge/Statescript/Nodes/Condition/ExpressionNode.cs:21
- Renaming the public type
ExpressionConditionNodetoExpressionNodeis a breaking API change for any consumers constructing graphs in code. Consider keeping a backwards-compatible shim (e.g., anExpressionConditionNodeclass marked[Obsolete]that forwards toExpressionNode), or using a type-forwarder, so downstream projects don’t break immediately.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Added description field to nodes so editor tools can use that to help users understand what the nodes are used for.
Simplified the name of ExpressionCondition node to Expression node only. Our standard should keep out the words Action, Condition and State from the node names for the sake of simpler names.