World Utilities / Player
Trigger Volume
Calls Udon events when players enter or leave an area.
since v0.2.0
| Component | Add Component menu / prefab | Source |
|---|---|---|
Player Trigger VolumeVRCTools.World.Player.PlayerTriggerVolume
|
Player › Trigger Volume
|
PlayerTriggerVolume.cs ↗ |
Turns a trigger collider into a zone that reacts to players entering and leaving it - ideal for room specific audio, lighting changes, teleport pads or “you are now entering…” signs.
Parameters
| Parameter | Default | Description |
|---|---|---|
| Enter Events | empty | Behaviour + event name pairs called when a player enters. |
| Exit Events | empty | Behaviour + event name pairs called when a player leaves. |
| Accepted Player Types | All |
Advanced. Which players trigger the volume: None, LOCAL, REMOTE or All. |
Requires a Collider on the same game object with Is Trigger enabled.
Events
| Event | Description |
|---|---|
EVENT_PLAYER_ENTER |
An accepted player entered the volume. |
EVENT_PLAYER_EXIT |
An accepted player left the volume. |
Scripts can read LastPlayer (a VRCPlayerApi) to find out who caused the most recent event.
Trigger events run on every client for every player that enters. With
Accepted Player Typesset toAll, one player walking in calls your events on everybody’s client. UseLOCALfor anything that should only affect the player who entered (teleports, local audio, UI) - that is what you want most of the time.