Component:NamePlateInterface

From Resonite Wiki
Component image 
Name Plate Interface component as seen in the Scene Inspector

The NamePlateInterface component is a favoritable type component that allows a user to set their custom nameplate for avatars they spawn into

This component is currently unimplemented. Source code structures indicate no references to this component. The nameplate system as it is has several issues on the issue tracker. This will most likely be implemented along with many nameplate bug fixes in the """contacts and profiles update""" milestone.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
ItemName IField`1<String> The name of this dialogue
SpawningUser UserRef The user that spawned the dialouge
SpawningUserID IField`1<String> The field containing the User ID of the person that spawned the dialogue
IsInstance Bool Whether this dialogue was spawned by the game (true) or spawned from inventory (false)
Username IField`1<String> The field to set with the username of the user who this nameplate has been spawned onto.
UserID IField`1<String> The field to set with the UserID of the user who this nameplate has been spawned onto.
IconURL IField`1<Uri> The field to set with the User profile icon of the user who this nameplate has been spawned onto.
TargetUser SyncRef`1<User> The field to set with the user this nameplate has been spawned onto.
TargetUserRef UserRef A user reference block to store info about the user this nameplate has been spawned onto.
VoiceStream SyncRef`1<IAudioSource> The field to populate with the user voice stream of the user this nameplate has been spawned onto.

Usage

Currently unimplemented.

Examples

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

See Also