Component:AvatarAnchor

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

Component image 

AvatarAnchor component as seen in the Scene Inspector

Intoduction

An anchor allows for an avatar to be attached to a slot.

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.
Highlight	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
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.
UseParentSpace	Bool	Use the parent of the specified slot, rather than the slot itself.
OverrideRootSpace	RootSpace	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
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.
PositionNode	UserNode	Which part of the avatar to use to position the avatar.
PositionReference	Slot	Where to position the avatar to.
RotationNode	UserNode	Which part of the avatar to use to rotate the avatar.
RotationReference	Slot	Where to rotate the avatar relative to.
PreserveUpOnEnter	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
PreserveUpOnExit	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
UnparentEverythingOnDestroy	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
TransformRestoreMode	RestoreMode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
RestoreNode	UserNode	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
RestoreReference	Slot	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Filters	BodyNodeFilters	A list of pose filters to use. Each one can control the position of a specific body node
UserFilters	IAvatarAnchorUserFilter	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
UserAnchored	AvatarAnchorUserEvent	Internal
UserReleased	AvatarAnchorUserEvent	Internal
LocomotionUpdate	AvatarAnchorLocomotionEvent	Internal
_originalSpace	Slot	Internal
_originalPosition	Float3	Internal
_originalRotation	FloatQ	Internal
_originalScale	Float	Internal
_dummyObjectSlots	AvatarObjectSlot	Internal

Behavior

By itself, an AvatarAnchor does nothing. It requires either an AvatarAnchorTouchTrigger component or a Anchor User ProtoFlux node to place an avatar into it.

To exit an anchor, a AvatarAnchorLocomotionRelease component or a Release User ProtoFlux node needs to be used.