QtCraft API C++ classes QML types Handbook

QcHandbookEntry Struct

One page of the handbook: a block, item, creature, biome, chapter ... with its facts, recipes and references to other pages. More...

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

Public Types

struct Fact
struct Link
struct Recipe
struct Section

Public Variables

QString category
QString englishTitle
QList<QcHandbookEntry::Fact> facts
QString icon
QString id
QString name
QString pack
QList<QcHandbookEntry::Section> sections
QString text
QString title

Detailed Description

All texts are already translated into the handbook's language.

Member Variable Documentation

QString QcHandbookEntry::category

The group the entry is listed under ("blocks", "items", "tools", "playing", ...).

QString QcHandbookEntry::englishTitle

Title in English, searched in every language.

QList<QcHandbookEntry::Fact> QcHandbookEntry::facts

The rows of the facts table.

QString QcHandbookEntry::icon

The item whose icon stands for the entry; may be empty.

QString QcHandbookEntry::id

"block:qtcraft:stone", "item:qtcraft:coal", "mob:...", "biome:...", "chapter:...", "tag:...", "ore:...", "feature:...", "world:terrain", "table:fuels", ...

QString QcHandbookEntry::name

Content name the entry describes; empty for overviews.

QString QcHandbookEntry::pack

Pack the entry belongs to (the namespace of its name).

QList<QcHandbookEntry::Section> QcHandbookEntry::sections

The parts of the page, in order.

QString QcHandbookEntry::text

Description from the content's translations; empty when there is none.

QString QcHandbookEntry::title

The page's title.