{"id":"cometahn1042f/objectpool","name":"objectpool","scope":"cometahn1042f","platform":"roblox","description":"ObjectPool For Roblox","version":"0.1.2","latest":"0.1.2","versions":["0.1.0","0.1.1","0.1.2"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"cd86521a52305a84010847f5d7c6d330fcde480f668396c48188047b803ee38a","likes":0,"downloads":0,"install":"forest install cometahn1042f/objectpool","url":"https://forest.dev/p/roblox/cometahn1042f/objectpool","files":"https://api.forest.dev/ai/package/roblox/cometahn1042f/objectpool/files","readme":"# ObjectPool\n\nObjectPool is an instance recycling library for Luau on Roblox. It minimizes runtime allocations and garbage collection pressure by reusing `Instance` objects by ClassName.\n\n## Documentation Index\n\n- [API Reference](file:///c:/Lua/Libraries/ObjectPool/docs/api-reference.md): `ObjectPool.new`, `GetInstance`, `ReturnInstance`.\n- [Architecture & Design](file:///c:/Lua/Libraries/ObjectPool/docs/architecture-and-design.md): Instance recycling queue design.\n- [Performance & Memory Profile](file:///c:/Lua/Libraries/ObjectPool/docs/performance-and-memory.md): Allocation suppression metrics.\n- [Failure Modes & Exception Guarantees](file:///c:/Lua/Libraries/ObjectPool/docs/failure-modes.md): State cleanup requirements before returning instances.\n- [Executable Examples](file:///c:/Lua/Libraries/ObjectPool/docs/examples.md): Practical usage patterns for projectile/particle pooling.\n\n## Quick Start\n\n```luau\nlocal ObjectPool = require(path.to.ObjectPool)\n\n-- Create a pool storing up to 50 instances per ClassName\nlocal pool = ObjectPool.new(50)\n\n-- Fetch a Part instance\nlocal part = pool:GetInstance(\"Part\")\n\n-- Return instance to pool when done\npool:ReturnInstance(part)\n```","readmeTruncated":false}