Creating an object pool

You can create an object pool with:

local PoolingModule = require(Path.To.Module)

local ObjectPool = PoolingModule.new()
-- this will return an empty object pool with size of 0

There are 2 ways to fill your object pool with instances

Method 1 (recommended):

local PoolSize = 30
local FillWith : Instance = BasePart

local ObjectPool = PoolingModule.new(PoolSize,FillWith) : Pool

-- this will return an object pool that has 30 instances of FillWith

Method 2:

local ObjectPool = PoolingModule.new()
-- gives us an empty pool

local PoolSize = 30
local FillWith : Instance = BasePart

for i = 1, 30 do
    ObjectPool:Add(FillWith:Clone()) -- we have to clone the instance, as whatever instance is passed into this parameter gets automatically converted into a QueuedInstance object
end

Object pools can take parameters as well that declare how they are to act

local Parameters = { -- this table consists of default values
    LiveReusing = false, -- decides whether a loaded item can be reused
    -- when reusing, the item is unloaded and reloaded fast, the oldest loaded item is gotten first
    LoadWait = 0, -- how many heartbeats will the code wait between loading each item in the pool upon creation
    AutoExpand = false, -- should the pool automatically create new instances if an instance is required but none are availiable?
    -- AUTOEXPAND REQUIRES AN INSTANCE BE PASSED DURING CREATION OF THE POOL
    MaxPoolSize = math.huge, -- the maximum size the pool can be if AutoExpand is enabled
    UnloadTimer = -1 -- how long it takes before an item is automatically unloaded, anything below 0 disables the auto unloading
}
-- they have to be passed as the 3rd parameter in the .new() function

local ObjectPool = PoolingModule.new(SIZE,INSTANCE,Parameters)

PreviousInstallation NextRetrieving objects from the pool

Last updated 8 days ago

local ObjectPool = PoolingModule.new() -- gives us an empty pool local PoolSize = 30 local FillWith : Instance = BasePart for i = 1, 30 do ObjectPool:Add(FillWith:Clone()) -- we have to clone the instance, as whatever instance is passed into this parameter gets automatically converted into a QueuedInstance object end

local Parameters = { -- this table consists of default values LiveReusing = false, -- decides whether a loaded item can be reused -- when reusing, the item is unloaded and reloaded fast, the oldest loaded item is gotten first LoadWait = 0, -- how many heartbeats will the code wait between loading each item in the pool upon creation AutoExpand = false, -- should the pool automatically create new instances if an instance is required but none are availiable? -- AUTOEXPAND REQUIRES AN INSTANCE BE PASSED DURING CREATION OF THE POOL MaxPoolSize = math.huge, -- the maximum size the pool can be if AutoExpand is enabled UnloadTimer = -1 -- how long it takes before an item is automatically unloaded, anything below 0 disables the auto unloading } -- they have to be passed as the 3rd parameter in the .new() function local ObjectPool = PoolingModule.new(SIZE,INSTANCE,Parameters)