Log inGet started
Package

Cabin.module

This package holds more than this page lists. See all of its files in its world.

README.md

Cabin

Assembles alpineProps' baked structure parts (wall sections, corners, windows, doors, gables, roofs, chimney, foundation, porch, bench, woodpile, trough) into a whole mountain hut. The Cabin component calls it; call it yourself to place huts from code or to lay out a single part.

local Cabin = require("alpineProps.Cabin")
local hut = Cabin.build("logHut", { parent = root, position = { 0, 0, 0 }, yaw = 0.4, season = "winter", snow = true, seed = 7 })
hut:destroy()
  • Cabin.STYLES: logHut, stoneHut, aFrame.
  • Cabin.build(style, opts) builds temporary child entities, each with a box collider, and returns { root, style, parts, colliders, destroy }. Opts: parent, position, yaw, season, look, snow, seed.
  • Cabin.layout(style) is the list of placements { kind, v, p, yaw } in the hut frame; Cabin.footprint(style) its size.
  • Cabin.placePart(parent, kind, variant, position, yaw, opts) places one part with its colliders.

The front (door side) faces local +Z and the origin is the ground at the centre of the footprint.