Log inGet started
Package

sceneKit.module

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

README.md

sceneKit

The small builder the Tidewater starter scenes share (tidewater.scenes.*): called from a scene's build.luau content(), it places the player (prototype + spawn facing a given heading), the sky, sun, ambient and atmosphere for a time of day, box props with colliders, and floating props (a synced dynamic body with FluidForces) that ride whatever Tidewater water they are dropped in.

local Kit = require("~.scenes.sceneKit")
Kit.player({ 10, 2, -5 }, 135)                       -- spawn at a point, facing 135 deg (0 = +Z)
Kit.sky({ timeOfDay = 12.5, sunPeak = 4, aerial = 0.8 })
Kit.box(parent, "pier", "sc_planks", { 0, 1, 0 }, { 2, 0.2, 10 }, { yaw = 15, collide = true })
Kit.floater("crate", "sc_crate", { 3, 1, 8 }, { 1, 1, 1 }, { density = 0.45 })

Kit.material(name) resolves one of the scenes' materials (scenes/materials/sc_*) or the package's tw_* materials. Nothing here is required by a game using Tidewater; it is the scenes' own scaffolding, readable as a reference for setting a scene around water.