Avatares NPC

Mostrar y controlar un Avatar NPC

Muestra un avatar como una entidad en una escena.

💡 Consejo: Prueba la biblioteca NPC Toolkit para una experiencia más fácil al trabajar con NPCs, especialmente si necesitas interactuar mediante un árbol de conversación.

Crea un avatar

El siguiente fragmento crea un avatar con wearables y forma corporal aleatorios, y nombre "NPC".

const myAvatar = engine.addEntity()
AvatarShape.create(myAvatar)

Transform.create(myAvatar, {
	position: Vector3.create(4, 0.25, 5),
})

Al pasar datos para generar un AvatarShape, los siguientes campos son obligatorios:

• id: (obligatorio) Identificador interno del Avatar

También están disponibles los siguientes campos opcionales:

• name: Nombre que se mostrará sobre la cabeza del Avatar. Predeterminado: "NPC".

• bodyShape: Cadena para definir qué forma corporal usar. Las opciones válidas son 'urn:decentraland:off-chain:base-avatars:BaseMale' y 'urn:decentraland:off-chain:base-avatars:BaseFemale'.

• wearables: Matriz con la lista de URNs de wearables que el avatar tiene puestos actualmente. Si los wearables entran en conflicto (como si dos de ellos fueran sombreros), el último de la lista reemplaza al otro.

• emotes: Matriz con la lista de URNs de emotes NFT que el avatar puede reproducir

• eyeColor: Color3 para el color de los ojos (cualquier color es válido)

• skinColor: Color3 para el color de la piel (cualquier color es válido)

• hairColor: Color3 para el color del cabello (cualquier color es válido)

• hablando: Si true, muestra un conjunto de barras verdes junto al nombre, como cuando los jugadores usan chat de voz en el mundo.

• 💡 Consejo: Consulta tipos de color para más detalles sobre cómo establecer colores.

📔 Nota: La AvatarShapecomponent debe importarse mediante

import { AvatarShape } from "@dcl/sdk/ecs"

Consulta Imports para saber cómo manejarlos fácilmente.

📔 Nota: Los campos URN deben seguir el mismo formato usado para NFTShapes: urn:decentraland:<CHAIN>:<CONTRACT_STANDARD>:<CONTRACT_ADDRESS>:<TOKEN_ID>

Animations

Los Avatars reproducen animaciones idle predeterminadas mientras están quietos.

Para reproducir animaciones en el avatar, establece la expressionTriggerId cadena en el nombre de la animación que quieres reproducir.

const myAvatar = engine.addEntity()
AvatarShape.create(myAvatar, {
	id: '',
	emotes: [],
	wearables: [],
	expressionTriggerId: 'robot',
})

Transform.create(myAvatar, {
	position: Vector3.create(4, 0.25, 5),
})

El expressionTriggerId el campo admite todas las animaciones predeterminadas, así como animaciones personalizadas de un archivo de escena, e incluso URNs de emotes que están publicados en el Marketplace.

Animaciones en bucle

Las animaciones en un AvatarShape se reproducen una sola vez; si quieres que el avatar siga reproduciendo una animación en bucle, debes crear un sistema que le indique que reproduzca la animación de nuevo cada par de segundos.

Usa la expressionTriggerTimestamp para reproducir de nuevo el mismo emote. El valor de este campo es un timestamp de Lamportíndice

Así que la primera vez que reproduces un emote, estableces expressionTriggerTimestamp en 0. Para reproducir el emote de nuevo, debes actualizar este valor a 1. Así es como el engine sabe que esta es una nueva instrucción, y no una instrucción sobre la que ya actuó.

El siguiente fragmento crea un sistema que ejecuta el mismo emote cada 2 segundos:

const myAvatar = engine.addEntity()
AvatarShape.create(myAvatar, {
	id: '',
	emotes: [],
	wearables: [],
	expressionTriggerId: 'clap',
    expressionTriggerTimestamp: 0
})

Transform.create(myAvatar, {
	position: Vector3.create(4, 0.25, 5),
})

let clapTimer = 0
let emoteDuration = 2  // 2 segundos

// sistema
engine.addSystem((dt: number) => {
    clapTimer += dt
      
    if (clapTimer >= emoteDuration) {
        // Activar el emote de clap
        AvatarShape.getMutable(myAvatar).expressionTriggerTimestamp += 1
        
        clapTimer = 0 // Reiniciar temporizador
    }
})

💡 Consejo: Debes conocer la duración del emote, y hacer que esa sea la duración del sistema. Si creas un emote que deja al avatar inmóvil en la misma pose, es recomendable hacer que la duración del emote sea mayor que la del sistema. De esa manera, puedes asegurarte de que no haya artefactos al terminar y reiniciar la animación.

Copiar wearables del jugador

El siguiente fragmento cambia los wearables y otras características de un avatar NPC para que coincidan con las que el jugador lleva puestas actualmente. Esto podría usarse en una escena como un maniquí, para mostrar un wearable o emote particular combinado con el conjunto actual del jugador.

import { getPlayer } from '@dcl/sdk/src/players'


export function swapAvatar(avatar: Entity) {

  let userData = getPlayer()
  console.log(userData)

  if (!userData || !userData.wearables) return

  const mutableAvatar = AvatarShape.getMutable(avatar)

  mutableAvatar.wearables = userData.wearables
  mutableAvatar.bodyShape = userData.avatar?.bodyShapeUrn
  mutableAvatar.eyeColor = userData.avatar?.eyesColor
  mutableAvatar.skinColor = userData.avatar?.skinColor
  mutableAvatar.hairColor = userData.avatar?.hairColor
  
}

Mostrar solo wearables

Usa la showOnlyWearables campo para mostrar solo los wearables enumerados de un avatar. El resto del cuerpo del avatar será invisible.

const myAvatar = engine.addEntity()
AvatarShape.create(myAvatar, {
	id: '',
	emotes: [],
	wearables: [
    'urn:decentraland:matic:collections-v2:0x90e5cb2d673699be8f28d339c818a0b60144c494:0'
  ],
	showOnlyWearables: true,
})

Transform.create(myAvatar, {
	position: Vector3.create(4, 0.25, 5),
})

Esto es útil para mostrar wearables, por ejemplo en una tienda.

💡 Consejo: Si un wearable es bastante pequeño, prueba a establecer el escala del Transform a un valor mayor.

Adjuntar una entidad a un NPC

Puedes usar la AvatarAttach función para fijar una entidad a uno de los huesos de un avatar NPC, por ejemplo para que el NPC esté sosteniendo un objeto en su mano. La entidad se moverá junto con el avatar cuando se anime.

Para usar esta función, usa la id propiedad en el AvatarShape para asignar un id arbitrario a este avatar, y luego hacer referencia a ese id en la AvatarAttach. El id puede ser cualquier cadena que quieras.

// Crear NPC, con un ID
const myAvatar = engine.addEntity()
Transform.create(myAvatar, {
  position: Vector3.create(8, 0.25, 8),
})
AvatarShape.create(myAvatar, {
  id: "my-avatar-id", 
  wearables: [],
  emotes: []
})

// Crear objeto para adjuntar al NPC
const attachedEntity = engine.addEntity()
Transform.create(attachedEntity, {
    position: Vector3.create(4, 2, 4),
    scale: Vector3.create(0.15,0.15,0.15)
})
MeshRenderer.setBox(attachedEntity)
Material.setBasicMaterial(attachedEntity, { diffuseColor: Color4.Blue() })
AvatarAttach.create(attachedEntity, {
    avatarId: "my-avatar-id",
    anchorPointId: AvatarAnchorPointType.AAPT_LEFT_HAND
})

Aprende más sobre el AvatarAttach componente aquí.