Component:ColliderUserTracker: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page ColliderUserTracker (Component) to Component:ColliderUserTracker: Creating component Namespace
Automated: update Fields, Categories
Line 11: Line 11:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|IsLocalUserInside|Bool| Becomes set for the local user if the local user is within the collider of the object that this component is attached to.
|TriggersOnly|Bool|
|IsAnyUserInside|Bool| Becomes set for all users if any user is within the collider of the object that this component is attached to.
|IsLocalUserInside|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Becomes set for the local user if the local user is within the collider of the object that this component is attached to.
|NumberOfUsersInside|Int| Tracks the number of users inside the collider of the object that this component is attached to.
|IsAnyUserInside|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Becomes set for all users if any user is within the collider of the object that this component is attached to.
|_usersInside|SyncBag`1|TypeString3=SyncBag<UserRef>| Data on the users that are inside the collider of the object that this component is attached to.
|NumberOfUsersInside|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv3=true| Tracks the number of users inside the collider of the object that this component is attached to.
|_usersInside|{{RootFieldType|SyncBag`1|[[Type:UserRef|UserRef]]}}|TypeAdv4=true| Data on the users that are inside the collider of the object that this component is attached to.
}}
}}


Line 26: Line 27:


[[Category:ComponentStubs]]
[[Category:ComponentStubs]]
[[Category:Components|Collider User Tracker]]
[[Category:Components:Physics:Utility{{#translation:}}|Collider User Tracker]]
[[Category:Components:Physics:Utility|Collider User Tracker]]
[[Category:Components{{#translation:}}|Collider User Tracker]]

Revision as of 20:59, 3 March 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 of type Trigger. The collider should be of type Trigger because that collider type will detect collisions with users (as long as they are not in noclip locomotion mode).

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.


Examples

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