Log inGet started
World

Turquoise Cay

Merged

tropicalKit 1.2.0: keepClear areas where nothing is scattered

#8
Author
claude-code @ auraAgent
Opened
Nov 15, 2026
From
keepclear-1-2-clean
Into
main
Merged
Nov 15, 2026

Supersedes #7 (which carried unrelated scene authoring files); this branch touches tropicalKit.package only.

A level builder who places their own buildings and decks on an island (a warehouse on a stilted dock yard by the pier) got palms, bushes and rocks growing through floor and roof: the scatter only kept clear of the island's own stops and pier.

  • New synced field keepClear on Island (Field.table, default {}): circles { x, z, r } and boxes { x, z, w, d, yaw? } (world metres, yaw degrees about +Y, w along the box's X, d along its Z).
  • IslandBuilder.build / planFor accept keepClear; IslandRules.scatter honours it in every layer (palms, shrubs, cover, rocks, cliffs, coral, sea grass, tide-line litter) and for the coconuts dropped at palm feet. ShellHunt keeps its shells out too. IslandRender draws only the given instances, so it needs no change.
  • Rules.clearAreas / Rules.inClear test points.
  • Ground cache unaffected: keyFor (the terrainData name) is unchanged; new placementKeyFor = ground key + hash of the areas, which the Island compares to decide a rebuild. Changing keepClear in edit re-places the props on the saved ground (verified: 67 props in a 30x20 box by the pier -> 0, ground key unchanged).
  • Tests: two new cases (area maths; no prop inside a circle and a turned box, the rest unchanged). 11/11 pass.
  • README "What you set" row + example; version 1.2.0.

16 files changed

  • ChangedtropicalKit.packageFolderBeforeAfter
  • ChangedtropicalKit.package/Island.componentFolderBeforeAfter
  • ChangedtropicalKit.package/Island.component/README.md387 B → 521 BBeforeAfter
  • ChangedtropicalKit.package/Island.component/init.luau9.3 KB → 9.9 KBBeforeAfter
  • ChangedtropicalKit.package/IslandBuilder.moduleFolderBeforeAfter
  • ChangedtropicalKit.package/IslandBuilder.module/README.md481 B → 492 BBeforeAfter
  • ChangedtropicalKit.package/IslandBuilder.module/init.luau22.4 KB → 23.2 KBBeforeAfter
  • ChangedtropicalKit.package/IslandRules.moduleFolderBeforeAfter
  • ChangedtropicalKit.package/IslandRules.module/README.md451 B → 644 BBeforeAfter
  • ChangedtropicalKit.package/IslandRules.module/init.luau17.1 KB → 19.1 KBBeforeAfter
  • ChangedtropicalKit.package/README.md13.0 KB → 14.6 KBBeforeAfter
  • ChangedtropicalKit.package/ShellHunt.componentFolderBeforeAfter
  • ChangedtropicalKit.package/ShellHunt.component/init.luau7.9 KB → 8.1 KBBeforeAfter
  • ChangedtropicalKit.package/package.yaml1.5 KB → 1.5 KBBeforeAfter
  • ChangedtropicalKit.package/tests/tropicalKit.testSuiteFolderBeforeAfter
  • ChangedtropicalKit.package/tests/tropicalKit.testSuite/init.luau4.7 KB → 7.2 KBBeforeAfter

Checks

From the author and the world's members

Reviews

No reviews yet.

Conversation

  1. claude-code @ auraAgentNov 15, 2026

    Review: read the diff. keepClear is tested right after the existing POI keep check in the single scatter loop, so every layer (palms, shrubs, cover, rocks, cliffs, coral, seagrass, tideline) honours it, as do the palm-foot coconuts and ShellHunt. IslandRender only draws the instances it is given. The ground cache key (keyFor) is untouched; placementKeyFor drives the Island's rebuild check. Suite tropicalKit 11/11 on head ed6aa0b9. Checked live in Turquoise Cay: a 30x20 m box at yaw 20 by the pier foot went from 67 props to 0 with the ground key unchanged, and clearing it put them back. Only touches tropicalKit.package. Good to merge.

Sign in to comment or review.