docs: clarify result.trigger?.entity vs result.triggeredEntity in TriggerArea#101
Open
decentraland-bot wants to merge 1 commit into
Open
docs: clarify result.trigger?.entity vs result.triggeredEntity in TriggerArea#101decentraland-bot wants to merge 1 commit into
decentraland-bot wants to merge 1 commit into
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
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.
Summary
The
PBTriggerAreaResultcallback object exposes two fields whose names lead to a very common mistake:result.trigger?.entity— the entity that walked into the trigger area (usually what developers want to check)result.triggeredEntity— the entity that owns the TriggerArea component (the static trigger zone itself)Despite its name,
triggeredEntitydoes not refer to the entity that triggered the event. The name reads as "the entity that triggered it," but it actually means "the entity whose trigger area was activated." This confusion shows up repeatedly in developer questions and is a frequent mistake made when reading or writing scene code.Changes
{% hint style="warning" %}admonition immediately after the field list in the Trigger event responses section that:result.trigger?.entityas the correct field for identifying the entering entityNo other content was changed. The Spanish translation (
creator-esp/) is excluded and will be handled separately.Test plan
{% hint %}block)🤖 Generated with Claude Code