Players

El Players módulo permite escenas para buscar players en su entorno y obtener información sobre su identidad y profiles.

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

Contiene los siguientes métodos y tipos:

• function getPlayersInScene

• function getConnectedPlayers

• function getPlayerData

• interface Player

• interfaz UserData

Métodos

Hay dos métodos en este módulo para descubrir players en la escena, y uno para obtener sus profiles.

getPlayersInScene

Returns a Player array, each with a userId that can be used in 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

Devuelve la UserData para un usuario, si se conoce para el dado userId.

interface Request {
  // The user identifier, (for non-guests, their Ethereum address).
  userId: string;
}

interface Response {
  // The profile information for this user, if available.
  data?: UserData;
}

function getPlayerData(Request): Promise<Response>;

Tipos

Solo hay dos tipos en este módulo: Player y UserData.

Player

Mantiene una referencia a un userId.

interface Player {
  // The user identifier, (for non-guests, their Ethereum address).
  userId: string;
}

UserData

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

World Explorers obtienen esta información 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 {
  // The user identifier (i.e. their Ethereum address).
  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[];

    // Hex-encoded RGB/RGBA color tints for different body parts.
    skinColor: string;
    hairColor: string;
    eyeColor: string;

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