Component:AvatarFacetAnchor: Difference between revisions

From Resonite Wiki
fix
add missing info
 
Line 5: Line 5:
Avatar Facet Anchor is a component that is used to position a userspace facet anchor to the slot this is on.
Avatar Facet Anchor is a component that is used to position a userspace facet anchor to the slot this is on.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|FacetAnchorPoint|FacetAnchorPoint| Which facet anchor should be positioned at the slot this component is on.
|FacetAnchorPoint|FacetAnchorPoint| Which facet anchor should be positioned at the slot this component is on.
|OverrideState|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Bool|Bool]]>'''|TypeAdv1=true|
|OverrideState|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Bool|Bool]]>'''|TypeAdv1=true| Whether to force this anchor to stay on or off.
}}
}}


== Behavior ==
== Usage ==
Will not work if the component's active user is not the local user.
Will not work if the component's active user is not the local user.


Line 20: Line 20:


[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Facet Anchor]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Facet Anchor]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Avatar Facet Anchor]]
[[Category:Components{{#translation:}}|Avatar Facet Anchor]]

Latest revision as of 22:09, 22 December 2024

Component image 
File:AvatarFacetAnchorComponent.png
Avatar Facet Anchor component as seen in the Scene Inspector

Avatar Facet Anchor is a component that is used to position a userspace facet anchor to the slot this is on.

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.
FacetAnchorPoint FacetAnchorPoint Which facet anchor should be positioned at the slot this component is on.
OverrideState Nullable`1<Bool> Whether to force this anchor to stay on or off.

Usage

Will not work if the component's active user is not the local user.

Examples

Is usually auto generated on an avatar's hands, head, and arms so that facet anchors know where to position themselves.

See Also