Automated: update Fields, Categories |
Add info |
||
Line 7: | Line 7: | ||
|Name=Avatar Creator | |Name=Avatar Creator | ||
}} | }} | ||
The avatar creator component is the component that drives the functionality of the avatar creator object. See [[Avatar]] for a much less technical page on this, and for information on how to actually use the avatar creator. | |||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_headsetPoint|Slot| | |_headsetPoint|Slot| the headset point that marks the head proxy target slot position. | ||
|_leftPoint|Slot| | |_leftPoint|Slot| the point that marks the left hand's target slot position. | ||
|_rightPoint|Slot| | |_rightPoint|Slot| the point that marks the right hand's target slot position. | ||
|_leftFootPoint|Slot| | |_leftFootPoint|Slot| the point that marks the foot's target slot position. | ||
|_rightFootPoint|Slot| | |_rightFootPoint|Slot| the point that marks the right foot target slot position. | ||
|_pelvisPoint|Slot| | |_pelvisPoint|Slot| the pelvis guide object that marks the pelvis proxy position. | ||
|_headsetReference|Slot| | |_headsetReference|Slot| the headset guide that marks the headset proxy position (eyeballs/view position) | ||
|_pelvisReference|Slot| | |_pelvisReference|Slot| the pelvis guide object that marks the pelvis proxy position. | ||
|_leftReference|Slot| | |_leftReference|Slot| the left hand guide object that marks the left hand proxy. | ||
|_rightReference|Slot| | |_rightReference|Slot| the right hand guide object that marks the right hand proxy. | ||
|_leftFootReference|Slot| | |_leftFootReference|Slot| the left foot guide object. | ||
|_rightFootReference|Slot| | |_rightFootReference|Slot| the right foot guide object. | ||
|_initialized|Bool| | |_initialized|Bool| whether this avatar creator is ready to be used. | ||
|_showAnchors|Bool| | |_showAnchors|Bool| whether to show the tool anchors on the hands. | ||
|_useSymmetry|Bool| | |_useSymmetry|Bool| whether to enforce symmetry of the objects across the headset location during settup. | ||
|_setupVolumeMeter|Bool| | |_setupVolumeMeter|Bool| Whether to set up a volume meter component on the avatar when the avatar is created. | ||
|_setupProtection|Bool| | |_setupProtection|Bool| Whether to set up avatar protection components on the root and meshes of the avatar upon creation. | ||
|_setupEyes|Bool| | |_setupEyes|Bool| Whether to set up the eye bones and [[Component:EyeManager|eye manager]] upon avatar creation | ||
|_setupFaceTracking|Bool| | |_setupFaceTracking|Bool| Whether to set up a [[Component:AvatarExpressionDriver|face tracking component]] for the mesh with the most shapekey matches for visemes. | ||
|_calibrateFeet|Bool| | |_calibrateFeet|Bool| Whether to show the feet calibration guide objects. | ||
|_calibratePelvis|Bool| | |_calibratePelvis|Bool| whether to show the pelvis calibration guide object. | ||
|_symmetrySetup|Bool| | |_symmetrySetup|Bool| Whether to enforce symmetry on the avatar when creating. | ||
|_anchors|{{RootFieldType|SyncList`1|[[#Anchor|Anchor]]}}|TypeAdv22=true| | |_anchors|{{RootFieldType|SyncList`1|[[#Anchor|Anchor]]}}|TypeAdv22=true| A list of [[#Anchor|Anchor]] that are the different parts for avatar markers the user can move when using this creator. | ||
|_scale|Float| | |_scale|Float| the scale of all the <code>_anchors</code> of this avatar creator. | ||
|_protectAvatarEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv24=true| | |_protectAvatarEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv24=true| The protect avatar checkbox button enabled field. The checkbox disables when in user space | ||
|_createEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv25=true| | |_createEnabled|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv25=true| The field that controls the enabled state of the create avatar button. | ||
}} | |||
== Anchor == | |||
{{Table TypeFields | |||
|ScaleDrive|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv0=true| The scale field of this guide object. | |||
|AnchorName|string|The human readable name of this guide object. | |||
|IsRight|Bool| Whether this guide object is on the right side of the headset. (So is it a right or left hand for example?) | |||
|Slot|slot|The root slot of this guide object. | |||
|Slider|[[Component:Slider|Slider]]|TypeAdv4=true| The slider that can be used to move this guide object around via grabbing. | |||
}} | }} | ||
Line 50: | Line 60: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Avatar Creator]] | [[Category:Components{{#translation:}}|Avatar Creator]] | ||
[[Category:Components With Nested Types{{#translation:}}|Avatar Creator]] | [[Category:Components With Nested Types{{#translation:}}|Avatar Creator]] | ||
[[Category:Components:Uncategorized{{#translation:}}|Avatar Creator]] | [[Category:Components:Uncategorized{{#translation:}}|Avatar Creator]] |
Revision as of 16:53, 21 October 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
The avatar creator component is the component that drives the functionality of the avatar creator object. See Avatar for a much less technical page on this, and for information on how to actually use the avatar creator.
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. |
_headsetPoint
|
Slot | the headset point that marks the head proxy target slot position. |
_leftPoint
|
Slot | the point that marks the left hand's target slot position. |
_rightPoint
|
Slot | the point that marks the right hand's target slot position. |
_leftFootPoint
|
Slot | the point that marks the foot's target slot position. |
_rightFootPoint
|
Slot | the point that marks the right foot target slot position. |
_pelvisPoint
|
Slot | the pelvis guide object that marks the pelvis proxy position. |
_headsetReference
|
Slot | the headset guide that marks the headset proxy position (eyeballs/view position) |
_pelvisReference
|
Slot | the pelvis guide object that marks the pelvis proxy position. |
_leftReference
|
Slot | the left hand guide object that marks the left hand proxy. |
_rightReference
|
Slot | the right hand guide object that marks the right hand proxy. |
_leftFootReference
|
Slot | the left foot guide object. |
_rightFootReference
|
Slot | the right foot guide object. |
_initialized
|
Bool | whether this avatar creator is ready to be used. |
_showAnchors
|
Bool | whether to show the tool anchors on the hands. |
_useSymmetry
|
Bool | whether to enforce symmetry of the objects across the headset location during settup. |
_setupVolumeMeter
|
Bool | Whether to set up a volume meter component on the avatar when the avatar is created. |
_setupProtection
|
Bool | Whether to set up avatar protection components on the root and meshes of the avatar upon creation. |
_setupEyes
|
Bool | Whether to set up the eye bones and eye manager upon avatar creation |
_setupFaceTracking
|
Bool | Whether to set up a face tracking component for the mesh with the most shapekey matches for visemes. |
_calibrateFeet
|
Bool | Whether to show the feet calibration guide objects. |
_calibratePelvis
|
Bool | whether to show the pelvis calibration guide object. |
_symmetrySetup
|
Bool | Whether to enforce symmetry on the avatar when creating. |
_anchors
|
list of Anchor | A list of Anchor that are the different parts for avatar markers the user can move when using this creator. |
_scale
|
Float | the scale of all the _anchors of this avatar creator.
|
_protectAvatarEnabled
|
field drive of Bool | The protect avatar checkbox button enabled field. The checkbox disables when in user space |
_createEnabled
|
field drive of Bool | The field that controls the enabled state of the create avatar button. |
Anchor
Name | Type | Description |
---|---|---|
ScaleDrive
|
field drive of Float3 | The scale field of this guide object. |
AnchorName
|
string | The human readable name of this guide object. |
IsRight
|
Bool | Whether this guide object is on the right side of the headset. (So is it a right or left hand for example?) |
Slot
|
slot | The root slot of this guide object. |
Slider
|
Slider | The slider that can be used to move this guide object around via grabbing. |
Usage
Used for creating avatars. You can spawn it from your Local Space if you have the Builder Role permission to spawn it.