Docs

Sleitnick · Apr 25, 2023 · 8abd1d9 · 8abd1d9
1 parent 488d767
commit 8abd1d9
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/lib/observeCharacter.lua b/lib/observeCharacter.lua
@@ -2,6 +2,22 @@
 
 local observePlayer = require(script.Parent.observePlayer)
 
+--[=[
+	@within Observers
+
+	Creates an observer that captures each character in the game.
+
+	```lua
+	observeCharacter(function(player, character)
+		print("Character spawned for " .. player.Name)
+
+		return function()
+			-- Cleanup
+			print("Character removed for " .. player.Name)
+		end
+	end)
+	```
+]=]
 local function observeCharacter(callback: (player: Player, character: Model) -> (() -> ())?): () -> ()
 	return observePlayer(function(player)
 		local cleanupFn: (() -> ())? = nil