Add method to easily mass-create regions

README.md

@@ -67,6 +67,25 @@ local IsVisible = RegionState:IsRegionVisible("Region1") --Bool for if a region
 local InRegion = RegionState:IsInRegion("Region1", Vector3.new()) --Bool for if a point is in a region
 ```
 
+## Quicker Region Setup
+`RegionState` offers an additional method that makes it easier to create a centralized folder of "Regions" that you can easily customize, expand, rotate, resize, and re-position. 
+```
+Regions : Instance
+|- Region1 : Instance
+|  |-- ZonePart : BasePart
+|  |-- ZonePart : BasePart
+|- Region2 : Instance
+|  |-- ZonePart : BasePart
+```
+Using the instance above as an example,
+```lua
+local RegionCulling = require(game:GetService("ReplicatedStorage"):WaitForChild("RegionCulling"))
+local RegionState = RegionCulling.RegionState
+
+RegionState:InsertRegionsFromInstance(game.ServerStorage.Regions)
+--// RegionCulling will generate all regions based on the provided instances.
+```
+
 ## ModelCulling
 `ModelCulling` controls the hiding of models based on `RegionState`.
 Almost all API calls will be to `BindModelToRegion`, which returns
@@ -159,4 +178,4 @@ before retrying. Waiting may be required before getting a proper reading.
 
 # License
 This project is available under the terms of the MIT License.
-See [LICENSE](LICENSE) for details.
+See [LICENSE](LICENSE) for details.

src/State/RegionState.lua

@@ -95,6 +95,29 @@ function RegionState:AddRegion(RegionName: string, Center: CFrame, Size: Vector3
     })
 end
 
+--[[
+Creates regions based on a pre-determined model/folder, provides for quicker setup &
+easier customization. 
+Name each region with the appropriate title and then add parts to determine their region.
+--]]
+function RegionState:InsertRegionsFromInstance(Instances: Model | Folder | Instance): ()
+	if #Instances:GetChildren() == 0 then
+		error("Instance \"" .. Instances:GetFullName() .. "\" has no child instances, unable to build Regions from it.")
+	end
+	for _, RegionParent in Instances:GetChildren() do 
+		--Get the region name from the child name
+		local RegionName = RegionParent.Name
+		for _, RegionPart in RegionParent:GetChildren() do 
+			if RegionPart:IsA("BasePart") then
+				self:AddRegion(RegionName, RegionPart.CFrame, RegionPart.Size)
+			end
+		end
+	end
+	--// TODO
+	--// Perform region checks to maybe auto-connect intersecting regions? 
+	--// May not apply to all regions however.
+end
+
 --[[
 Marks a region as visible to another.
 --]]
@@ -162,4 +185,4 @@ end
 
 
 
-return (RegionState :: any) :: Types.RegionState
+return (RegionState :: any) :: Types.RegionState