QtCraft API C++ classes QML types Handbook

QcHandbookBuilder Namespace

Builds the handbook from a complete content registry (base game and mods, including the server-side world-generation data and chapters): every block, item, recipe, creature, biome, liquid, world generation feature and tag gets an entry with facts and links. More...

Header: #include <common/handbook/builder/QcHandbookBuilder.h>

Functions

QcHandbook build(const QcContentRegistry &content, const QString &language, const QMap<QString, double> &rules = {}, const QMap<QString, QStringList> &keys = {})

Detailed Description

Labels come from the content's translations ("handbook.*" keys), so the result only depends on the registry, the language and the rule values.

Function Documentation

QcHandbook QcHandbookBuilder::build(const QcContentRegistry &content, const QString &language, const QMap<QString, double> &rules = {}, const QMap<QString, QStringList> &keys = {})

Returns the handbook of content in language. rules are the values chapters refer to as {name} in their texts (e.g. {hunger.regenerationFood}) and creature pages show as caps; the server provides them (QcHandbookRules). Unknown placeholders are listed in QcHandbook::problems(). keys fill key placeholders such as {key.cameraView} with key names (QcKeyBindings::placeholderKeys(): the defaults for the export, the player's keys in the game); "handbook.key.<name>" translates a key name.