Component:AvatarObjectPermissions

From Resonite Wiki
Revision as of 06:33, 20 January 2024 by ProbablePrime (talk | contribs) (ProbablePrime moved page AvatarObjectPermissions (Component) to Component:AvatarObjectPermissions: Creating component Namespace)


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


Component image 
Avatar Object Permissions component as seen in the Scene Inspector

Intoduction

The AvatarObjectPermission component is a Permissions component which determines which avatars users are allowed to equip if the avatar is tagged properly.

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.
Mode ListFilterMode Controls what filtering mode is applied to List
List SyncFieldList<string> Tags which determine the allowed or disallowed equpability dependant on the Mode

Usage

This permission allows or disallows specific avatars to be used. Tags are used to determine to in-/equipability of such tagged avatars.

Examples

Avatar-A has the Tag "AvatarA". Avatar-B has the Tag "AvatarB".

If the permission is set to Whitelist then only the tags which *are* in the list are allowed to be equipped.

If the list contains "A" as a tag and only AvatarA has the Tag (on avatar root) "A" and the FilterMode is set to Whitelist. Then only AvatarA is allowed to be equipped.

Related Components