QtCraft API C++ classes QML types Handbook

QcHandbookChapter Struct

A chapter of the handbook about playing (controls, hunger, death ...), from handbook/*.json. More...

Header: #include <common/handbook/QcHandbookChapter.h>

Public Variables

QString iconItem
QString name
int order
QStringList related
QStringList sections
QString titleKey

Static Public Members

const int maxRelated
const int maxSections

Detailed Description

All text comes from translations: the title from titleKey, each section from "<titleKey>.<section>.title" and "<titleKey>.<section>.text". Server side only.

Member Variable Documentation

QString QcHandbookChapter::iconItem

Item, or else creature (decision E-944), whose icon stands for the chapter; empty for none.

const int QcHandbookChapter::maxRelated

The most related names of a chapter.

const int QcHandbookChapter::maxSections

The most sections of a chapter.

QString QcHandbookChapter::name

The chapter's content name.

int QcHandbookChapter::order

Chapters are listed by this number, then by name.

Content names (blocks, items, creatures, biomes) the chapter links to.

QStringList QcHandbookChapter::sections

The section names, in order (see the struct).

QString QcHandbookChapter::titleKey

The translation key of its title (see the struct).