Component:CommonAvatarBuilder

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

CollapseComponent image 

CommonAvatarBuilder component as seen in the Scene Inspector

Common Avatar Builder is a component that is part of every world that defines the spawning behavior and routines to do for all users when they spawn into a world. This can be used to add world settings menus, change what parts of a user get automatically set up, and so on.

Fields

Fields Collapse

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. Some components stop their functionality when this field is disabled, but some don't.
LoadCloudAvatars	Bool	Whether to load the User's set avatar, or load the default avatar instead.
CustomAvatarTemplates	list of CommonAvatarBuilder.AvatarTemplate	Avatars that user's will spawn into if they don't have a cloud avatar, or optionally force them into one of these templates.
AutoInject	Slot	A slot that will automatically be duplicated and added as a child of a user when they join the world. Certain components will use this to override user behavior when part of this slot's hierarchy, like Avatar Audio Configuration to name one.
SetupNameBadges	Bool	Whether to set up the user's default name badge when they spawn
SetupIconBadges	Bool	Whether to set up the user's default badges when they spawn.
SetupServerVoice	Bool	Only used in kiosk mode.
SetupClientVoice	Bool	Only used in kiosk mode.
SetupServerTools	Bool	Only used in kiosk mode.
SetupClientTools	Bool	Only used in kiosk mode.
SetupLocomotion	Bool	Whether to give the user the default locomotion modules when they spawn.
AllowLocomotion	Bool	Whether to allow the user to move using locomotion when they spawn.
DefaultHostSilenced	Bool	Whether the user should be default muted to the host when they spawn.
DefaultClientSilenced	Bool	Whether the user should be default muted on their end when they spawn.
LocomotionModules	Slot	The slot full of locomotion modules that the user will have by default after they spawn.
ForceDefaultLocomotionModule	ILocomotionModule	The locomotion to enable for the user by default when spawning rather than the one in that user's locomotion settings set in their dash.
FindUserPreferredModule	Bool	Whether to try to spawn the user into their preferred locomotion module they set in settings.
SetupItemShelves	Bool	Whether to add item shelves to the user when they spawn.
ParentClientsToServer	Bool	Parents users that join under the host user's slot (yes this is what it does)
AlignTracking	Bool	used in Kiosk mode in dash space to show Debug tracking visuals
EmptyAvatarSlotHandler	IEmptyAvatarSlotHandler	Uses this component to handle empty slots like head and hands on a spawning avatar.
FillEmptySlots	Bool	Whether to fill empty AvatarObjectSlots with default head and hand objects if they are missing on their loaded avatar.

Sync Delegates

Triggers Collapse

Method Name	Method type and Arguments.	Is the method hidden?	Description
SetupPositionStream:Action`2<ValueStream`1<Float3>, Int>	Action`2<ValueStream`1<Float3>, Int>	✓	Used internally.
SetupRotationStream:Action`2<ValueStream`1<FloatQ>, Int>	Action`2<ValueStream`1<FloatQ>, Int>	✓	Used internally.
LocomotionControllerInitialized:Action`1<LocomotionController>	Action`1<LocomotionController>	✓	Used internally.
UpdateLocomotionModules:ButtonEventHandler	ButtonEventHandler	✓	Updates the locomotion modules on every user with the ones specified with this component.

AvatarTemplate

Fields

Name	Type	Description
TemplateRoot	Slot	The avatar to use if this is chosen.
OnlyForRole	Role	What role this choice should apply to.
Weight	Float	The likelyness compared to other choices to choose this.
MaxUsers	Int	How many users at maximum could be assigned this avatar at any given moment.
BlockCloudAvatar	Bool	Whether the user's Favorited avatar should be ignored.

Role

Values

Name	Value	Description
Anyone	0	Anyone will get the avatar.
HostOnly	1	Only the host may get this avatar.
GuestOnly	2	Only guests may get this avatar.

Behavior

This component gets read and executed every time a user respawns or joins into a world.

Examples

Found under Root in every world, and is used to control user spawning.