Exemplos por kind 5 min de leitura

scene.controls: Controle de informações da cena

Adicione um botão funcional que leia a cena da montagem e mostre dimensões e grade no modal nativo.

O que você vai construir

Adicione um botão funcional que leia a cena da montagem e mostre dimensões e grade no modal nativo.

Superfície: scene.controls · Modo: augment · Gravewright 0.3.0 / SDK 1.x.

Quando monta e quem pode usar

Selecione uma cena e clique em Informações da cena. A montagem fornece sceneId, width, height e grid. maps.get verifica o nome da cena visível; não muda a seleção.

O dono instala o ZIP local em Módulos → Instalar módulo → Instalar por ZIP. Depois, o mestre ativa a versão na lista de extensões da mesa. O exemplo não pede permissões adicionais nem obtém um handle global; todas as leituras usam o api fornecido pela montagem. Mestre e jogador recebem somente os dados autorizados pelo servidor. Streamers não recebem esta montagem autenticada.

Baixe o pacote completo

Baixar ZIP dos fontes · manifest.json · main.mjs · styles.css · LICENSE.txt

Salve os quatro arquivos na mesma pasta. Compacte o conteúdo da pasta, com manifest.json diretamente na raiz do ZIP. Não inclua uma pasta extra, estado local ou chaves privadas. O upload local é uma decisão de confiança do dono; para distribuição por catálogo, use o fluxo de assinatura da referência de módulos.

scene-controls/
  manifest.json
  main.mjs
  styles.css
  LICENSE.txt

manifest.json

{
  "id": "example.surface-scene-controls",
  "name": "Scene information control",
  "version": "1.0.1",
  "sdk": {
    "requires": ">=1.0.0 <2.0.0",
    "tested": "1.0.0"
  },
  "description": "Add a working button that reads the mounted scene and opens its dimensions and grid in the native modal.",
  "author": "Gravewright documentation",
  "license": "MIT",
  "entry": "main.mjs"
}

main.mjs

// Original documentation example. License: MIT. Target: Gravewright 0.3.0, SDK 1.x.
export default {
  start({ api, styles }) {
    styles.use("styles.css");
    api.i18n.register({
      "en": {
        "Scene information": "Scene information",
        "Close": "Close",
        "Grid": "Grid",
        "Refresh": "Refresh",
        "Loading…": "Loading…",
        "Error: {code}": "Error: {code}",
        "Scene information control": "Scene information control"
      },
      "pt-BR": {
        "Scene information": "Informações da cena",
        "Close": "Fechar",
        "Grid": "Grade",
        "Refresh": "Atualizar",
        "Loading…": "Carregando…",
        "Error: {code}": "Erro: {code}",
        "Scene information control": "Controle de informações da cena"
      }
    });
  },
  register({ register }) {
    register("scene.controls", { mode: "augment", mount: this.mount });
  },
  async mount({ root, context, api, storage, viewport, events, signal, onDispose }) {
    const el = (tag, text) => {
      const node = root.ownerDocument.createElement(tag);
      if (text !== undefined) node.textContent = text;
      return node;
    };
    const t = (key, params) => api.i18n.t(key, params);
    const panel = el("section"); panel.className = "gw-example";
    const heading = el("h3", t("Scene information control"));
    const output = el("pre"); output.setAttribute("role", "status");
    panel.append(heading, output); root.append(panel);
    onDispose(() => panel.remove());
    const report = error => {
      if (!signal.aborted) output.textContent = t("Error: {code}", { code: error.code ?? "unavailable" });
    };
    const button = el("button", t("Scene information"));
    button.type = "button";
    panel.append(button);
    for (const type of ["pointerdown", "mousedown", "click"]) {
      panel.addEventListener(type, event => event.stopPropagation(), { signal });
    }
    let modal;
    onDispose(() => modal?.close(true));
    button.addEventListener("click", async () => {
      button.disabled = true;
      try {
        const scene = await api.maps.get(context.sceneId, {}, { signal });
        if (signal.aborted) return;
        modal?.close(true);
        const section = el("section");
        section.className = "gw-example";
        section.setAttribute("aria-label", t("Scene information"));
        section.append(el("h3", scene.name), el("p", context.width + " × " + context.height + " · " + t("Grid") + ": " + context.grid.size + "px / " + context.grid.distance + " " + context.grid.unit));
        const close = el("button", t("Close"));
        close.type = "button";
        close.addEventListener("click", () => section.close(), { signal });
        section.append(close);
        modal = api.ui.openModal(section);
      } catch (error) { report(error); }
      finally { if (!signal.aborted) button.disabled = false; }
    }, { signal });
  },
  stop() {
    // Mount and module lifetimes already dispose styles, catalogs and subscriptions.
  }
};

styles.css

.gw-example { box-sizing: border-box; max-width: 640px; padding: var(--space-3); margin: var(--space-2); border: 1px solid var(--border); border-radius: var(--radius-md); color: var(--text); background: var(--surface); font: 14px/1.5 system-ui, sans-serif; }
.gw-example h3 { font-size: 16px; margin: var(--space-0) var(--space-0) var(--space-2); }
.gw-example pre { white-space: pre-wrap; overflow-wrap: anywhere; font: inherit; }
.gw-example button, .gw-example select, .gw-example input { color: inherit; background: var(--surface); font: inherit; padding: var(--space-1) var(--space-2); margin: var(--space-1); border: 1px solid var(--border); border-radius: var(--radius-sm); }
.gw-example button:focus-visible, .gw-example input:focus-visible, .gw-example select:focus-visible { outline: 2px solid var(--accent); outline-offset: 2px; }
.gw-example--compact { padding: var(--space-1); }
.gw-example-center { position: absolute; transform: translate(-50%, -50%); pointer-events: none; color: var(--text); background: var(--surface); padding: var(--space-1); border-radius: var(--radius-sm); font: 14px/1.5 system-ui, sans-serif; }

Resultado esperado e liberação

Adicione um botão funcional que leia a cena da montagem e mostre dimensões e grade no modal nativo.

A interface nativa continua funcionando. Fechar a ficha, trocar a cena, sair da mesa ou desativar o módulo aborta a montagem. Os listeners usam signal; os eventos e elementos próprios são liberados por onDispose. A leitura assíncrona verifica o aborto e descarta respostas antigas antes de desenhar. Erros autorizados aparecem por error.code, sem esconder falhas de rede.

Valide em uma mesa descartável

Mova, amplie e troque a cena. Abra e feche o modal pelo teclado e desative o módulo enquanto ele estiver aberto.
Abra/feche três vezes e desative durante uma leitura ou modal pendente. Confira que nenhum painel ou erro antigo reaparece após o encerramento.
Teste estado vazio, nomes longos, teclado e janela estreita. Compare contas de mestre e jogador.
Confira o console. Estes exemplos têm testes do contrato de runtime; instalação e aparência ainda precisam ser validadas no host alvo.

Como usar a IA para esta superfície

Adapte o exemplo scene.controls para [objetivo concreto] no Gravewright 0.3.0.
Leia registry.json, o schema de contexto desta superfície, frontend.json e os serviços nativos usados.
Preserve start/register/stop, api da montagem, signal, onDispose e os modais nativos.
Mostre manifesto e arquivos completos. Não use app.shell/inside.content em pacotes.
Não invente campos de payload, regras de RPG no core, permissões ou APIs.
Teste jogador/mestre, dados vazios, aborto, montagem repetida e o comportamento específico do exemplo.
Explique limitações e o que foi realmente executado.

Continue

SDK · API · Exemplos por kind