KindBlueprint
Defined in: blueprint/ref-blueprint.ts:76
Blueprint for a kind. Returned by vivarium().kind(). Use to() to define shared rules for all elements extending this kind.
Extends
Section titled “Extends”RefBlueprint<N>
Type Parameters
Section titled “Type Parameters”N extends Neighborhood = Neighborhood
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KindBlueprint<
N>(context,automaton,kind):KindBlueprint<N>
Defined in: blueprint/ref-blueprint.ts:80
Parameters
Section titled “Parameters”context
Section titled “context”BlueprintContext
automaton
Section titled “automaton”Returns
Section titled “Returns”KindBlueprint<N>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”id:
number
Defined in: blueprint/ref-blueprint.ts:78
Overrides
Section titled “Overrides”name:
string
Defined in: blueprint/ref-blueprint.ts:13
Inherited from
Section titled “Inherited from”type:
"kind"
Defined in: blueprint/ref-blueprint.ts:77
Overrides
Section titled “Overrides”Methods
Section titled “Methods”to(
elementBlueprintOrNeighbor):RuleBlueprint<N>
Defined in: blueprint/ref-blueprint.ts:33
Creates a new rule that transitions cells of this element (or kind) to another element or neighbor reference.
Parameters
Section titled “Parameters”elementBlueprintOrNeighbor
Section titled “elementBlueprintOrNeighbor”ElementBlueprint<Neighborhood> | Neighbor<N>
The target element, or a neighbor position reference (e.g. vi.neighbor.TOP).
Returns
Section titled “Returns”A RuleBlueprint for chaining conditions.