Added observability events and reviewed docs and code. - #59
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds manager-level change-notification events for effects, abilities, and tags to improve observability (UI/analytics/combat logs), updates documentation to explain the new notifications and Statescript concepts, and renames the quaternion concatenate resolver for clarity.
Changes:
- Introduced new effects lifecycle notifications on
EffectsManager(applied/executed/added/changed/removed/stack-denied) and ability lifecycle notifications onEntityAbilities(granted/changed/removed/activated/activation-failed). - Made tag changes externally observable via
EntityTags.OnTagsChangedand added new test coverage for tags/effects/abilities notification behavior. - Renamed
ConcatenateResolvertoQuaternionConcatenateResolverand updated related docs/tests.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Tightens/condenses project description wording. |
| Forge/Statescript/Properties/QuaternionConcatenateResolver.cs | Renames resolver type and updates exception message accordingly. |
| Forge/Effects/EffectsManager.cs | Adds effect lifecycle notification events and invokes them throughout the pipeline. |
| Forge/Core/EntityTags.cs | Exposes OnTagsChanged publicly with clarified lifecycle remarks. |
| Forge/Core/EntityAbilities.cs | Adds ability lifecycle notification events and makes GrantedAbilities read-only to external callers. |
| Forge/Abilities/Ability.cs | Emits activation-failure and activation-start notifications via EntityAbilities. |
| Forge.Tests/Tags/EntityTagsEventTests.cs | Adds tests for EntityTags.OnTagsChanged semantics. |
| Forge.Tests/Statescript/Resolvers/QuaternionConcatenateResolverTests.cs | Updates resolver tests to use the renamed class. |
| Forge.Tests/Effects/EffectsManagerEventsTests.cs | Adds tests validating effect notification sequencing and payloads. |
| Forge.Tests/Abilities/EntityAbilitiesEventsTests.cs | Adds tests validating ability notification sequencing and payloads. |
| docs/tags.md | Documents reacting to tag changes via OnTagsChanged. |
| docs/statescript/resolvers/README.md | Updates resolver index entry for renamed quaternion concatenate resolver. |
| docs/statescript/resolvers/quaternion-concatenate-resolver.md | Renames and clarifies quaternion concatenate resolver documentation. |
| docs/statescript/resolvers/conjugate-resolver.md | Updates examples/links to renamed resolver. |
| docs/statescript/custom-resolvers.md | Adds guidance for implementing object-lane resolvers. |
| docs/README.md | Tweaks link text for main README reference. |
| docs/quick-start.md | Adds a Statescript introduction and expands “next steps” links. |
| docs/effects/stacking.md | Documents OnEffectStackDenied for stacking-driven denials. |
| docs/effects/README.md | Documents effect change notifications and updates removal example. |
| docs/cues.md | Clarifies cues vs Events system vs change notifications. |
| docs/abilities.md | Documents ability change notifications and updates GrantedAbilities type/semantics. |
💡 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
Changed