Final API touch-ups

Author: LDGerrits

docs/intro.md

@@ -87,7 +87,7 @@ This test highlights the fundamental flaw in traditional Zone-Centric libraries.
 The package name + version is
 
 ```
-ldgerrits/quickzone@^1.3.12
+ldgerrits/quickzone@^2.0.0
 ```
 
 ### Manual
@@ -107,7 +107,7 @@ local Zone, Group, Observer = QuickZone.Zone, QuickZone.Group, QuickZone.Observe
 local myPlayer = Group.localPlayer()
 
 -- Find all current and future instances with the 'Water' tag.
-local zones = Zone.fromTag('AntiGravity', {
+local zones = Zone.tag('AntiGravity', {
     metadata = { GravityMultiplier = 0.4 }
 })
 
@@ -149,7 +149,7 @@ local Zone, Group, Observer = QuickZone.Zone, QuickZone.Group, QuickZone.Observe
 local localPlayer = game:GetService('Players').LocalPlayer
 
 local myPlayer = Group.localPlayer()
-local zones = Zone.fromChildren(workspace.AntiGravityParts)
+local zones = Zone.children(workspace.AntiGravityParts)
 local gravityObserver = Observer.new():subscribe(myPlayer):attach(zones)
 
 -- Connect events
@@ -197,7 +197,7 @@ QuickZone:setReference(localPlayer, characterModel)
 
 -- Add the local player to the spatial group (QuickZone tracks the mapped model automatically)
 local playerGroup = Group.new():add(localPlayer)
-local zones = Zone.fromTag('AntiGravity', {
+local zones = Zone.tag('AntiGravity', {
     metadata = { GravityMultiplier = 0.4 }
 })
 local gravityObserver = Observer.new({ 

docs/usage.md

@@ -42,7 +42,7 @@ end)
 Ideal for ECS frameworks or continuous logic. Instead of waiting for events, your systems poll the state every frame using zero-allocation iterators. You should disable the internal scheduler to step the update method manually for perfect determinism.
 
 ```lua
-QuickZone:setAutoUpdate(false) -- Disable auto-loop
+QuickZone:setEnabled(false) -- Disable auto-loop
 
 local function spatialSystem(dt)
     QuickZone:update(dt) -- Steps it deterministically once per frame.
@@ -64,22 +64,22 @@ end)
 Zones represent physical areas in the world. They are mathematical boundaries that can be static (fixed in space) or dynamic (following a part). They can be created from existing parts or defined manually with a CFrame and Size.
 
 ### Bulk Creation
-The easiest way to create zones is using the bulk constructors. The `fromParts`, `fromDescendants`, `fromChildren`, and `fromTag` return a Zones collection object, which acts as a logical unit allowing you to manage multiple zones at once.
+The easiest way to create zones is using the bulk constructors. The `parts`, `descendants`, `children`, and `tag` return a Zones collection object, which acts as a logical unit allowing you to manage multiple zones at once.
 
 ```lua
 -- Create zones from a CollectionService tag
-local lavaZones = Zone.fromTag('Lava', {
+local lavaZones = Zone.tag('Lava', {
 	metadata = { damage = 10 }
 })
 
 -- Create zones from an array of parts
-local safeZones = Zone.fromParts(workspace.SafeZones:GetChildren())
+local safeZones = Zone.parts(workspace.SafeZones:GetChildren())
 
 -- Create zones from all BaseParts inside a Model or Folder (Deep search)
-local hazardZones = Zone.fromDescendants(workspace.TrapModel)
+local hazardZones = Zone.descendants(workspace.TrapModel)
 
 -- Create zones from only the direct children of a Folder (Shallow search)
-local flatZones = Zone.fromChildren(workspace.FlatFolder)
+local flatZones = Zone.children(workspace.FlatFolder)
 ```
 
 ### Manual Creation
@@ -90,16 +90,16 @@ local zone = Zone.new({
 	cframe = CFrame.new(0, 10, 0),
 	size = Vector3.new(10, 10, 10),
 	shape = 'Block',
-	isDynamic = true,
+	dynamic = true,
 	metadata = { Name = 'Lobby' }
 })
 ```
 
 ### Single & Dynamic Creation
-For maximum perfomance, use `isDynamic = true` for zones attached to moving platforms, vehicles, or projectiles.
+For maximum perfomance, use `dynamic = true` for zones attached to moving platforms, vehicles, or projectiles.
 ```lua
-local trainZone = Zone.fromPart(workspace.TrainCarriage, { 
-	isDynamic = true,
+local trainZone = Zone.part(workspace.TrainCarriage, { 
+	dynamic = true,
 	metadata = { route = 'North' }
 })
 ```
@@ -113,12 +113,12 @@ Dynamic zones need to know when their physical reference moves. You can let Quic
 You can quickly create a dynamic zone from an existing physical part. If you set autoSync = true, QuickZone will automatically update the zone's position in the spatial tree every frame to match the part.
 
 ```lua
-local truckZone = Zone.fromPart(workspace.Truck.Hitbox, { 
-    isDynamic = true,
+local truckZone = Zone.part(workspace.Truck.Hitbox, { 
+    dynamic = true,
     autoSync = true
 })
 ```
-Because Zone.fromPart requires an object with a physical volume (like a BasePart), you cannot use it for abstract references like an Attachment or a Bone. Instead, you manually create the zone with a specific size and declaratively set its reference and autoSync.
+Because Zone.part requires an object with a physical volume (like a BasePart), you cannot use it for abstract references like an Attachment or a Bone. Instead, you manually create the zone with a specific size and declaratively set its reference and autoSync.
 
 ```lua
 local trainZone = Zone.new({

docs/why-use-quickzone.md

@@ -25,7 +25,7 @@ QuickZone, on the other hand, is Entity-Centric. It keeps a list of entities and
 ### 2. Expressive and Boilerplate-Free API
 Writing performant code shouldn't mean writing complicated code. QuickZone is designed to be highly ergonomic.
 
-- **CollectionService Integration**: Tag your parts and bind them to your logic in a single line of code (e.g., `Zone.fromTag('Lava')`).
+- **CollectionService Integration**: Tag your parts and bind them to your logic in a single line of code (e.g., `Zone.tag('Lava')`).
 
 - **Declarative Configurations**: QuickZone lets you define behaviors, priorities, and relationships upfront in simple configuration tables, drastically reducing boilerplate and keeping your scripts clean.
 

examples/Client/Observers/Disco.luau

@@ -7,7 +7,7 @@ local SharedGroups = require(ReplicatedStorage.Common.Groups)
 local discoPart = workspace:WaitForChild('DiscoPart')
 local defaultColor = discoPart.Color
 
-local discoZone = QuickZone.Zone.fromPart(discoPart)
+local discoZone = QuickZone.Zone.part(discoPart)
 
 local discoObserver = QuickZone.Observer.new({
 	groups = { SharedGroups.Players },

examples/Common/Zones.luau

@@ -11,17 +11,17 @@ local Zone = QuickZone.Zone
 	For single-purpose zones, just create the Zone locally inside its respective script.
 ]=]
 local Zones = {
-	Lava = Zone.fromTag('Lava', {
+	Lava = Zone.tag('Lava', {
 		metadata = { Name = 'Lava', Damage = 50 },
 	}),
-	ToxicGas = Zone.fromTag('ToxicGas', {
+	ToxicGas = Zone.tag('ToxicGas', {
 		metadata = { Name = 'ToxicGas', Damage = 10 },
 	}),
 }
 
 if RunService:IsClient() then
-	Zones.SpeedBoost = Zone.fromChildren(workspace:WaitForChild('SpeedBoosts'))
-	Zones.AntiGravity = Zone.fromChildren(workspace:WaitForChild('AntiGravZones'))
+	Zones.SpeedBoost = Zone.children(workspace:WaitForChild('SpeedBoosts'))
+	Zones.AntiGravity = Zone.children(workspace:WaitForChild('AntiGravZones'))
 end
 
 return Zones

examples/Server/Observers/GravityWell.luau

@@ -6,8 +6,8 @@ local SharedGroups = require(ReplicatedStorage.Common.Groups)
 
 local gravityWell = workspace:WaitForChild('GravityWell')
 
-local gravityWellZone = QuickZone.Zone.fromPart(gravityWell, {
-	isDynamic = true,
+local gravityWellZone = QuickZone.Zone.part(gravityWell, {
+	dynamic = true,
 	autoSync = true,
 })
 

examples/Server/Observers/SafeZone.luau

@@ -4,7 +4,7 @@ local SharedGroups = require(ReplicatedStorage.Common.Groups)
 
 local safeZonePart = workspace:WaitForChild('SafeZone')
 
-local safeZone = QuickZone.Zone.fromPart(safeZonePart)
+local safeZone = QuickZone.Zone.part(safeZonePart)
 
 local safeObserver = QuickZone.Observer.new({
 	groups = { SharedGroups.Players },

src/Classes/Group.luau

@@ -179,7 +179,7 @@ end
 	@param tag string
 	@return Group
 ]=]
-function Group.fromTag(tag: string): Types.Group<Types.Entity>
+function Group.tag(tag: string): Types.Group<Types.Entity>
 	local group = Group.new({ autoClean = false }) :: Types.InternalGroup<Types.Entity>
 	group.isManaged = true
 
@@ -746,12 +746,12 @@ function Group._remove(self: Types.InternalGroup, entity: any): Types.Group
 			continue
 		end
 
-		local safety = State.observerSafety[observerId]
+		local safe = State.observerSafe[observerId]
 		local z = State.zoneIdToZoneObj[oldZoneId]
 		local ref = State.entityToReference[entity] or entity
 
 		for _, fn in cbs do
-			if safety then
+			if safe then
 				task.spawn(fn, ref, z)
 			else
 				fn(ref, z)

src/Classes/Observer.luau

@@ -48,7 +48,7 @@ local function updateAllEntitiesForObserver(observerId: number)
 end
 
 local function disconnectObserverFromGroup(observerId: number, group: Types.InternalGroup)
-	local safety = State.observerSafety[observerId]
+	local safe = State.observerSafe[observerId]
 
 	for _, entity in group.entities do
 		local data = State.entityData[entity]
@@ -79,7 +79,7 @@ local function disconnectObserverFromGroup(observerId: number, group: Types.Inte
 		local z = State.zoneIdToZoneObj[oldZoneId]
 		local ref = State.entityToReference[entity] or entity
 		for _, fn in cbs do
-			if safety then
+			if safe then
 				task.spawn(fn, ref, z)
 			else
 				fn(ref, z)
@@ -109,7 +109,7 @@ Observer.__index = Observer
 		updateRate = 20, -- Check at 20Hz
 		precision = 0.5, -- Ignore movement smaller than 0.5 studs
 		enabled = false, -- Observer will not start processing spatial checks
-		safety = false, -- Do not wrap callbacks in task.spawn
+		safe = false, -- Do not wrap callbacks in task.spawn
 	})
 	```
 
@@ -118,12 +118,12 @@ Observer.__index = Observer
 	higher priority observers take complete control.
 	:::
 
-	:::warning Safety 
+	:::warning Safe 
 	If set to unsafe, you are not allowed to yield in the callbacks anymore. If you do, QuickZone will throw errors.
 	:::
 
 	@tag Constructor
-	@param config { groups: { Types.Group }?, zones: { Types.Zone | Types.Zones }?, priority: number?, updateRate: number?, precision: number?, enabled: boolean?, safety: boolean? }?
+	@param config { groups: { Types.Group }?, zones: { Types.Zone | Types.Zones }?, priority: number?, updateRate: number?, precision: number?, enabled: boolean?, safe: boolean? }?
 	@return Observer
 ]=]
 function Observer.new<T>(config: {
@@ -133,7 +133,7 @@ function Observer.new<T>(config: {
 	updateRate: number?,
 	precision: number?,
 	enabled: boolean?,
-	safety: boolean?,
+	safe: boolean?,
 }?): Types.Observer
 	local id = State.nextObserverId
 	State.nextObserverId += 1
@@ -152,7 +152,7 @@ function Observer.new<T>(config: {
 	State.observerTrackingEntities[id] = {}
 	State.observerIdToObserverObj[id] = self
 	State.observerEnabled[id] = if config and config.enabled ~= nil then config.enabled else true
-	State.observerSafety[id] = if config and config.safety ~= nil then config.safety else Config.Observer.safety
+	State.observerSafe[id] = if config and config.safe ~= nil then config.safe else Config.Observer.safe
 	State.observerStaticCount[id] = 0
 	State.observerDynamicCount[id] = 0
 
@@ -953,17 +953,17 @@ end
 --[=[
 	Whether to wrap callbacks in task.spawn (safe) or not (unsafe).
 
-	:::warning Safety 
+	:::warning Safe 
 	If set to unsafe, you are not allowed to yield in the callbacks anymore. If you do, QuickZone will throw errors.
 	:::
 
-	@method setSafety
+	@method setSafe
 	@within Observer
 	@param enabled boolean
 	@return Observer
 ]=]
-function Observer.setSafety(self: Types.InternalObserver, enabled: boolean): Types.Observer
-	State.observerSafety[self.id] = enabled
+function Observer.setSafe(self: Types.InternalObserver, enabled: boolean): Types.Observer
+	State.observerSafe[self.id] = enabled
 	return self
 end
 
@@ -1109,7 +1109,7 @@ end
 	@return boolean
 ]=]
 function Observer.isSafe(self: Types.InternalObserver): boolean
-	return State.observerSafety[self.id]
+	return State.observerSafe[self.id]
 end
 
 --[=[ 
@@ -1604,7 +1604,7 @@ function Observer.destroy(self: Types.InternalObserver): ()
 	State.observerTrackingEntities[id] = nil
 	State.observerIdToObserverObj[id] = nil
 	State.observerEnabled[id] = nil
-	State.observerSafety[id] = nil
+	State.observerSafe[id] = nil
 	State.observerUpdateRate[id] = nil
 	State.observerPrecisionSq[id] = nil
 	State.observerStaticCount[id] = nil