Schematy frameworków

Plik frameworka

Każdy plik w schemas/ deklaruje jeden framework. Strony referencyjne rozbudowują postać Keeper z szybkiego startu. Ma teraz wybór Calling, wartość pochodną Guard, gotowy zestaw, sekcję i podrzędnego Lamp.

manifest/project.json
schemas/keeper.json
schemas/lamp.json
rules/keeper.ts
rules/lamp.ts
rules/hurt.ts
rules/heal.ts
rules/guard.ts
layouts/keeper.json
layouts/lamp.json
scenarios/new-keeper.json
scenarios/heal.json
scenarios/new-lamp.json

Pola podstawowe

W GRZE framework wejściowy w manifeście musi być postacią grywalną.

The entry framework must be a character constructor.

Dane wejściowe

Dana wejściowa dostosowuje jeden parametr konstruktora, a jej klucz musi odpowiadać nazwie parametru. Większość danych potrzebuje tylko etykiety. Pozostałe klucze zawężają to, co może wpisać gracz.

  "inputs": {
    "name": { "label": "Name" },
    "max_hp": {
      "label": "Maximum HP",
      "description": "How much damage a Keeper can take.",
      "defaultValue": 10,
      "min": 1,
      "max": 40
    },
    "calling": {
      "label": "Calling",
      "options": ["Guard", "Scout"],
      "defaultValue": "Guard"
    },
    "lamp": { "label": "Lamp", "defaultValue": "lamp", "hidden": true }
  },

{
  "id": "keeper",
  "name": "Keeper",
  "elementType": "character",
  "constructor": "rules/keeper.ts",
  "inputs": {
    "name": { "label": "Name" },
    "max_hp": {
      "label": "Maximum HP",
      "description": "How much damage a Keeper can take.",
      "defaultValue": 10,
      "min": 1,
      "max": 40
    },
    "calling": {
      "label": "Calling",
      "options": ["Guard", "Scout"],
      "defaultValue": "Guard"
    },
    "lamp": { "label": "Lamp", "defaultValue": "lamp", "hidden": true }
  },
  "childFrameworks": { "lamp": "lamp" },
  "sections": [
    {
      "id": "basics",
      "title": "Basics",
      "inputs": ["name", "max_hp", "calling", "lamp"]
    }
  ],
  "actions": [
    { "id": "hurt", "name": "Take damage", "source": "rules/hurt.ts" },
    { "id": "heal", "name": "Heal", "source": "rules/heal.ts" }
  ],
  "ledgerFunctions": [
    {
      "id": "guard",
      "name": "Guard",
      "field": "guard",
      "source": "rules/guard.ts"
    }
  ],
  "frames": [
    { "id": "sheet", "source": "layouts/keeper.json", "default": true }
  ],
  "content": [
    {
      "id": "mira-scout",
      "name": "Mira the Scout",
      "parameters": {
        "name": "Mira",
        "max_hp": 8,
        "calling": "Scout",
        "lamp": "lamp"
      }
    }
  ]
}

Wartość domyślna spoza opcji zostanie odrzucona.

{
  "calling": {
    "label": "Calling",
    "options": ["Guard", "Scout"],
    "defaultValue": "Mage"
  }
}

Default for calling must be one of its options ("Guard", "Scout").

Scenariusze i zestawy też muszą mieścić się w granicach.

Parameter max_hp 99 is not between 1 and 40.

Ukryte dane wejściowe bez wartości domyślnej kończą się błędem:

Input name is hidden, so it must declare a defaultValue.

Akcje i funkcje ledgera

Każda akcja ma id, nazwę i plik źródłowy. Każda funkcja ledgera ma to samo, plus pole. Pole to zapisana wartość, którą funkcja wylicza, i musi być polem skalarnym zwracanym przez konstruktor. Funkcja ledgera czyta wartości i zwraca wartość pochodną. Nigdy nie zapisuje.

  "ledgerFunctions": [
    {
      "id": "guard",
      "name": "Guard",
      "field": "guard",
      "source": "rules/guard.ts"
    }
  ],

function base_guard(calling: string): number {
  return calling === "Guard" ? 3 : 1;
}

export function guard(currentValue: number, self: ElementRef): number {
  const calling: string = element.var(self, "calling") as string;
  return base_guard(calling);
}

Ledger function must target an existing scalar field.

Id muszą być unikalne w obrębie Frameworka. Akcje i funkcje ledgera dzielą jeden zestaw id.

Duplicate semantic identity or source path.

Dwie funkcje ledgera mogą dzielić jeden plik źródłowy. Akcja i funkcja ledgera nie mogą:

action source does not match its owner contract

Dane wejściowe akcji

Wejścia akcji to parametry jej funkcji. Sygnatura je deklaruje, a schemat może dodać wpis dla każdego z nich. Każde wejście to liczba, tekst lub wartość prawda/fałsz.

Gracz jest pytany o każde wejście w oknie dialogowym, gdy użyje przycisku. Okno nazywa wejście nazwą jego parametru, chyba że wpis nadaje mu etykietę. Wpis może też podać opis i wartość domyślną. Wejście liczbowe może mieć minimum i maksimum. Wejście tekstowe może mieć listę opcji lub opcje z tabeli. Okno pokazuje to wszystko, a serwer odrzuca wartość spoza granic lub opcji. Przycisk nie może przekazać wartości. Nazwij każdy parametr tak, żeby gracz mógł go przeczytać: roll, a nie r.

    {
      "id": "check_lore",
      "name": "Lore check",
      "source": "rules/check-lore.ts",
      "inputs": { "roll": { "label": "Roll", "min": 1, "max": 100 } }
    }

Minimum i maksimum nie zatrzymają liczby z ułamkiem. Jeśli reguła potrzebuje liczby całkowitej, sprawdza to sama, a krok scenariusza to dowodzi. Krok scenariusza spoza granic jest odrzucany.

export function check_lore(self: ElementRef, roll: number): void {
  if (math.floor(roll) === roll) {
    const lore: number = element.var(self, "lore") as number;
    ledger.set(self, "last_target", lore);
    ledger.set(self, "last_roll", roll);
  }
}

Dane wejściowe tekstowe mogą zamiast tego oferować listę wyborów z tabeli podręcznika. Strona Tabele podręcznika pokazuje, jak.

Wejście tekstowe może zamiast tego wybrać po nazwie jedno z zapisanych pól Frameworka, za pomocą listy fields. Strona Pisanie reguł pokazuje akcję, która z tego korzysta.

Dane wejściowe liczbowe mogą poprosić serwer o rzut. Dodaj klucz roll z jednym wyrażeniem kości, takim jak "roll": "1d100" lub "roll": "2d6+1". Okno pokazuje wtedy przycisk Rzuć zamiast pola, w którym gracz wpisuje liczbę. Serwer rzuca, a okno pokazuje sumę, której gracz nie może zmienić. Rzucić można tylko parametr liczbowy. Kompilator odrzuca roll razem z defaultValue oraz wyrażenie kości, którego serwer nie przyjmuje.

Rzucane dane wejściowe zużywają się raz: akcja bierze rzut, gdy się wykonuje, a nowy rzut unieważnia wcześniejsze niezużyte rzuty tych danych. Rzut jest powiązany ze swoją kampanią i wygasa po 15 minutach. Strona Układy i karty pokazuje, co widzi stół.

Wiersz dziennika akcji

Akcja może opublikować wiersz z wynikiem w dzienniku stołu. Dodaj szablon dziennika do wpisu akcji w schemacie, na przykład "log": "{name} takes {amount} damage, defense {defense}". Serwer wypełnia każdy symbol zastępczy {name} jako zwykły tekst po zapisaniu akcji. Przeglądarka nigdy nie wysyła tego wiersza.

Symbol zastępczy może wskazywać wejście akcji albo pole liczbowe, tekstowe lub prawda/fałsz tego samego Frameworka. Kompilator odrzuca ukryte wejście, pole zdrowia (hp, current_hp, hit_points, temp_hp, current_health, max_health, hitPoints oraz pola zdrowia i stanów bloku walki), nazwę, która nie istnieje, szablon dłuższy niż 200 znaków, więcej niż 16 symboli zastępczych, pojedynczy nawias klamrowy i znak sterujący. Gdy wejście i pole mają tę samą nazwę, wygrywa wejście. Wartości pochodzą z chwili po akcji, więc pole zapisane przez akcję pokazuje nową wartość. Pole obliczane nie jest przeliczane ponownie, więc pokazuje wartość sprzed akcji.

Gracz, który działa swoją postacią, widzi wiersz w tym samym gronie, co jego rzuty kośćmi: wszyscy, tylko on albo on i MG. We wszystkich innych przypadkach, także gdy MG działa dowolną postacią, wiersz trafia tylko do członków kampanii, którzy mogą odczytać tę postać. Jeśli grono to wszyscy, ale któryś członek nie może odczytać postaci, wiersz idzie jako prywatna wiadomość do tych, którzy mogą. Stół pokazuje wiersz z etykietą Gra, żeby nikt nie wziął go za wiadomość gracza.

Zestawy treści

Zestaw to nazwany zbiór wartości danych wejściowych, na przykład gotowa postać. Fabled sprawdza każdy zestaw jak scenariusz, więc każda wartość musi pasować do swojej danej. Gra może mieć do 512 zestawów na framework.

  "content": [
    {
      "id": "mira-scout",
      "name": "Mira the Scout",
      "parameters": {
        "name": "Mira",
        "max_hp": 8,
        "calling": "Scout",
        "lamp": "lamp"
      }
    }
  ]

Sekcje

Sekcje grupują dane wejściowe w kroki kreatora tworzenia. Gdy framework deklaruje sekcje, każda dana wejściowa musi być na liście jednej z nich, także ukryte.

  "sections": [
    {
      "id": "basics",
      "title": "Basics",
      "inputs": ["name", "max_hp", "calling", "lamp"]
    }
  ],

Input lamp is not assigned to any section.

Podrzędne frameworki

Podrzędny framework to część większego elementu, na przykład Lamp, którą nosi Keeper. Element podrzędny ma własny schemat, konstruktor, ramkę i scenariusz.

  "childFrameworks": { "lamp": "lamp" },

{
  "id": "lamp",
  "name": "Lamp",
  "elementType": "item",
  "constructor": "rules/lamp.ts",
  "inputs": {
    "name": { "label": "Name" },
    "oil": { "label": "Oil", "defaultValue": 5 }
  },
  "frames": [{ "id": "card", "source": "layouts/lamp.json", "default": true }]
}

Element nadrzędny łączy nazwę miejsca z id frameworka w childFrameworks. Odwołanie przechowuje ukryta dana wejściowa. Konstruktor zwraca dane wejściowe elementu podrzędnego obok własnych wartości.

export function construct(
  name: string,
  max_hp: number,
  calling: string,
  lamp: FrameworkRef,
): {
  values: { name: string; max_hp: number; hp: number; calling: string; guard: number };
  children: { lamp: { framework: FrameworkRef; params: { name: string; oil: number } } };
} {
  return {
    values: { name: name, max_hp: max_hp, hp: max_hp, calling: calling, guard: 0 },
    children: { lamp: { framework: lamp, params: { name: "Lantern", oil: 5 } } },
  };
}

Każdy framework, także podrzędny, musi zwracać nazwę.

must define the required 'name' value, normally as a string constructor field.

Miejsce wskazujące framework spoza gry kończy się błędem:

Invalid child Framework constraint: lamp.

Pola zaawansowane

Dalej