Esta página ainda não foi traduzida: mostrando a versão em inglês.

Esquema como código

Declare o modelo em código, publique e receba os tipos de volta. É por aqui que o desenvolvedor chega ao esquema: o painel de administração e o código editam o mesmo modelo, e a geração de código fecha o ciclo para cada engine.

Quando usar

• O modelo de dados deve morar no código e passar por revisão como código: declare, schema diff, schema push.
• Os tipos da engine nunca podem se afastar do modelo publicado: schema codegen gera de novo o código Unreal C++ e Unity C#.
• Uma mudança incompatível precisa poder ser lida e cancelada antes de rodar: propor → planejar → aplicar.
• Você reaproveita o mesmo pacote (Stat, Interactable) em vários projetos: declare-o uma vez como preset.
• Dispensável quando um operador só ajusta valores no painel de administração. Mesmo assim, a mudança no modelo aparece no diff contra o código.

Quem faz o quê

Resumo

[Entity("item")]
public class Item
{
    public string Name = "";
    public Rarity Rarity;              // an enum declared the same way
    public Stats Stats = new();        // a part — embedded, no lifecycle of its own
}

[Part("stats")]
public class Stats { public int Power; public int Weight; }

@Entity('item')
export class Item {
  name = '';
  rarity!: Rarity;                   // an enum declared the same way
  stats = new Stats();               // a part — embedded, no lifecycle of its own
}

@Part('stats')
export class Stats { power = 0; weight = 0; }

@entity("item")
class Item:
    name: str = ""
    rarity: Rarity                     # an enum declared the same way
    stats: Stats = Stats()             # a part — embedded, no lifecycle of its own

@part("stats")
class Stats:
    power: int = 0
    weight: int = 0

USTRUCT(PSPart = "stats")
struct FItemStats
{
    GENERATED_BODY()

    UPROPERTY() int32 Power;
    UPROPERTY() int32 Weight;
};

UCLASS(PSEntity = "item")
class UItem : public UObject
{
    GENERATED_BODY()

    UPROPERTY() FString    Name;
    UPROPERTY() EPSRarity  Rarity;       // an enum declared the same way
    UPROPERTY() FItemStats Stats;        // a part — embedded, no lifecycle of its own
};
// declarations compile into the same pushed model — playserv push from the UE project or CI

[Entity("item")]
public class Item
{
    public string Name = "";
    public Rarity Rarity;              // an enum declared the same way
    public Stats Stats = new();        // a part — embedded, no lifecycle of its own
}

[Part("stats")]
public class Stats { public int Power; public int Weight; }

playserv schema diff       # local declarations vs deployed schema
playserv schema push       # with a revision precondition — no blind overwrites
playserv schema codegen    # regenerate Unreal C++ / Unity C# types

O modelo

O que uma declaração carrega.

O que uma publicação garante.

O que a geração de código garante.

O que uma migração garante.

Erros

• Quem chama sem o papel (role) recebe forbidden, e o modelo publicado fica intacto: uma recusa nunca é uma publicação parcial. Essa recusa é diferente da revisão desatualizada, que vem como precondition_failed e significa que o diff foi calculado contra um esquema que mudou desde então. Faça o diff de novo e publique outra vez.
• Um valor fora de um limite declarado é recusado na escrita, e nunca ajustado ao limite. O mesmo vale para uma string maior que o comprimento declarado. Ajustar o valor ao limite produziria um valor válido — e errado.
• Uma sequência UTF-8 inválida é rejeitada na escrita, e não corrigida.
• Uma mudança persistente incompatível sem migração declarada não pode ser publicada de jeito nenhum.

Limites

Os tetos que dependem da forma da declaração são verificados no momento da declaração — no deploy ou na publicação — e não no primeiro uso, sempre que o sintoma em runtime não pareceria uma recusa. Os números chegam com o capítulo sobre os limites da plataforma.