Цю сторінку ще не перекладено — показано англійську версію.

Схема в коді

Оголосіть модель у коді, надішліть її на платформу й отримайте типи назад. Так зі схемою працює розробник: адмін-панель і код описують одну й ту саму модель, а кодогенерація замикає коло для кожного рушія.

Коли це потрібно

• Модель даних має жити в коді й проходити рев’ю як код: оголосили, 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

Модель

З чого складається оголошення.

Що гарантує надсилання.

Що гарантує кодогенерація.

Що гарантує міграція.

Помилки

• Той, хто викликає без потрібної ролі, отримує forbidden, а розгорнута модель лишається недоторканою: відмова ніколи не буває частковим надсиланням. Це інша відмова, ніж застаріла ревізія: та повертає precondition_failed і означає, що diff рахували для схеми, яка відтоді змінилася. Порівняйте ще раз і надішліть знову.
• Значення поза оголошеною межею платформа відхиляє під час запису й ніколи не обрізає до межі. Так само з рядком, довшим за оголошену довжину. Обрізання дало б значення, яке коректне, але хибне.
• Недійсну послідовність UTF-8 платформа відхиляє під час запису, а не виправляє.
• Несумісну зміну збережуваних даних без оголошеної міграції опублікувати взагалі неможливо.

Обмеження

Обмеження, що випливають з оголошень, платформа перевіряє ще на етапі оголошення — під час розгортання чи публікації, а не при першому використанні, якщо під час роботи симптом не був би схожий на відмову. Конкретні числа з’являться разом із розділом про ліміти платформи.