QtCraft API C++ classes QML types Handbook

QcMineshaftIncline Class

An inclined tunnel from the top level of a mine shaft up to the ground (decision E-895), the second kind of surface entrance besides the ladder shaft (QcMineshaftAccess): three cells wide and four high like a staircase between levels, it leaves the middle of a free side of the central room or of a dead end of the top level one step up and rises one block per cell until the ground in front of it lies below its next step (the mouth). More...

Header: #include <worldgen/mineshafts/QcMineshaftIncline.h>

Public Types

struct Exit

Public Functions

std::optional<QcMineshaftPlan::Entrance> through(const QcMineshaftPlan &plan, QcMineshaftSite &site, QcMineshaftIncline::Exit exit, bool rails) const

Detailed Description

Steps are full blocks (planks where the ground is open), a support (two posts, a beam in the top row) stands every supportSpacing cells and at the mouth, and with railChance rails rise up the middle lane from the node's edge. Planned from the terrain noise alone like the rest of the mine shaft: no cave along it, no village or surface structure where it runs near the surface, nothing of the plan but its node within a cell of it, and the whole tunnel inside the mine shaft's extent (so inside its region).

Member Function Documentation

std::optional<QcMineshaftPlan::Entrance> QcMineshaftIncline::through(const QcMineshaftPlan &plan, QcMineshaftSite &site, QcMineshaftIncline::Exit exit, bool rails) const

Returns the tunnel out of exit of plan, with rails when rails, if it fits there (the ground checked through site); std::nullopt otherwise.