feat(world): support npc renaming

packages/serenity/src/handlers/npc-request.ts

@@ -38,6 +38,18 @@ class NpcRequest extends SerenityHandler {
  case NpcRequestType.ExecuteAction: {
  return this.executeAction(packet, player);
  }
+
+ case NpcRequestType.ExecuteOpeningCommands: {
+ return this.executeOpeningCommands(packet, player);
+ }
+
+ case NpcRequestType.SetName: {
+ return this.setName(packet, player);
+ }
+
+ case NpcRequestType.ExecuteClosingCommands: {
+ return this.ExecuteClosingCommands(packet, player);
+ }
  }
  }
 
@@ -71,6 +83,49 @@ class NpcRequest extends SerenityHandler {
  player.executeCommand(command);
  }
  }
+
+ public static executeOpeningCommands(
+ packet: NpcRequestPacket,
+ player: Player
+ ): void {
+ // Separate the packet into variables
+ const { runtimeActorId } = packet;
+
+ // Get the entity from the packet.
+ const entity = player.dimension.getEntityByRuntime(runtimeActorId);
+ if (!entity) throw new Error("Failed to find the entity.");
+
+ // Sync the entity data
+ entity.syncData();
+ }
+
+ public static setName(packet: NpcRequestPacket, player: Player): void {
+ // Get the entity from the packet
+ const entity = player.dimension.getEntityByRuntime(packet.runtimeActorId);
+ if (!entity) throw new Error("Failed to find the entity.");
+
+ // Check if the entity has the npc component
+ const npc = entity.getComponent("minecraft:npc");
+ if (!npc) throw new Error("Failed to find the npc component.");
+
+ // Set the nametag of the entity
+ entity.setNametag(packet.actions);
+ }
+
+ public static ExecuteClosingCommands(
+ packet: NpcRequestPacket,
+ player: Player
+ ): void {
+ // Separate the packet into variables
+ const { runtimeActorId } = packet;
+
+ // Get the entity from the packet.
+ const entity = player.dimension.getEntityByRuntime(runtimeActorId);
+ if (!entity) throw new Error("Failed to find the entity.");
+
+ // Sync the entity data
+ entity.syncData();
+ }
 }
 
 export { NpcRequest };

packages/world/src/components/entity/npc.ts

@@ -43,8 +43,14 @@ class EntityNpcComponent extends EntityComponent {
  entity.syncData();
  }
 
+ // Check if the entity has a nametag component
+ if (!entity.hasComponent("minecraft:nametag")) {
+ // Set the nametag of the entity
+ entity.setNametag("NPC", true);
+ }
+
  // Create a default scene for the npc component
- const scene = new DialogueScene("NPC", "Hello, world!");
+ const scene = new DialogueScene("default", "Hello, world!");
 
  // Add the default scene to the npc component
  this.addScene(scene);
@@ -131,7 +137,7 @@ class EntityNpcComponent extends EntityComponent {
  packet.action = NpcDialogueAction.Open;
  packet.dialogue = fScene.dialogue;
  packet.scene = fScene.name;
- packet.name = fScene.name;
+ packet.name = this.entity.getNametag();
  packet.json = JSON.stringify(buttons);
 
  // Send the packet to the player
@@ -151,7 +157,7 @@ class EntityNpcComponent extends EntityComponent {
  packet.action = NpcDialogueAction.Close;
  packet.dialogue = String();
  packet.scene = String();
- packet.name = String();
+ packet.name = this.entity.getNametag();
  packet.json = String();
 
  // Send the packet to the player

packages/world/src/entity/entity.ts

@@ -25,6 +25,7 @@ import { CommandExecutionState, type CommandResult } from "@serenityjs/command";
 
 import { CardinalDirection } from "../enums";
 import {
+ EntityAlwaysShowNametagComponent,
  EntityComponent,
  EntityEffectsComponent,
  EntityHealthComponent,
@@ -746,11 +747,27 @@ class Entity {
  * @note This method is dependant on the entity having a `minecraft:nametag` component, if the component does not exist it will be created.
  * @param nametag The nametag to set.
  */
- public setNametag(nametag: string): void {
+ public setNametag(nametag: string, alwaysVisible = false): void {
  // Check if the entity has a nametag component
  if (!this.hasComponent("minecraft:nametag"))
  new EntityNametagComponent(this);
 
+ // Check if the entity should always show the nametag
+ if (alwaysVisible && !this.hasComponent("minecraft:always_show_nametag"))
+ new EntityAlwaysShowNametagComponent(this);
+
+ // Check if the entity should not always show the nametag
+ if (!alwaysVisible && this.hasComponent("minecraft:always_show_nametag")) {
+ // Get the always show nametag component
+ const component = this.getComponent("minecraft:always_show_nametag");
+
+ // Set the current value to false
+ component.setCurrentValue(0);
+
+ // Remove the component
+ this.removeComponent("minecraft:always_show_nametag");
+ }
+
  // Get the nametag component
  const nametagComponent = this.getComponent("minecraft:nametag");