Identidade do utilizador

O UserIdentity módulo permite cenas acessar o perfil do usuário do jogador.

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

Contém os seguintes métodos e tipos:

• function getUserData

• interface UserData

Métodos

Os dois métodos neste módulo obtêm pequenas informações do usuário do jogador.

getUserData

Retorna o UserData do usuário do jogador.

interface Request {}

interface Response {
  // As informações do perfil do usuário, se disponíveis.
  data?: UserData;
}

function getUserData(Request): Promise<Response>;

Tipos

Há apenas um tipo neste módulo: UserData.

UserData

Armazena informações (possivelmente parciais) sobre um usuário, sua identidade e avatar.

Os World Explorers podem obter isso por meio do sistema de conteúdo.

O definição da entidade de perfil detalha todos esses campos e muito mais. Embora a estrutura e as chaves de UserData sejam ligeiramente diferentes, o significado de cada campo é o mesmo.

export interface UserData {
  // O endereço Ethereum do usuário.
  userId: string;

  // Um nome para chamá-lo na UI.
  displayName: string;

  // A chave pública Ethereum com a qual ele assina.
  publicKey?: string;

  // Se a funcionalidade web3 está ativada.
  hasConnectedWeb3: boolean;

  // A versão sequencial dessas informações, incrementada a cada atualização do usuário.
  version: number;

  // Informações sobre seu avatar, se disponíveis.
  avatar?: {
    // Ponteiros para os ativos necessários para renderizar este avatar.
    bodyShape: string;
    wearables: string[];

    // Cores RGB/RGBA codificadas em hexadecimal para diferentes partes do corpo (#aabbcc ou #aabbccdd).
    skinColor: string;
    hairColor: string;
    eyeColor: string;

    // Identificadores de arquivo para as "fotos" deste avatar.
    snapshots?: {
      face256: string;
      body: string;
    };
  };
}