QueuedInstances

A QueuedInstance is a class that's stored within Object Pools in this module

A QueuedInstance contains the Instance it's meant to represent and a few properties, functions and signals.

You can load the instance contained within a QueuedInstance by using :Load()

local QueuedInstance = ObjectPool:Get() -- returns a QueuedInstance

QueuedInstance:Load()
-- this sets the instance's parent to Workspace, and sets the Active boolean to true
-- you can provide an Instance as a paremeter in the :Load() function, this instance will be used as the parent instead of Workspace
-- this will push the QueuedInstance to the bottom of the Pool, which makes it unlikely for it to be pulled again if LiveReusing is enabled

You can also unload instances using :Unload()

QueuedInstance:Unload()
-- sets the instance's parent to nil

Getting the Instance from within a QueuedInstance

To get the Instance that the QueuedInstance is referencing, simply do:

local Inst = QueuedInstance.Instance

Events

QueuedInstances have events you can track and execute code with, such as:

.Loaded

This event fires when the QueuedInstance is loaded with :Load() or retrieved from the Pool with :LoadItem()

QueuedInstance.Loaded:Connect(function()
    print("Instance loaded!")
end)

.Unloaded

Fires after the QueuedInstance has been unloaded

QueuedInstance.Unloaded:Connect(function()
    print("Instance unloaded!")
end)