instance_pool

Vars
available_instances	Internal. A fixed size sparse list of instances ready to be checked out.
configurators	Configurable. List of paths. If set, becomes (path => instance).
instance_path	Configurable. Path. The path of the instances this pool manages.
instance_pool_flags	Configurable. A field of the constants below.
next_instance	Internal. The index to check out next. If 0, we start creating new ones.
pool_size	Configurable. Natural. The maximum number of instances this pool will retain.
Procs
GetInstance	Sealed. Get an instance from the pool, creating a new one if needed, applying configurator if supplied.
OnGetInstance	Virtual. Manipulate a newly checked out instance in a common way.
OnReturnInstance	Virtual. Manipulate a newly returned instance in a common way, such as to clean it of timers.
ReturnInstance	Sealed. Re-add instance to the pool if it's not full. Only one use, below, in datum/Destroy.

Var Details

var
available_instances
– /list/datum

Internal. A fixed size sparse list of instances ready to be checked out.

var
configurators
– /list/singleton/instance_configurator

Configurable. List of paths. If set, becomes (path => instance).

var
instance_path
– /datum

Configurable. Path. The path of the instances this pool manages.

var
instance_pool_flags

Configurable. A field of the constants below.

var
next_instance

Internal. The index to check out next. If 0, we start creating new ones.

var
pool_size

Configurable. Natural. The maximum number of instances this pool will retain.

Proc Details

proc
GetInstance
(/singleton/instance_configurator/configurator)

Sealed. Get an instance from the pool, creating a new one if needed, applying configurator if supplied.

proc
OnGetInstance
(/datum/instance)

Virtual. Manipulate a newly checked out instance in a common way.

proc
OnReturnInstance
(/datum/instance)

Virtual. Manipulate a newly returned instance in a common way, such as to clean it of timers.

proc
ReturnInstance
(/datum/instance)

Sealed. Re-add instance to the pool if it's not full. Only one use, below, in datum/Destroy.

instance_pool /singleton/instance_pool

Vars

Procs

Var Details

var available_instances – /list/datum

var configurators – /list/singleton/instance_configurator

var instance_path – /datum

var instance_pool_flags

var next_instance

var pool_size