Jogadores

O Jogadores módulo permite cenas para procurar jogadores no seu ambiente e obter informações sobre a sua identidade e perfis.

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

Contém os seguintes métodos e tipos:

• function getPlayersInScene

• function getConnectedPlayers

• function getPlayerData

• interface Player

• interface UserData

Métodos

Há dois métodos neste módulo para descobrir jogadores na cena e um para obter os seus perfis.

getPlayersInScene

Retorna um Player array, cada um com um userId que pode ser usado em getPlayerData.

interface Request {}

interface Response {
  players: Player[];
}

function getPlayersInScene(Request): Promise<Response>;

getConnectedPlayers

interface Request {}

interface Response {
  players: Player[];
}

function getConnectedPlayers(Request): Promise<Response>;

getPlayerData

Retorna o UserData para um utilizador, se conhecido para o userId.

interface Request {
  // O identificador do utilizador, (para não convidados, o seu endereço Ethereum).
  userId: string;
}

interface Response {
  // As informações de perfil deste utilizador, se disponíveis.
  data?: UserData;
}

function getPlayerData(Request): Promise<Response>;

Tipos

Há apenas dois tipos neste módulo: Player e UserData.

Player

Contém uma referência a um userId.

interface Player {
  // O identificador do utilizador, (para não convidados, o seu endereço Ethereum).
  userId: string;
}

UserData

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

World Explorers obtêm estas informações através da 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 identificador do utilizador (ou seja, o seu endereço Ethereum).
  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[];

    // Tons de cor RGB/RGBA codificados em hexadecimal para diferentes partes do corpo.
    skinColor: string;
    hairColor: string;
    eyeColor: string;

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