pool

NOTE: This version of the documentation tracks unstable development happening on A-Frame’s master branch. If you wish to try it out, grab the unstable build. Otherwise, head to the documentation for the current 0.9.0 version

The pool component allows for object pooling. This gives us a reusable pool of entities to avoid creating and destroying the same kind of entities in dynamic scenes. Object pooling helps reduce garbage collection pauses.

Note that entities requested from the pool are paused by default and you need to call .play() in order to activate their components’ tick functions.

Example

For example, we may have a game with enemy entities that we want to reuse.

<a-scene pool__enemy="mixin: enemy; size: 10"></a-scene>
var el = sceneEl.components.pool__enemy.requestEntity();
el.play();
sceneEl.components.pool__enemy.returnEntity(el);

Properties

Property Description Default Value
container Selector to store pooled entities. Defaults to the scene. ‘’
dynamic Grow the pool automatically if more entities are requested after reaching the size. false
mixin Mixin required to initialize the entities of the pool. ‘’
size Number of preallocated entities in the pool. 0

Methods

.requestEntity ()

Request one of the available entities in the pool. Will return undefined and log a warning if grow is set to false and you have exhausted the pool.

.returnEntity (entityEl)

Relinquish an entity back to the pool. Will log a warning if you attempt to return an entity that did not belong to this pool.