fix links |
Automated: update Fields, Categories |
||
| Line 15: | Line 15: | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Highlight|Bool|{{stub}} | |Highlight|Bool|{{stub}} | ||
| | |ParentSpace|{{RootFieldType|RootSpace}}|TypeAdv1=true| | ||
|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 27: | Line 25: | ||
|PreserveUpOnExit|Bool|{{stub}} | |PreserveUpOnExit|Bool|{{stub}} | ||
|UnparentEverythingOnDestroy|Bool|{{stub}} | |UnparentEverythingOnDestroy|Bool|{{stub}} | ||
|TransformRestoreMode|RestoreMode|{{stub}} | |TransformRestoreMode|'''[[#RestoreMode|RestoreMode]]'''|TypeAdv11=true|{{stub}} | ||
|RestoreNode|UserNode|{{stub}} | |RestoreNode|UserNode|{{stub}} | ||
|RestoreReference|Slot|{{stub}} | |RestoreReference|Slot|{{stub}} | ||
|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 of a specific body node | ||
|UserFilters|IAvatarAnchorUserFilter|{{stub}} | |UserFilters|{{RootFieldType|SyncRefList`1|[[Type:IAvatarAnchorUserFilter|IAvatarAnchorUserFilter]]}}|TypeAdv15=true|{{stub}} | ||
|UserAnchored|AvatarAnchorUserEvent|Internal | |UserAnchored|{{RootFieldType|SyncDelegate`1|[[Type:AvatarAnchorUserEvent|AvatarAnchorUserEvent]]}}|TypeAdv16=true|Internal | ||
| | |UserStay|{{RootFieldType|SyncDelegate`1|[[Type:AvatarAnchorUserEvent|AvatarAnchorUserEvent]]}}|TypeAdv17=true| | ||
| | |UserReleased|{{RootFieldType|SyncDelegate`1|[[Type:AvatarAnchorUserEvent|AvatarAnchorUserEvent]]}}|TypeAdv18=true|Internal | ||
|_originalSpace|Slot|Internal | |_originalSpace|Slot|Internal | ||
|_originalPosition|Float3|Internal | |_originalPosition|Float3|Internal | ||
|_originalRotation|FloatQ|Internal | |_originalRotation|FloatQ|Internal | ||
|_originalScale|Float|Internal | |_originalScale|Float|Internal | ||
|_dummyObjectSlots|AvatarObjectSlot|Internal | |_dummyObjectSlots|{{RootFieldType|SyncRefList`1|[[Component:AvatarObjectSlot|AvatarObjectSlot]]}}|TypeAdv23=true|Internal | ||
}} | }} | ||
| Line 53: | Line 51: | ||
<!--T:6--> | <!--T:6--> | ||
== Related Components == | == Related Components == | ||
[[Category:ComponentStubs]] | [[Category:ComponentStubs]] | ||
[[Category:Components:Users:Common Avatar System:Anchors| | [[Category:Components:Users:Common Avatar System:Anchors{{#translation:}}|Avatar Anchor]] | ||
[[Category:Components{{#translation:}}|Avatar Anchor]] | |||
[[Category:Components With Nested Enums{{#translation:}}|Avatar Anchor]] | |||
[[Category:Components With Nested Types{{#translation:}}|Avatar Anchor]] | |||
Revision as of 23:03, 3 March 2024
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
Usage
| 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. |
ParentSpace
|
direct RootSpace | |
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
|
list of BodyNodeFilters | A list of pose filters to use. Each one can control the position of a specific body node |
UserFilters
|
list of IAvatarAnchorUserFilter | This article or section is a Stub. You can help the Resonite Wiki by expanding it. |
UserAnchored
|
AvatarAnchorUserEvent | Internal |
UserStay
|
AvatarAnchorUserEvent | |
UserReleased
|
AvatarAnchorUserEvent | Internal |
_originalSpace
|
Slot | Internal |
_originalPosition
|
Float3 | Internal |
_originalRotation
|
FloatQ | Internal |
_originalScale
|
Float | Internal |
_dummyObjectSlots
|
list of 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.