Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

GroundPaintRectangle

A rectangle of the ground drawn in one material over the map’s own.

Property Type Description
center readonly [number, number] The rectangle’s center, x and z, in metres.
material string A material the ground draws: a built-in, such as "dirt", or one the game’s src/maps/materials.json or the map’s materials add.
positions? undefined A list’s, which a rectangle takes none of.
replace? readonly string[] Paint only cells that show one of these materials, as Roblox’s Terrain:ReplaceMaterial takes a source material: a path over grass but not over road. A cell shows its overlay where the overlay’s blend is over one half, and its base otherwise, after every paint below this one. Left out, every cell; empty, none.
rotationRadians? number Radians about y, about the center: positive turns +x toward -z, as three.js’s rotation.y does. Left out, 0.
size readonly [number, number] Its full width along x and depth along z, in metres, before its rotation. Each cell whose centre falls inside takes the material, with no overlay, so the edge follows the map’s cells and blends as the ground’s own paint does.
sortOrder? number Where two paints cover one cell, the higher draws, as Unreal’s decal SortOrder. Left out, 0. Of two at the same order, the material later by code point draws, the same on every page.