Helpers
Defined in: blueprint/helpers.ts:9
Helper functions for constructing count arrays used in conditions.
Accessed via vi.helpers.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Helpers(
neighborhoodName?):Helpers
Defined in: blueprint/helpers.ts:10
Parameters
Section titled “Parameters”neighborhoodName?
Section titled “neighborhoodName?”Returns
Section titled “Returns”Helpers
Methods
Section titled “Methods”between()
Section titled “between()”between(
min,max):number[]
Defined in: blueprint/helpers.ts:34
Generates a range of whole numbers from min to max (inclusive).
Parameters
Section titled “Parameters”number
The start of the range (must be ≥ 0).
number
The end of the range (must be ≥ min and ≤ the neighborhood size: 8 for square, 4 for cross).
Returns
Section titled “Returns”number[]
An array of numbers from min to max.
Throws
Section titled “Throws”If min or max is not a whole number between 0 and the neighborhood size, or max is less than min.
even()
Section titled “even()”even():
number[]
Defined in: blueprint/helpers.ts:49
Returns all even count values (zero included) for the current neighborhood type.
Returns
Section titled “Returns”number[]
[0, 2, 4, 6, 8] for square, [0, 2, 4] for cross.
not(
value):number[]
Defined in: blueprint/helpers.ts:19
Returns every valid count value except the ones specified.
Parameters
Section titled “Parameters”number | number[]
A number or array of numbers to exclude.
Returns
Section titled “Returns”number[]
An array of all valid count values minus the excluded ones.
Throws
Section titled “Throws”If a value is not a whole number between 0 and the neighborhood size.
odd():
number[]
Defined in: blueprint/helpers.ts:58
Returns all odd count values for the current neighborhood type.
Returns
Section titled “Returns”number[]
[1, 3, 5, 7] for square, [1, 3] for cross.