Fixes #18740, added the missing documentation for B parameter on Trigger. #18914
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
alice-i-cecile
added
C-Docs
MrGVSV
reviewed
Apr 24, 2025
Comment on lines
+31
to
+33
| /// See [Trigger::propagate] for more information. It also provides a [Bundle] type representing a set of | ||
| /// components associated with the triggered event. This would be useful to access the components or data | ||
| /// that are related to the event. |
There was a problem hiding this comment.
Part of the confusion I was having with the B parameter is that it doesn't seem to filter its contained components by default. Instead, I believe there is some extra step needed when defining the observer such that it can actually be used. I think pointing users to that method(s) and explaining how to use it could be a bit more useful.
Comment on lines
+31
to
+33
| /// See [Trigger::propagate] for more information. It also provides a [Bundle] type representing a set of | ||
| /// components associated with the triggered event. This would be useful to access the components or data | ||
| /// that are related to the event. |
There was a problem hiding this comment.
We should probably also mention how this bundle parameter will filter out entities that don't contain all components in the bundle (it could be the other way around, I forget haha)
Comment on lines
+29
to
+30
| /// A type that encapsulates information about a triggered [Event] during a specific [Observer] run. It includes | ||
| /// the [Event] data, the corresponding [Entity] that triggered it, and details about event propagation. |
There was a problem hiding this comment.
Two minor nitpicks:
- The links should probably continue to use the backticks to indicate to the user that these are in fact traits/types
- Normally we recommend an empty line after the first sentence/summary
alice-i-cecile
added
S-Waiting-on-Author
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.
Objective
Bparameter onTrigger#18740Solution
Testing