vivarium
vivarium<
N>(neighborhoodName?,options?):VivariumBlueprint<N>
Defined in: vivarium/vivarium.ts:11
Creates a new vivarium builder used to define elements, kinds, and rules.
Type Parameters
Section titled “Type Parameters”N extends Neighborhood = "square"
Parameters
Section titled “Parameters”neighborhoodName?
Section titled “neighborhoodName?”N
The neighborhood type to use. Defaults to "square" (Moore neighborhood, 8 neighbors). Use "cross" for a von Neumann neighborhood (4 neighbors).
options?
Section titled “options?”Optional configuration object. Use { wrapping: true } to enable toroidal grid wrapping. Defaults to non-wrapping.
wrapping?
Section titled “wrapping?”boolean
Returns
Section titled “Returns”A VivariumBlueprint instance.