Component:ColliderUserTracker

Component image 

Collider User Tracker component as seen in the Scene Inspector

The ColliderUserTracker keeps track of users who enter and leave a collider. It must be used on a Slot that also has an attached Collider whose type is set to "Trigger", unless TriggersOnly is set to false.

As this component works using colliders, it cannot detect users in No-Clip.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled.
TriggersOnly	Bool	Whether to only allow use of Triggers or not.
IsLocalUserInside	raw output of Bool	Becomes set for the local user if the local user is within the collider of the object that this component is attached to.
IsAnyUserInside	raw output of Bool	Becomes set for all users if any user is within the collider of the object that this component is attached to.
NumberOfUsersInside	raw output of Int	Tracks the number of users inside the collider of the object that this component is attached to.
_usersInside	direct SyncBag`1<UserRef>	Data on the users that are inside the collider of the object that this component is attached to.

Usage

Attach this component to a slot, and add a Collider to the slot. The component will then start functioning as long as the Collider is a trigger or as long as TriggersOnly is set to false.

Examples

This component can be very useful in defining zones in a world for various features, the most common of which is using the IsLocalUserInside to drive the Enabled state on various slots to work as a culling system.