QcStructure Class

Member Function Documentation

void QcStructure::addCart(QcStructureDefinition::Cart cart)

Adds the minecart cart to a structure assembled in code.

void QcStructure::addContents(QcStructure::Contents placed)

Adds the chest or machine contents placed to a structure assembled in code.

void QcStructure::addGrowing(QcBlockPos cell)

Adds the sapling at the local cell, which starts growing when the world is made.

void QcStructure::addLabel(QcStructure::Label label)

Adds the floating label label to a structure assembled in code.

void QcStructure::addMob(QcStructure::Mob mob)

Adds the creature mob to a structure assembled in code (the showcase's areas).

std::optional<QcBlockId> QcStructure::block(int x, int y, int z) const

Returns the state of the cell x, y, z, std::nullopt where the structure keeps what is there (or outside it).

void QcStructure::connectBlocks(const QcContentRegistry &content, const QList<bool> &loose)

Sets the connection properties of the connecting blocks (fences, walls, panes, bars) in the cells marked in loose from their neighbours inside the structure, with the rules of QcBlockRules::connectedState and the block definitions of content (decision E-867). Rails and stairs keep theirs. Cells outside the structure and cells that keep what is there count as air: a fence at the edge does not reach out into the terrain.

bool QcStructure::contains(int x, int y, int z) const

Returns whether the local cell x, y, z lies inside the structure.

[static] QcStructure::Loaded QcStructure::fromDefinition(const QcStructureDefinition &definition, const QcContentRegistry &content)

Returns the structure of definition with its palette resolved to block states of content, with the connection properties of its connecting blocks set (connectBlocks()) and its extras copied. Unknown blocks fail; unknown state properties or values keep their defaults with a warning (warnings(), or QcLoadFailure::warnings for the entries before an unknown block).

bool QcStructure::hasSites() const

Returns whether placed copies have guardian zones or a spawn area (QcStructureSites).

[static] QList<bool> QcStructure::looseCells(const QStringList &palette, const QList<qint16> &cells)

Returns per cell of cells (indices into palette, cell order of QcStructureDefinition::cellIndex): whether the cell takes its connection properties from its neighbours, that is its palette entry names none of north, east, south, west and up (decision E-867).

const QString &QcStructure::name() const

Returns the structure's name.

const QList<QcBlockId> &QcStructure::palette() const

Returns the block states the cells refer to, in the order they were first set.

qint16 QcStructure::paletteIndex(int x, int y, int z) const

Returns the palette index of the cell x, y, z (or QcStructureDefinition::keep); precondition: contains(x, y, z).

void QcStructure::set(int x, int y, int z, QcBlockId state)

Sets the cell x, y, z to state, adding the state to the palette when it is new. Precondition: contains(x, y, z).

int QcStructure::sizeX() const

Returns the size along x in blocks (negative sizes given to the constructor become 0).

int QcStructure::sizeY() const

Returns the size along y in blocks.

int QcStructure::sizeZ() const

Returns the size along z in blocks.

const QStringList &QcStructure::warnings() const

Returns what fromDefinition() kept at a default (unknown state properties or values).

[static] const QStringList &QcStructure::warningsOf(const QcStructure::Loaded &loaded)

Returns the warnings of the resolution loaded, whether it succeeded or not (callers report them before the outcome).