Component:AvatarNameTagAssigner: Difference between revisions

From Resonite Wiki
mNo edit summary
Style. Added warning note. Added link.
Line 9: Line 9:


<!--T:2-->
<!--T:2-->
The AvatarNameTagAssigner is responsible for setting the nametags' text, color, and the [[Component:ContactLink|ContactLink]] UserId.
The '''AvatarNameTagAssigner''' component is responsible for setting the [[Nameplate|nametag's]] text, color, and the [[Component:ContactLink|ContactLink]] UserId. It basically defines what a nametag is.


<!--T:3-->
<!--T:3-->
Line 25: Line 25:
== Behavior ==
== Behavior ==
When an avatar is dequipped the DequippedLabel contents will be written to the LabelTargets, by default the DequippedLabel is "---".
When an avatar is dequipped the DequippedLabel contents will be written to the LabelTargets, by default the DequippedLabel is "---".


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
By default a user's [[Nameplate|Name Badge]] will contain a AvatarNameTagAssigner connected to [[Component:TextRenderer|TextRenderer]], [[Component:TextUnlitMaterial|TextUnlitMaterial]], and a [[Component:ContactLink|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.
By default a user's [[Nameplate|Name Badge]] will contain a '''AvatarNameTagAssigner''' connected to [[Component:TextRenderer|TextRenderer]], [[Component:TextUnlitMaterial|TextUnlitMaterial]], and a [[Component:ContactLink|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.
 
{{Note|Not unassigning these fields located in this component will result in your hard work being overwritten when equipping the avatar. Please make sure that the parts that you want overridden is referenced here, else leave those parts blank to have them customized.|warning}}


<!--T:6-->
<!--T:6-->

Revision as of 04:02, 19 August 2024


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 component is responsible for setting the nametag's text, color, and the ContactLink UserId. It basically defines what a nametag is.

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.

Not unassigning these fields located in this component will result in your hard work being overwritten when equipping the avatar. Please make sure that the parts that you want overridden is referenced here, else leave those parts blank to have them customized.

Related Components