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.
|LabelTargets|{{RootFieldType|SyncRefList`1|[[Type:IField`1|IField`1]]<[[Type:String|String]]>}}|TypeAdv0=true| A list of string fields that should be set to the user's display name when this component is under an avatar and the avatar is equipped.
|UserIdTargets|{{RootFieldType|SyncRefList`1|[[Type:IField`1|IField`1]]<[[Type:String|String]]>}}|TypeAdv1=true| A list of string fields that should be set to the user's UUID (aka UserID) when this component is under an avatar and the avatar is equipped.
|ColorTargets|{{RootFieldType|SyncRefList`1|[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv2=true| A list of colorX fields that should be set to the user's special color when this component is under an avatar and the avatar is equipped. Supporters, Staff, Mentors, and Moderators are some of the many users that get custom name plate colors through this component.
|OutlineTargets|{{RootFieldType|SyncRefList`1|[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv3=true| Similar to <code>ColorTargets</code> but for the outline.
|BackgroundTargets|{{RootFieldType|SyncRefList`1|[[Type:IField`1|IField`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv4=true| Similar to <code>ColorTargets</code> but for the background color.
|DequippedLabel|String|
|DequippedLabel|String|What text should display when the avatar this component belongs to is dequipped. You can be creative with this!
}}
}}
<!--T:4-->
== Behavior ==
== Behavior ==
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.
{{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-->
Line 32:
Line 34:
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar Name Tag Assigner]]
[[Category:Components{{#translation:}}|Avatar Name Tag Assigner]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Name Tag Assigner]]
[[Category:Components:Users:Common Avatar System:Nameplate{{#translation:}}|Avatar Name Tag Assigner]]
Latest revision as of 16:49, 15 October 2024
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.
A list of colorX fields that should be set to the user's special color when this component is under an avatar and the avatar is equipped. Supporters, Staff, Mentors, and Moderators are some of the many users that get custom name plate colors through this component.
What text should display when the avatar this component belongs to is dequipped. You can be creative with this!
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.
