players

The Players module allows scenes to look for players in their environment and get information about their identity and profiles.

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

It contains the following methods and types:

• function getPlayersInScene
• function getConnectedPlayers
• function getPlayerData
• interface Player
• interface UserData

Methods

There's two methods in this module to discover players in the scene, and one to obtain their profiles.

getPlayersInScene {#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 {#getConnectedPlayers}

interface Request {}

interface Response {
  players: Player[];
}

function getConnectedPlayers(Request): Promise<Response>;

getPlayerData {#getPlayerData}

Returns the UserData for a user, if known for the given 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>;

Types

There's only two types in this module: Player and UserData.

Player {#Player}

Holds a reference to a userId.

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

UserData {#UserData}

Holds (possibly partial) information about a user, their identity and avatar.

World Explorers obtain this information through the content system.

The profile entity definition details all of these fields and more. While the structure and keys of UserData are slightly different, the meaning of each field is the same.

export interface UserData {
  // The user identifier (i.e. their Ethereum address).
  userId: string;

  // A name to call them in the UI.
  displayName: string;

  // The Ethereum public key they sign with.
  publicKey?: string;

  // Whether they have web3 functionality enabled.
  hasConnectedWeb3: boolean;

  // The sequential version of this information, incremented on each user update.
  version: number;

  // Information about their avatar, if available.
  avatar?: {
    // Pointers to the assets required to render this avatar.
    bodyShape: string;
    wearables: string[];

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

    // File identifiers for the "photos" of this avatar.
    snapshots?: {
      face256: string;
      body: string;
    };
  };
}