QtCraft API C++ classes QML types Handbook

QcHandbookIndex Class

Reverse lookups over the content for the handbook pages, all in content order: recipes by result and ingredient, smelting by result and input, what drops an item, where a block occurs, which creatures spawn on it, machines by category and parts by base block. More...

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

Public Types

IngredientUse
Link

Public Functions

QcHandbookIndex(const QcContentRegistry &content, QcHandbookText &text, const QcHandbookLinks &links)
QList<QcHandbookIndex::Link> droppedBy(const QString &item) const
QList<QcHandbookIndex::Link> foundIn(const QString &block) const
QList<qsizetype> machinesByCategory(const QString &category) const
QStringList partsByBase(const QString &block) const
QList<QcHandbookIndex::IngredientUse> recipesByIngredient(const QString &item) const
QList<qsizetype> recipesByResult(const QString &item) const
QList<qsizetype> smeltingByInput(const QString &item) const
QList<qsizetype> smeltingByResult(const QString &item) const
QList<QcHandbookIndex::Link> spawnersOn(const QString &block) const

Detailed Description

Member Type Documentation

[alias] QcHandbookIndex::IngredientUse

A recipe index with the tag the item fits through (empty when named directly).

A link to an entry.

Member Function Documentation

QcHandbookIndex::QcHandbookIndex(const QcContentRegistry &content, QcHandbookText &text, const QcHandbookLinks &links)

Builds the lookups over content, with the titles and links of links. Reports recipes with tags no item has to text.

QList<QcHandbookIndex::Link> QcHandbookIndex::droppedBy(const QString &item) const

Returns links to the blocks and creatures that drop item, with the drop as note.

QList<QcHandbookIndex::Link> QcHandbookIndex::foundIn(const QString &block) const

Returns links to the biomes, ore veins and pools block occurs in.

QList<qsizetype> QcHandbookIndex::machinesByCategory(const QString &category) const

Returns indices into the content's blocks: the machines and campfires that work on the recipe category.

QStringList QcHandbookIndex::partsByBase(const QString &block) const

Returns the building parts made of the material whose base block is block.

QList<QcHandbookIndex::IngredientUse> QcHandbookIndex::recipesByIngredient(const QString &item) const

Returns the crafting recipes that take item, by name or through a tag.

QList<qsizetype> QcHandbookIndex::recipesByResult(const QString &item) const

Returns the indices of the crafting recipes that make item.

QList<qsizetype> QcHandbookIndex::smeltingByInput(const QString &item) const

Returns the indices of the smelting recipes that take item.

QList<qsizetype> QcHandbookIndex::smeltingByResult(const QString &item) const

Returns the indices of the smelting recipes that make item.

QList<QcHandbookIndex::Link> QcHandbookIndex::spawnersOn(const QString &block) const

Returns links to the creatures that spawn on block.