Identidad del usuario

El UserIdentity módulo permite escenas acceder al perfil del usuario del jugador.

const UserIdentity = require("~system/UserIdentity");

Contiene los siguientes métodos y tipos:

• función getUserData

• interfaz UserData

Métodos

Los dos métodos en este módulo obtienen fragmentos de información del usuario del jugador.

getUserData

Devuelve la UserData del usuario del jugador.

interface Request {}

interface Response {
  // La información de perfil del usuario, si está disponible.
  data?: UserData;
}

function getUserData(Request): Promise<Response>;

Tipos

Hay solo un tipo en este módulo: UserData.

UserData

Contiene información (posiblemente parcial) sobre un usuario, su identidad y avatar.

Los World Explorers pueden obtener esto a través del content system.

El profile entity definition detalla todos estos campos y más. Aunque la estructura y las claves de UserData son ligeramente diferentes, el significado de cada campo es el mismo.

export interface UserData {
  // La dirección de Ethereum del usuario.
  userId: string;

  // Un nombre para llamarlo en la IU.
  displayName: string;

  // La clave pública de Ethereum con la que firma.
  publicKey?: string;

  // Si tienen la funcionalidad web3 habilitada.
  hasConnectedWeb3: boolean;

  // La versión secuencial de esta información, incrementada en cada actualización del usuario.
  version: number;

  // Información sobre su avatar, si está disponible.
  avatar?: {
    // Punteros a los assets requeridos para renderizar este avatar.
    bodyShape: string;
    wearables: string[];

    // Colores RGB/RGBA codificados en hexadecimal para diferentes partes del cuerpo (#aabbcc o #aabbccdd).
    skinColor: string;
    hairColor: string;
    eyeColor: string;

    // Identificadores de archivo para las "fotos" de este avatar.
    snapshots?: {
      face256: string;
      body: string;
    };
  };
}