Ações restritas

O RestrictedActions o módulo permite que scenes acessem funcionalidades sensíveis (e, portanto, restritas). Ele está ligado ao permissão sistema, que as scenes usam para solicitar o uso de métodos individuais.

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

Como implementador do World Explorer, o seu runtime pode não ter aplicação de permissões. Nós fortemente desaconselhamos isso, pois coloca os jogadores em perigo.

A maior parte da funcionalidade restrita é fornecida por este módulo, mas também há funções globais.

O módulo contém os seguintes métodos e tipos:

• função movePlayerTo

• função teleportTo

• função triggerEmote

• função changeRealm

• função openExternalUrl

• função openNftDialog

• função setCommunicationsAdapter

• interface Vector3

Métodos

Cada um dos métodos abaixo está associado a uma permissão que pode ser solicitada no manifesto da scene.

movePlayerTo

Desloque o jogador para uma nova posição relativa à atual e, opcionalmente, defina o alvo da câmera com vetores.

Requer a ALLOW_TO_MOVE_PLAYER_INSIDE_SCENE permissão.

interface Request {
  newRelativePosition: Vector3;
  cameraTarget?: Vector3;
}

interface Response {
    // Assim que o jogador tiver se movido para a nova posição, e se o jogador não tiver interrompido o movimento, isso será true.
  success: boolean;
}

function movePlayerTo(Request): Promise<Response>;

teleportTo

Reposicione o jogador em um parcel, opcionalmente em outro realm.

Em vez de exigir uma permissão pré-aprovada, cada chamada para teleportTo deve ser aprovada pelo jogador.

interface Request {
  // O parcel de destino. Omitido: o spawn padrão do realm
  // (só faz sentido juntamente com `realm`).
  worldCoordinates?: Vector2;

  // O realm ao qual o parcel pertence: um nome de world (`foo.dcl.eth`) ou uma URL de realm.
  // Quando definido, o client muda de realm (uma reconexão completa, até mesmo para o realm em que o
  // jogador já estiver) e então aterrissa no parcel lá.
  // Omitido: o parcel está no realm atual do jogador.
  realm?: string;
}

interface Response {}

function teleportTo(Request): Promise<Response>;

triggerEmote

Faça o avatar do jogador exibir uma animação de emote, usando um dos nomes predefinidos.

Requer a ALLOW_TO_TRIGGER_AVATAR_EMOTE permissão.

interface Request {
  predefinedEmote: string;
}

interface Response {}

function triggerEmote(Request): Promise<Response>;

openExternalUrl

Ofereça mostrar um site ao jogador, usando uma UI apropriada (que pode ser outro aplicativo).

Requer a OPEN_EXTERNAL_LINK permissão.

interface Request {
  url: string;
}

interface Response {
  // Se o jogador autorizou a abertura do link.
  success: boolean;
}

function openExternalUrl(Request): Promise<Response>;

openNftDialog

Mostre informações sobre um NFT ao jogador, usando uma UI apropriada.

interface Request {
  // O URN do NFT.
  urn: string;
}

interface Response {
  // Se o NFT foi localizado com sucesso e referenciado a uma imagem ou vídeo.
  success: boolean;
}

function openNftDialog(Request): Promise<Response>;

changeRealm (deprecated)

Troque o World Explorer para outro servidor de conteúdo, usando sua URL base.

Obsoleto em favor de teleportTo com um realm (e sem worldCoordinates para o spawn padrão do realm). changeRealm é resolvido assim que a alteração é aceita, e não quando o novo realm entra no ar, portanto um teleportTo emitido logo depois disso é executado no realm anterior.

interface Request {
  // A URL do novo realm.
  realm: string;

  // Uma mensagem opcional para mostrar aos usuários quando eles tiverem de aprovar a alteração.
  message?: string;
}

interface Response {
  // Se a alteração de realm foi autorizada e bem-sucedida.
  success: boolean;
}

function changeRealm(Request): Promise<Response>;

Tipos

O único tipo adicional usado pelos métodos neste módulo é o Vector3.

Vector3

Contém uma posição 3D relativa ou absoluta.

interface Vector3 {
  x: number;
  y: number;
  z: number;
}