Skip to content

docs: clarify result.trigger?.entity vs result.triggeredEntity in TriggerArea #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
decentraland-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify result.trigger?.entity vs result.triggeredEntity in TriggerArea #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions creator/sdk7/3d-essentials/trigger-areas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,17 @@ The following properties are available in the `result` parameter:
* `rotation`: The rotation of the entity that triggered the trigger
* `scale`: The scale of the entity that triggered the trigger

{% hint style="warning" %}
**⚠️ Common confusion — `triggeredEntity` vs `result.trigger?.entity`**

These two fields are easily mixed up:

* **`result.trigger?.entity`** — the entity that **walked into** the trigger area (Entity B — this is usually what you want to check, e.g. to identify which player or object entered).
* **`result.triggeredEntity`** — the entity that **owns the TriggerArea component** (Entity A — the static trigger zone itself, not the entity that entered it).

Despite the name, `triggeredEntity` does **not** refer to the entity that triggered the event. It refers to the entity whose trigger area was activated. Use `result.trigger?.entity` when you need to identify the entering entity.
{% endhint %}

```ts
import { engine, Transform, TriggerArea, triggerAreaEventsSystem } from '@dcl/sdk/ecs'

Expand Down