@dcl/playground-assets 7.27.1-33755622021.commit-da82bfb → 7.27.1-34486417882.commit-c86ede9

package/dist/alpha.d.ts

@@ -318,6 +318,9 @@ export declare const enum AvatarModifierType {
     AMT_HIDE_NAMETAGS = 2
 }
 
+/** @public */
+export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
+
 /** @public */
 export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
 
@@ -1444,6 +1447,7 @@ export declare const componentDefinitionByName: {
     "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
     "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
     "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
+    "core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
     "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
     "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
     "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
@@ -5020,6 +5024,48 @@ export declare namespace PBAvatarModifierArea {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
 }
 
+/**
+ * The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
+ * for example to show a rank or a role that the scene assigns to that player.
+ *
+ * Valid only on an avatar-bearing entity:
+ * - the local player: `engine.PlayerEntity`
+ * - another player in the scene: that player's entity
+ * - an NPC: any entity with an AvatarShape
+ * Writes to any other entity are ignored.
+ *
+ * Player entity ids are not stable across disconnects: a write to a stale entity lands on
+ * whoever holds that id next. Resolve the entity from the user id on every write, and remove
+ * the component when the player leaves the scene.
+ *
+ * The plate is local to the client that renders it; it is never relayed to other players.
+ */
+/**
+ * @public
+ */
+export declare interface PBAvatarNametag {
+    /**
+     * The plate text: a single line, for example "Club Owner". Empty draws the plate without text,
+     * and spaces are preserved: a label of spaces widens a text-less plate. For a plate sized
+     * exactly to a word without showing it, set label_color equal to background_color instead.
+     */
+    label: string;
+    /** (default: the client's native nametag text color) */
+    labelColor?: PBColor3 | undefined;
+    /** (default: the client's native nametag background color) */
+    backgroundColor?: PBColor3 | undefined;
+    /** (default: background_color, so the plate carries no visible border) */
+    borderColor?: PBColor3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarNametag {
+    export function encode(message: PBAvatarNametag, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarNametag;
+}
+
 /**
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
  * a simplified GLTF container for this specific case.
@@ -8494,7 +8540,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
 /**
  * @public
  */
-export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
+export declare type ReadonlyPrimitive = number | string | boolean;
 
 /** @public */
 export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;

package/dist/beta.d.ts

@@ -318,6 +318,9 @@ export declare const enum AvatarModifierType {
     AMT_HIDE_NAMETAGS = 2
 }
 
+/** @public */
+export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
+
 /** @public */
 export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
 
@@ -1444,6 +1447,7 @@ export declare const componentDefinitionByName: {
     "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
     "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
     "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
+    "core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
     "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
     "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
     "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
@@ -4992,6 +4996,48 @@ export declare namespace PBAvatarModifierArea {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
 }
 
+/**
+ * The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
+ * for example to show a rank or a role that the scene assigns to that player.
+ *
+ * Valid only on an avatar-bearing entity:
+ * - the local player: `engine.PlayerEntity`
+ * - another player in the scene: that player's entity
+ * - an NPC: any entity with an AvatarShape
+ * Writes to any other entity are ignored.
+ *
+ * Player entity ids are not stable across disconnects: a write to a stale entity lands on
+ * whoever holds that id next. Resolve the entity from the user id on every write, and remove
+ * the component when the player leaves the scene.
+ *
+ * The plate is local to the client that renders it; it is never relayed to other players.
+ */
+/**
+ * @public
+ */
+export declare interface PBAvatarNametag {
+    /**
+     * The plate text: a single line, for example "Club Owner". Empty draws the plate without text,
+     * and spaces are preserved: a label of spaces widens a text-less plate. For a plate sized
+     * exactly to a word without showing it, set label_color equal to background_color instead.
+     */
+    label: string;
+    /** (default: the client's native nametag text color) */
+    labelColor?: PBColor3 | undefined;
+    /** (default: the client's native nametag background color) */
+    backgroundColor?: PBColor3 | undefined;
+    /** (default: background_color, so the plate carries no visible border) */
+    borderColor?: PBColor3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarNametag {
+    export function encode(message: PBAvatarNametag, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarNametag;
+}
+
 /**
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
  * a simplified GLTF container for this specific case.
@@ -8466,7 +8512,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
 /**
  * @public
  */
-export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
+export declare type ReadonlyPrimitive = number | string | boolean;
 
 /** @public */
 export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;

package/dist/index.bundled.d.ts

@@ -318,6 +318,9 @@ export declare const enum AvatarModifierType {
     AMT_HIDE_NAMETAGS = 2
 }
 
+/** @public */
+export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
+
 /** @public */
 export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
 
@@ -1444,6 +1447,7 @@ export declare const componentDefinitionByName: {
     "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
     "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
     "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
+    "core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
     "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
     "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
     "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
@@ -4992,6 +4996,48 @@ export declare namespace PBAvatarModifierArea {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
 }
 
+/**
+ * The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
+ * for example to show a rank or a role that the scene assigns to that player.
+ *
+ * Valid only on an avatar-bearing entity:
+ * - the local player: `engine.PlayerEntity`
+ * - another player in the scene: that player's entity
+ * - an NPC: any entity with an AvatarShape
+ * Writes to any other entity are ignored.
+ *
+ * Player entity ids are not stable across disconnects: a write to a stale entity lands on
+ * whoever holds that id next. Resolve the entity from the user id on every write, and remove
+ * the component when the player leaves the scene.
+ *
+ * The plate is local to the client that renders it; it is never relayed to other players.
+ */
+/**
+ * @public
+ */
+export declare interface PBAvatarNametag {
+    /**
+     * The plate text: a single line, for example "Club Owner". Empty draws the plate without text,
+     * and spaces are preserved: a label of spaces widens a text-less plate. For a plate sized
+     * exactly to a word without showing it, set label_color equal to background_color instead.
+     */
+    label: string;
+    /** (default: the client's native nametag text color) */
+    labelColor?: PBColor3 | undefined;
+    /** (default: the client's native nametag background color) */
+    backgroundColor?: PBColor3 | undefined;
+    /** (default: background_color, so the plate carries no visible border) */
+    borderColor?: PBColor3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarNametag {
+    export function encode(message: PBAvatarNametag, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarNametag;
+}
+
 /**
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
  * a simplified GLTF container for this specific case.
@@ -8466,7 +8512,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
 /**
  * @public
  */
-export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
+export declare type ReadonlyPrimitive = number | string | boolean;
 
 /** @public */
 export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;