玩家

该 玩家 模块允许 场景 用于在其环境中查找玩家并获取有关其身份和 资料.

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

它包含以下方法和类型：

• 函数 getPlayersInScene

• 函数 getConnectedPlayers

• 函数 getPlayerData

• 接口 Player

• interface UserData

方法

此模块中有两个方法用于发现场景中的玩家，另有一个方法用于获取他们的资料。

getPlayersInScene

返回一个 Player 数组，每个都带有一个 userId 可用于 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

返回 UserData 用于某个用户，如果已知该给定 userId.

接口 Request {
  // 用户标识符（对于非访客，即其 Ethereum 地址）。
  userId: string;
}

interface Response {
  // 该用户的个人资料信息（如果可用）。
  data?: UserData;
}

function getPlayerData(Request): Promise<Response>;

类型

此模块中只有两种类型： Player 和 UserData.

Player

持有对一个 userId.

interface Player {
  // 用户标识符（对于非访客，即其 Ethereum 地址）。
  userId: string;
}

UserData

保存有关用户、其身份和头像的（可能不完整的）信息。

World Explorers 通过 内容系统.

该 个人资料实体定义 详细说明这些字段及更多内容。虽然 UserData 的结构和键略有不同，但每个字段的含义是相同的。

export interface UserData {
  // 用户标识符（即其 Ethereum 地址）。
  userId: string;

  // 在界面中称呼他们的名称。
  displayName: string;

  // 他们用于签名的以太坊公钥。
  publicKey?: string;

  // 他们是否已启用 web3 功能。
  hasConnectedWeb3: boolean;

  // 此信息的顺序版本，每次用户更新时递增。
  version: number;

  // 有关其头像的信息（如果可用）。
  avatar?: {
    // 渲染此头像所需资源的指针。
    bodyShape: string;
    wearables: string[];

    // 不同身体部位的十六进制编码 RGB/RGBA 颜色色调。
    skinColor: string;
    hairColor: string;
    eyeColor: string;

    // 此头像“照片”的文件标识符。
    snapshots?: {
      face256: string;
      body: string;
    };
  };
}