Component:ColliderUserTracker: Difference between revisions

From Resonite Wiki
No edit summary
Slight grammar change and a usage addition for its most common usage pattern
Line 8: Line 8:
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".
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".


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


<!--T:2-->
<!--T:2-->
Line 24: Line 24:
{{stub}}
{{stub}}


<!--T:4-->
<!--T:4-->This component can be very useful in defining zones in a world for various features, the most common of which is using the IsLocalUserInside bool to drive the Enabled state on various slots to work as a culling system.
 
== Examples ==
== Examples ==
{{stub}}
{{stub}}

Revision as of 02:16, 25 July 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


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".

As this component works on 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
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

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


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

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.