Esta página ainda não foi traduzida: mostrando a versão em inglês.
Referência de objetos do Schema
Um Schema é feito de três tipos de objeto, e os objetos são feitos de campos. As Entities guardam os Records do seu jogo, as Parts são grupos reutilizáveis de campos dentro delas e os Enums são listas fixas de valores. Esta página é a referência de cada um; Building a Game Schema mostra como criá-los.
Entities, Parts e Enums
| Objeto | O que é | Tem Records próprios | Exemplo |
|---|---|---|---|
| Entity | Um objeto independente: uma tabela de Records que o seu jogo lê e grava. | Sim, listados em Data | Ships, Pilots, MatchResults |
| Part | Um grupo reutilizável de campos que só existe dentro de uma Entity ou de outra Part. | Não, os valores dela ficam no Record que a inclui | Stats, Loadout |
| Enum | Uma lista fixa de valores permitidos para um campo. | Não | ShipClass: Fighter, Bomber, Scout |
Tipos de campo
Todo campo tem um tipo, e é ele que decide o que o campo guarda.
| Tipo | Guarda | Alvo | Cardinalidade |
|---|---|---|---|
| Primitive | Um valor direto, de um dos tipos primitivos. | — | Um valor |
| Enum reference | Um valor de um Enum. | Um Enum | Um valor |
| Relationship → entity | Um vínculo com um Record de outra Entity, pelo ID dele. | Uma Entity | 1-para-1 ou 1-para-muitos |
| Inclusion ↳ part | Os campos de uma Part, embutidos neste Record. | Uma Part | 1-para-1 ou 1-para-muitos |
Relationship e inclusion ligam objetos, mas de formas diferentes. Um relationship aponta para um Record que existe por conta própria e pode ser compartilhado: um piloto aponta para uma nave, e vários pilotos podem apontar para a mesma nave. Um inclusion embute uma estrutura que pertence ao objeto pai e não tem vida própria: os Stats de uma nave só existem como parte daquela nave.
Tipos primitivos
| Tipo | Guarda |
|---|---|
| Text | Uma string curta |
| Long text | Uma string de várias linhas |
| Integer | Um número inteiro |
| Number | Um número de ponto flutuante |
| Decimal | Um número de precisão fixa |
| Boolean | true ou false |
| Date & time | Um timestamp ISO |
| Date | Uma data, YYYY-MM-DD |
| UUID | Um identificador único |
| JSON | Um objeto estruturado |
| Um endereço de e-mail validado | |
| URL | Um link |
Configurações de campo
| Configuração | Significado |
|---|---|
| Name | Letras, dígitos e sublinhados, começando com uma letra, com até 64 caracteres. Id, CreatedAt e UpdatedAt são reservados. |
| Default | O valor que um novo Record recebe quando nenhum é informado. |
| Required | Um Record não pode ser salvo sem um valor. |
| Unique | Dois Records não podem ter o mesmo valor. |
| Indexed | Acelera a filtragem e a ordenação por este campo. |
Configurações da Entity
Além dos campos, uma Entity tem algumas configurações. Elas ficam no editor da Entity: New ▾ → Entity para uma nova, ou o lápis ao lado do nome dela.
| Configuração | O que faz |
|---|---|
| Singleton entity | A Entity guarda exatamente um Record, sem chave de negócio própria; as referências a ela dispensam o ID. Use para configurações globais, como as regras de partida. Em Data, ela aparece como um único formulário em vez de uma lista. |
| Display field | O campo que representa um Record onde quer que ele seja referenciado: células de relação, o painel do Record, o seletor de Records. Auto escolhe um para você. |
| Access control | Quem pode ler e gravar os Records da Entity. Veja Access Control. |
| Owned by player | Cada Record pertence a um Player, marcado pelo servidor quando um Player o cria. Veja Entities com posse pelo Player. |
| Read access | Para uma Entity com posse pelo Player: Owner, cada Player lê só os próprios Records, ou Public, todos podem ler todos os Records. |
| On player delete | Obrigatório para uma Entity com posse pelo Player: o que acontece com os Records de um Player quando ele é excluído. |
| On player delete | Os Records do Player são |
|---|---|
cascade-delete | Excluídos junto com o Player. |
anonymise | Mantidos, com o dono substituído por um marcador anônimo estável. |
restrict | Mantidos, e o Player não pode ser excluído enquanto existir algum. |
Raw fields
Por padrão, um Record só pode ter os campos que a Entity dele declara. Em vez disso, uma Entity pode permitir raw fields: os Records passam a aceitar chaves extras que o Schema não define, para dados livres que você não quer modelar. Raw fields não podem ser filtrados, ordenados nem indexados, e só são acessíveis lendo o Record. Eles são ativados pela API ou pelo MCP; o Backoffice não tem uma configuração para eles.
Raw fields trocam estrutura por flexibilidade
Os campos declarados são validados, tipados e consultáveis; os raw fields não são nada disso. Use-os para dados que você sempre lê por inteiro e modele tudo em que vai querer pesquisar.
Schemas publicados a partir do código
Uma Entity ou Part pode vir do código do seu jogo em vez do Backoffice, publicada com a ferramenta de Schema do SDK. Ela passa a ter o rótulo CODE: a estrutura fica somente leitura no Backoffice e as mudanças vêm do código, enquanto os Records continuam editáveis em Data. Uma publicação a partir do código não pode assumir um objeto de mesmo nome criado no Backoffice.
Próximos passos
- Construir o Schema do jogo — crie objetos e campos e depois revise e aplique as mudanças
- Trabalhar com os dados do jogo — os Records das suas Entities
- Controle de acesso — quem pode ler e gravar cada Entity
Atualizado em 16 de out. de 2026