Component:AvatarNameTagAssigner

From Resonite Wiki
Revision as of 23:36, 23 June 2024 by Alizard (talk | contribs)


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


Component image 
AvatarNameTagAssigner component as seen in the Scene Inspector


The AvatarNameTagAssigner is responsible for setting the nametags' text, color, and the ContactLink UserId.

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.
LabelTargets list of IField`1<String>
UserIdTargets list of IField`1<String>
ColorTargets list of IField`1<ColorX>
OutlineTargets list of IField`1<ColorX>
BackgroundTargets list of IField`1<ColorX>
DequippedLabel String

Behavior

When an avatar is dequipped the DequippedLabel contents will be written to the LabelTargets, by default the DequippedLabel is "---".


Examples

By default a user's Name Badge will contain a AvatarNameTagAssigner connected to TextRenderer, TextUnlitMaterial, and a ContactLink. The user's username will be written to the TextRenderer, their default Name Badge colors will be written to the TextUnlitMaterial, and their UserId will be written to the ContactLink.

Related Components