An anchor allows for an [[avatar]] to be attached to a [[slot]]. This component can also allow for pinning of a user's limb(s) for posing, and is most commonly used as a seat.
An anchor allows for an [[avatar]] to be attached to a [[slot]].
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Highlight|Bool|{{stub}}
|Highlight|Bool| Whether a user is pointing at this anchor and it is possible for them to activate the enter dialogue by pressing Primary at this moment.
|LocalSpace|Slot|The coordinate space in which to work with the avatar. Leaving this blank uses the world root; using a slot will cause the avatar to be scaled if that slot is called.
|ParentSpace|{{RootFieldType|RootSpace}}|TypeAdv1=true|The coordinate space in which to work with the avatar.
|UseParentSpace|Bool|Use the parent of the specified slot, rather than the slot itself.
|OverrideRootSpace|RootSpace|{{stub}}
|MinScale|Float|If an avatar has a scale below the MinScale, it will be scaled up to that size.
|MinScale|Float|If an avatar has a scale below the MinScale, it will be scaled up to that size.
|MaxScale|Float|If an avatar has a scale above the MaxScale, it will be scaled down to that size.
|MaxScale|Float|If an avatar has a scale above the MaxScale, it will be scaled down to that size.
Line 23:
Line 18:
|PositionReference|Slot|Where to position the avatar to.
|PositionReference|Slot|Where to position the avatar to.
|RotationNode|UserNode|Which part of the avatar to use to rotate the avatar.
|RotationNode|UserNode|Which part of the avatar to use to rotate the avatar.
|RotationReference|Slot|Where to rotate the avatar relative to.
|RotationReference|Slot|Where to rotate the avatar to.
|PreserveUpOnEnter|Bool|{{stub}}
|PreserveUpOnEnter|Bool| Whether to keep the user's root slot's up direction pointing the same direction it was in global space before entering, or to align them to the up of the slot of the anchor. This is disabled when <code>RotationNode</code> and <code>RotationReference</code> are set to not none.
|PreserveUpOnExit|Bool|{{stub}}
|PreserveUpOnExit|Bool| Whether to keep the user's root slot's up direction pointing the same direction it was in global space before exiting, or to align them to the up of the slot they get parented back under. This is disabled when <code>TransformRestoreMode</code> and <code>RestoreNode</code> are set to not none.
|UnparentEverythingOnDestroy|Bool|{{stub}}
|UnparentEverythingOnDestroy|Bool|Unparent all slots under <code>ParentSpace</code>'s Space slot and parent them under the parent of the nearest ObjectRoot (doesn't need an explicit ObjectRoot component). If <code>ParentSpace</code>'s Space slot is null, or the ObjectRoot parent is null, then all children are deleted anyway.
|TransformRestoreMode|RestoreMode|{{stub}}
|TransformRestoreMode|'''[[Type:RestoreMode|RestoreMode]]'''|TypeAdv11=true| What slot or space to use when setting the user's transforms to what they were before they entered the anchor.
|RestoreNode|UserNode|{{stub}}
|RestoreNode|UserNode|The part of the user's avatar that the transforms should be changed to <code>_originalPosition</code>, <code>_originalRotation</code>, and <code>_originalScale</code> when the user exits the anchor. Which space the transforms refer to (aka what it would be parented to) depends on what <code>TransformRestoreMode</code> is set to.
|RestoreReference|Slot|{{stub}}
|RestoreReference|Slot|This will be used from when <code>TransformRestoreMode</code> is set to "Reference". The specified <code>RestoreNode</code>'s transform will be set to this slot's space using <code>_originalPosition</code>, <code>_originalRotation</code>, and <code>_originalScale</code>.
|Filters|BodyNodeFilters|A list of pose filters to use. Each one can control the position of a specific body node
|Filters|{{RootFieldType|SyncList`1|[[#BodyNodeFilters|BodyNodeFilters]]}}|TypeAdv14=true|A list of pose filters to use. Each one can control the position, rotation, and/or speed of a specific body node
|UserFilters|IAvatarAnchorUserFilter|{{stub}}
|UserFilters|{{RootFieldType|SyncRefList`1|[[Type:IAvatarAnchorUserFilter|IAvatarAnchorUserFilter]]}}|TypeAdv15=true|Nothing currently implements [[Type:IAvatarAnchorUserFilter|IAvatarAnchorUserFilter]] so this currently does nothing.
|Node|BodyNode| The node on the anchored user to apply filters to.
|Required|Bool| Whether full body users can override this node and move the body part anyway.
|Filters|{{RootFieldType|SyncList`1|[[#PoseFilter|PoseFilter]]}}|TypeAdv2=true| The list of filters that should be applied to <code>Node</code> when the user is anchored.
}}
== PoseFilter ==
{{Table TypeFields
|Filter|IAvatarPoseFilter| Any [[:Category:Components:Users:Common Avatar System:Pose Filters|Pose Filter]] can be used here to be applied to a body node.
|Priority|Int| Whether to apply the pose filter before another pose filter.
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Behavior ==
By itself, an AvatarAnchor does nothing. It requires either an [[AvatarAnchorTouchTrigger (Component)|AvatarAnchorTouchTrigger]] component or a [[ProtoFlux:Anchor User|Anchor User]] [[ProtoFlux]] node to place an avatar into it.
By itself, an AvatarAnchor does nothing. It requires either an [[AvatarAnchorTouchTrigger (Component)|AvatarAnchorTouchTrigger]] component or a [[Anchor User (ProtoFlux Node)|Anchor User]] [[ProtoFlux]] node to place an avatar into it.
To exit an anchor, a [[AvatarAnchorLocomotionRelease (Component)|AvatarAnchorLocomotionRelease]] component or a [[ProtoFlux:Release User|Release User]] [[ProtoFlux]] node needs to be used.
To exit an anchor, a [[AvatarAnchorLocomotionRelease (Component)|AvatarAnchorLocomotionRelease]] component or a [[Release User (ProtoFlux Node)|Release User]] [[ProtoFlux]] node needs to be used.
An anchor allows for an avatar to be attached to a slot. This component can also allow for pinning of a user's limb(s) for posing, and is most commonly used as a seat.
Whether to keep the user's root slot's up direction pointing the same direction it was in global space before entering, or to align them to the up of the slot of the anchor. This is disabled when RotationNode and RotationReference are set to not none.
Whether to keep the user's root slot's up direction pointing the same direction it was in global space before exiting, or to align them to the up of the slot they get parented back under. This is disabled when TransformRestoreMode and RestoreNode are set to not none.
Unparent all slots under ParentSpace's Space slot and parent them under the parent of the nearest ObjectRoot (doesn't need an explicit ObjectRoot component). If ParentSpace's Space slot is null, or the ObjectRoot parent is null, then all children are deleted anyway.
The part of the user's avatar that the transforms should be changed to _originalPosition, _originalRotation, and _originalScale when the user exits the anchor. Which space the transforms refer to (aka what it would be parented to) depends on what TransformRestoreMode is set to.
This will be used from when TransformRestoreMode is set to "Reference". The specified RestoreNode's transform will be set to this slot's space using _originalPosition, _originalRotation, and _originalScale.
