QtCraft API C++ classes QML types Handbook

QcMineshaftPlan::Entrance Struct

struct QcMineshaftPlan::Entrance

The way up to the surface (QcMineshaftAccess): a ladder shaft from the central room through the ground under a headframe, or an inclined tunnel from a side of the central room or of a dead end of the top level up to the ground (decision E-895). More...

Public Types

enum class Kind { Ladder, Incline }

Public Variables

QList<QcPlacedBlock> blocks
QcMineshaftPlan::Entrance::Kind kind
QList<QcBlockPos> lining
QcBlockPos out
QList<QcBlockPos> shaft
QcBlockPos top

Detailed Description

The terrain generator builds it after its trees, cacti and surface pools (QcMineshaftBuilder::buildEntrance), so none of them blocks it.

Member Type Documentation

enum class Entrance::Kind

The kind of way up.

ConstantValueDescription
QcMineshaftPlan::Entrance::Kind::Ladder0A ladder shaft under a headframe.
QcMineshaftPlan::Entrance::Kind::Incline1An inclined tunnel (QcMineshaftIncline).

Member Variable Documentation

QList<QcPlacedBlock> Entrance::blocks

The ladder from the room's floor up and the headframe, or the tunnel's supports and rails.

QcMineshaftPlan::Entrance::Kind Entrance::kind

The kind of way up.

QList<QcBlockPos> Entrance::lining

Cells around the shaft (under the tunnel's steps) that become planks where they are not solid.

QcBlockPos Entrance::out

The open cell at the top of the way up, from which one steps onto the ground: two above top for the ladder, the last feet cell of the tunnel's middle lane for an incline.

QList<QcBlockPos> Entrance::shaft

The open cells: the ladder shaft from above the central room to two cells above top, or the tunnel.

QcBlockPos Entrance::top

Ladder: the shaft's top cell, in the ground's top block. Incline: the ground's top block in front of the tunnel's mouth. The box of 3 x 3 x 3 cells above it is cleared, and the leaves and cacti of the 5 x 5 ring around that box.