Component:SimpleAvatarProtection: Difference between revisions

From Resonite Wiki
No edit summary
By component stub definition. This is not a component stub
 
Line 28: Line 28:
</translate>
</translate>
[[Category:Components{{#translation:}}|Simple Avatar Protection]]
[[Category:Components{{#translation:}}|Simple Avatar Protection]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Simple Avatar Protection]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Simple Avatar Protection]]

Latest revision as of 17:41, 5 November 2024

Component image 
SimpleAvatarProtection component as seen in the Scene Inspector


SimpleAvatarProtection prevents other users from wearing an avatar or saving it.

Usage

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.
User direct CloudUserRef The user who is permitted to use the avatar.
ReassignUserOnPackageImport Bool See ResonitePackage#Simple_Avatar_Protection_handling.

Behavior

When attached anywhere on an avatar, the SimpleAvatarProtection component prevents all users, other than the single user listed on the component, from saving the avatar, grabbing materials off of it, or equipping it.

The component is automatically attached to an avatar if "Protect Avatar" is checked in the Avatar Creator when creating it.

All instances of SimpleAvatarProtection on an avatar can be removed by its owner by clicking the "Remove All Instances" button. No other user can remove the component. This is useful if you are trying to clear protection from an avatar, but cannot remember where the component was; you can simply add another instance and remove them all at once.