Type:UserRef: Difference between revisions

From Resonite Wiki
add type page
 
add some more info
Line 1: Line 1:
User Ref is a nested type usually used to auto fill <code>User</code> [[Type:User|User]] variable when a user rejoins a session with this reference. This works better than a direct [[Type:User|User]] reference, since the user that was referenced by the component can be identified later. The host instantly deletes the [[Type:User|User]] object when a user leaves. making this type for getting a user more worth while for things like overrides and flux.
User Ref is a nested type usually used to auto fill <code>User</code> [[Type:User|User]] variable when a user rejoins a session with this reference. This works better than a direct [[Type:User|User]] reference, since the user that was referenced by the component can be identified later. The host instantly deletes the [[Type:User|User]] object when a user leaves. making this type for getting a user more worth while for things like overrides and flux.


This currently isn't a component you can attach, but it is part of a [[ProtoFlux:Data Model Store|Data Model Store<User>]], so using such flux node will allow persistent user identification.


== Component ==
== Component ==

Revision as of 19:09, 12 May 2024

User Ref is a nested type usually used to auto fill User User variable when a user rejoins a session with this reference. This works better than a direct User reference, since the user that was referenced by the component can be identified later. The host instantly deletes the User object when a user leaves. making this type for getting a user more worth while for things like overrides and flux.

This currently isn't a component you can attach, but it is part of a Data Model Store<User>, so using such flux node will allow persistent user identification.

Component

This is what the type has visible while in a component context.

Fields
Name Type Description
User User The user that matches the _machineId and _userId.
_machineId String The machine id last known for a User. Is used to try to identify the user and fill User user ref field the next time they're in a world with this component.
_userId String The user's account ID last known for a User. Is used to try to identify the user and fill User user ref field the next time they're in a world with this component.