Эта страница ещё не переведена — показана английская версия.

Схема в коде

Объявите модель в коде, отправьте её на платформу и получите типы обратно. Так со схемой работает разработчик: админ-панель и код описывают одну и ту же модель, а кодогенерация замыкает круг для каждого движка.

Когда это нужно

• Модель данных должна жить в коде и проходить ревью как код: объявили, schema diff, schema push.
• Типы в движке не должны расходиться с развёрнутой моделью: schema codegen заново генерирует Unreal C++ и Unity C#.
• Несовместимое изменение нужно прочитать и при необходимости отменить до того, как оно выполнится: предложить → спланировать → применить.
• Один и тот же набор (Stat, Interactable) нужен в нескольких проектах: объявите его один раз как пресет.
• Не нужно, если оператор только подправляет значения в админ-панели. Изменение модели, сделанное там, всё равно вернётся в код через diff.

Кто что делает

Коротко

[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

Модель

Из чего состоит объявление.

Что гарантирует отправка.

Что гарантирует кодогенерация.

Что гарантирует миграция.

Ошибки

• Вызывающий без нужной роли (role) получает forbidden, и развёрнутая модель остаётся нетронутой: отказ никогда не оборачивается частичной отправкой. Это не то же самое, что устаревшая ревизия. Она возвращает precondition_failed и означает, что diff считался по схеме, которая с тех пор изменилась, — пересчитайте diff и отправьте снова.
• Значение за пределами объявленных границ при записи отклоняется, а не обрезается до границы. То же со строкой длиннее объявленной. После обрезки значение было бы допустимым, но неверным.
• Некорректная последовательность UTF-8 при записи отклоняется, а не исправляется.
• Несовместимое изменение хранимых данных без объявленной миграции опубликовать нельзя вообще.

Ограничения

Потолки, которые задаёт сама форма объявлений, проверяются в момент объявления — при деплое или публикации, а не при первом использовании, если во время работы превышение не выглядело бы как отказ. Конкретные числа появятся вместе с главой об ограничениях платформы.