QtCraft API C++ classes QML types Handbook

QcFaceOffset Struct

The step from a block to its neighbour across one face, in blocks. More...

Header: #include <common/core/QcBlockFace.h>
enum class QcBlockFace { East, West, Up, Down, South, North }
const std::array<QcBlockFace, qcBlockFaceCount> qcAllBlockFaces
const int qcBlockFaceCount
QcFaceOffset qcFaceOffset(QcBlockFace face)
QcBlockPos qcNeighbour(QcBlockPos pos, QcBlockFace face)

Detailed Description

Related Non-Members

enum class QcBlockFace

Six axis-aligned block faces.

The order is part of the content format (face texture arrays).

ConstantValueDescription
QcFaceOffset::QcBlockFace::East0+X
QcFaceOffset::QcBlockFace::West1-X
QcFaceOffset::QcBlockFace::Up2+Y
QcFaceOffset::QcBlockFace::Down3-Y
QcFaceOffset::QcBlockFace::South4+Z
QcFaceOffset::QcBlockFace::North5-Z

const std::array<QcBlockFace, qcBlockFaceCount> qcAllBlockFaces

All faces in the order of the enum.

const int qcBlockFaceCount

The number of faces.

[constexpr] QcFaceOffset qcFaceOffset(QcBlockFace face)

Returns the step across face: East = +X, Up = +Y, South = +Z.

[constexpr] QcBlockPos qcNeighbour(QcBlockPos pos, QcBlockFace face)

Returns the block next to pos across face.