Skip to the content

Houseki documentation

Houseki API: every export

Every export of every entry point, each with its own page. This page keeps the addresses the old one-page reference had.

@johnmorrisdotca/houseki/falling-triplets

Actiontype

A native player action accepted or rejected according to the current phase and rules.

actionsForTickfunction

Resolves canonical actions in the design's per-tick order.

applyActionfunction

Applies and records one immutable action; rejected actions preserve state identity.

CampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

campaignManifestconstant

The frozen native campaign manifest with its ordering, revisions, checksum and measured levels.

CampaignManifesttype

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

ChallengeGoaltype

A native authored challenge objective; its discriminant selects target, chain, empty-board or score requirements.

ChallengeGoalChaintype

A Falling Triplets objective requiring at least the supplied chain depth.

ChallengeGoalTargetstype

A Falling Triplets objective requiring the supplied stable target ids to be cleared.

ChallengeHinttype

One witnessed Falling Triplets placement with a column and cycle orientation.

ChallengeOptionstype

Authored challenge inputs including the starting board, finite goal and supplied witness.

ChallengeSettingstype

The fixed Falling Triplets challenge settings with the original board and finite triplet queue.

compactBoardfunction

Compacts each column downward while preserving the top-to-bottom order of survivors.

createChallengefunction

Creates a challenge after validating its authored board, finite queue, goal, and witness.

createGamefunction

Creates a deterministic empty game with an active piece and three-piece preview.

createLevelfunction

Construct a fresh validated challenge state for a stable level ID or display number.

CreateOptionstype

Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.

decodeGamefunction

Replays and validates a bounded save, then verifies its checkpoint against the derived state.

DifficultyMetricstype

The bounded engine measurements used to grade this campaign; they do not claim human difficulty.

encodeGamefunction

Encodes the authoritative settings, action recording, and derived checkpoint.

findMatchesfunction

Finds the union of every maximal horizontal, vertical, and diagonal run of at least three.

GameEventtype

An event emitted by one native transition; type selects the event’s additional fields.

GameStatetype

The immutable authoritative native game state, including its board, random state and recording.

Gemtype

A settled or active gem with a stable run-local identity.

getLevelfunction

Find a level by stable content ID or its current one-based display number.

getTutorialfunction

Find a lesson by its persistent ID.

landingYfunction

Returns the exact landing row for the current rigid triplet.

legalActionsfunction

Lists the core actions currently available to the player.

levelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

Modetype

The native game mode; authored challenges have fixed setup and queue rules.

nextIntfunction

Draws an unbiased integer and updated state using rejection sampling.

nextUint32function

Advances the reference xorshift32 source.

Phasetype

The native falling, resolution, pause and ending phases.

Piecetype

The native falling triplet with stable gem ids, orientation, descent and lock counters.

queueInputEdgefunction

Queues a one-shot cycle, drop, or pause edge for the next logical tick.

RecordedActiontype

One accepted canonical action and its logical tick position.

releaseAllActionsfunction

Releases every held action after blur, pause, or pointer cancellation.

restartGamefunction

Recreates the same authored mode, seed, and challenge configuration from its original setup.

seedStatefunction

Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state.

setHeldActionfunction

Starts or releases one held action; opposite lateral holds cancel during scheduling.

Settingstype

Validated settings fixed at native game creation.

statusOffunction

Returns a plain status summary suitable for UI labels.

Transitiontype

The resulting native state, emitted events and acceptance decision; rejected actions preserve the input.

Triplettype

Three ordered gem colours composing one falling triplet.

TutorialDefinitiontype

One bilingual native lesson with its authored setup, teaching steps and winning witness.

tutorialManifestconstant

The frozen native bilingual lessons and their authored teaching steps.

TutorialSteptype

One bilingual native lesson instruction and the corresponding action or tick step.

Wavetype

One simultaneous native match wave, its cleared cells and chain score.

@johnmorrisdotca/houseki/colour-chains

Actiontype

A native player action accepted or rejected according to the current phase and rules.

actionsForTickfunction

Resolves this tick's inputs in lateral, rotation, drop, soft-drop, pause order.

advanceTicksfunction

Advances deterministic 60 Hz simulation and resolution; Relaxed and Challenges do not force a falling clock.

applyActionfunction

Applies one immutable accepted action and records its logical-tick position.

applyScheduledActionsfunction

Applies a scheduler batch until the pair locks or the run pauses; accepted actions are recorded by the engine.

arashiCampaignManifestconstant

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

arashiLevelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

campaignManifestconstant

The frozen native campaign manifest with its ordering, revisions, checksum and measured levels.

Celltype

A visible or hidden board coordinate.

ChainCampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

ChainCampaignManifesttype

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

ChainContentDatatype

The stored native Colour Chains campaign, lessons and optional Shizen/Arashi campaigns.

ChainDifficultyMetricstype

The bounded engine measurements used to grade this campaign; they do not claim human difficulty.

ChainsPowerDropPreviewtype

The Shizen hard-drop preview: the one-step rebound and where the pair locks (finalCells), and where each stone of the pair comes to rest once the committed drop's gravity has run (settledCells).

ChainTutorialDefinitiontype

One bilingual native lesson with its authored setup, teaching steps and winning witness.

ChainTutorialSteptype

One bilingual native lesson instruction and the corresponding action or tick step.

ChallengeGemtype

Authored challenge layouts can include explicit Shizen-marked stones.

ChallengeGoaltype

Challenge objective; target IDs refer to the visible starting board.

ChallengeOptionstype

Authored challenge inputs including the starting board, finite goal and supplied witness.

Colourtype

A gem colour used by Colour Chains.

createArashiLevelfunction

Create a validated native Arashi challenge using its stored setup and winning witness.

createChallengefunction

Validates and creates a finite witnessed challenge.

createGamefunction

Creates a deterministic seeded game with one active pair and three previews.

createLevelfunction

Create a fresh engine-validated challenge from a stable content ID or display number.

CreateOptionstype

Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.

createShizenLevelfunction

Create a validated native Shizen challenge using its stored setup and winning witness.

decodeGamefunction

Reconstructs a bounded action replay and rejects any checkpoint that differs from replay.

encodeGamefunction

Encodes canonical initial settings, accepted ordinal actions and a derived checkpoint.

GameEventtype

A domain event emitted by one transition.

GameStatetype

An immutable Colour Chains rules state.

GameStatustype

Compact player status derived from the current state.

Gemtype

A settled or active stone with a stable run-local identity.

getArashiLevelfunction

Find a native Arashi challenge by stable id or one-based display number.

getLevelfunction

Find a campaign challenge by stable content ID or its current one-based number.

getShizenLevelfunction

Find a native Shizen challenge by stable id or one-based display number.

getTutorialfunction

Find a persistent interactive lesson by its stable ID.

HeldControltype

A lateral or soft-drop control which the input scheduler can repeat.

InputCommandtype

A native held-control change or one-shot edge command for Colour Chains.

Landingtype

Destination cells for the two independently settled ghost stones.

landingCellsfunction

Returns the exact independent landing cells for the current rigid pair without consuming random values.

legalActionsfunction

Lists only actions accepted by the current game state.

levelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

Modetype

The native game mode; authored challenges have fixed setup and queue rules.

NatureCampaignBandtype

An inclusive one-based range in a measured native nature-campaign difficulty band.

NatureChainCampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

Orientationtype

The pivot-to-satellite direction, in clockwise order.

Pairtype

The active rigid pair.

Phasetype

Observable game phases.

PlayActiontype

One native Colour Chains player command, including pause and hint commands.

powerDropPreviewfunction

Returns the Shizen hard-drop landing and one-step rebound preview without changing state.

Presettype

Supported well presets.

processInputTickfunction

Applies a complete deterministic held-input and simulation tick, releasing controls on lock or resolution.

queueInputEdgefunction

Queues a one-shot rotation, drop, Place, pause or resume edge for the next logical tick.

RecordedActiontype

A native action recording with the logical position needed for deterministic replay.

releaseAllInputfunction

Releases every held or queued control after focus loss, lock, resolution or pause.

restartGamefunction

Restarts the same seed/date or original witnessed challenge board and queue.

Settingstype

Run settings fixed at game creation.

shizenCampaignManifestconstant

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

shizenLevelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

statusOffunction

Returns score, mode, chain and completion fields derived from state.

Transitiontype

A deterministic transition; rejected actions retain the exact input state.

tutorialManifestconstant

The frozen native bilingual lessons and their authored teaching steps.

Wavetype

A scored simultaneous match wave.

WeatherScheduletype

The native frequent or rare weather schedule for Colour Chains.

WitnessSteptype

One witnessed Colour Chains pair placement using pivot column and orientation.

@johnmorrisdotca/houseki/tsumiki

Actiontype

One move: a piece from the tray, placed with its top left on a cell.

ActionResulttype

What an applied action came to: whether it was taken, the state after it, and what happened.

advanceTicksfunction

Advances nothing: a placement is whole the moment it is made.

applyActionfunction

Plays one move: a piece is laid, every full row and column clears together, and the tray fills when it is empty.

Blocktype

One filled cell: its run-local identity, its colour, and whether it is a stone a challenge asks to be cleared.

BOARD_SIDEconstant

The board's side: eight cells each way.

canPlacefunction

Whether a piece from the tray can go with its top left on this cell, for a host to draw a ghost.

ChallengeGoaltype

What a challenge asks for: a score, a number of lines, or every stone cleared.

ChallengeOptionstype

An authored game: its identity, seed, goal and the stones it starts with.

createChallengefunction

Makes an authored game from its seed, goal and stones.

createGamefunction

Makes a free game or a Daily: a Daily's seed is its date, so one date is one game for everybody.

createLevelfunction

Makes a level's game; throws for a level that does not exist.

CreateOptionstype

The options a free game or a Daily is made from.

createTutorialfunction

Makes a lesson's game; throws for a lesson that does not exist.

decodeGamefunction

Reads a save by playing it again from the start, so a save cannot claim what its moves do not do.

encodeGamefunction

A game as text: what it was and the moves made, never the score or the board, which a replay works out.

GameEventtype

What a move made happen, for a host to draw or sound.

GameModetype

The free, daily or authored game mode.

GamePhasetype

Where a game stands: waiting for a placement, won, lost, or finished with a score.

GameSettingstype

How a game was set up, the whole of what a replay needs but the moves.

GameStatetype

The whole of a game, returned new by every move: nothing in it is changed in place.

GameStatustype

A game's figures as a host would show them.

getLevelfunction

Looks a level up by its id or its display number; null where there is none.

getTutorialfunction

Looks a lesson up by its id; null where there is none.

legalActionsfunction

Every placement allowed now, a bot's or a test's whole view of what can be done.

levelManifestconstant

The frozen graded levels, in order; array indices start at zero and display numbers at one.

Piecetype

A shape in the tray: its name, its colour, and its cells as row and column from its own top left.

restartGamefunction

The same game from its start, with the same settings.

statusOffunction

A game's figures: its phase, its score, its lines and how far along its goal it is.

TsumikiLeveltype

One graded level: its seed, goal and stones, and a line of moves the engine has been shown to win with.

TsumikiTutorialtype

One bilingual lesson, with the game it is played on and a line of moves that wins it.

@johnmorrisdotca/houseki/stone-collapse

Actiontype

A native player action accepted or rejected according to the current phase and rules.

advanceTicksfunction

Advances the observable 7/6/9 tick removal and gravity stages, bounded to 3600 ticks.

applyActionfunction

Applies a selection, confirmation, or cancellation without mutating its input.

BoardPresettype

A named native board geometry; custom dimensions remain a separate option.

BoardShapetype

A native shaped active-cell layout applied to the row-major board.

campaignManifestconstant

The frozen native campaign manifest with its ordering, revisions, checksum and measured levels.

ChallengeGoaltype

A native authored challenge objective; its discriminant selects target, chain, empty-board or score requirements.

ChallengeOptionstype

Authored challenge inputs including the starting board, finite goal and supplied witness.

CollapseCampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

CollapseCampaignManifesttype

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

CollapseDifficultyMetricstype

The bounded engine measurements used to grade this campaign; they do not claim human difficulty.

CollapseTutorialSteptype

One bilingual native lesson instruction and the corresponding action or tick step.

createChallengefunction

Creates a fixed witnessed challenge after validating its board, objective, move budget, and every witness group.

createGamefunction

Creates a seeded full board; an all-singleton draw retries before using a checked adjacent pair.

createLevelfunction

Construct a fresh engine-validated challenge from a content ID or display number.

CreateOptionstype

Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.

decodeGamefunction

Reconstructs and validates a bounded replay before accepting its checkpoint.

encodeGamefunction

Encodes the canonical initial configuration, accepted replay actions, and a derived checkpoint.

GameEventtype

An event emitted by one native transition; type selects the event’s additional fields.

GameModetype

The native free, timed, daily or authored-challenge game mode.

GamePhasetype

The native ready, resolution and ending phases.

GameStatetype

The immutable authoritative native game state, including its board, random state and recording.

GameStatustype

A compact native status derived from the authoritative state for a host’s labels.

getLevelfunction

Find a challenge by its persistent content ID or current one-based display number.

getTutorialfunction

Find a persistent interactive lesson by its stable ID.

legalActionsfunction

Lists every selection and confirmation currently accepted by the rules.

levelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

RecordedActiontype

A native action recording with the logical position needed for deterministic replay.

requestHintfunction

Selects the next supplied witness group only while the run still matches its path; accepted hints mark the run assisted.

restartGamefunction

Starts a fresh attempt from the identical seeded board or preserved challenge definition.

Settingstype

Validated settings fixed at native game creation.

statusOffunction

Returns the stable public game status and the remaining-stone count.

Stonetype

A stone keeps its run-local identity as it falls or changes column.

StoredTooltype

A stored Stone Collapse tool selected from the native Bomb and Pick tray.

Transitiontype

The resulting native state, emitted events and acceptance decision; rejected actions preserve the input.

tutorialManifestconstant

The frozen native bilingual lessons and their authored teaching steps.

undofunction

Restores the full pre-move state in Relaxed or Challenge practice and permanently marks the attempt assisted.

UndoFrametype

Data sufficient to restore the complete game immediately before a committed move.

@johnmorrisdotca/houseki/gem-swap

Actiontype

A native player action accepted or rejected according to the current phase and rules.

advanceTicksfunction

Advances deterministic resolution ticks; wall-clock time is supplied separately by the host.

advanceTimefunction

Adds explicit host-measured elapsed time.

applyActionfunction

Applies one recorded player action.

BlackHolePortaltype

A Gem Swap portal’s cell, remaining capacity, move lifetime and consumed stable ids.

BoardPresettype

A named native board geometry; custom dimensions remain a separate option.

BoardShapetype

A native shaped active-cell layout applied to the row-major board.

CAMPAIGN_COUNTconstant

The number of stored Gem Swap campaign challenges.

ChallengeRulestype

Gem Swap authored goals, optional move budget and seal layout.

createGamefunction

Creates a deterministic stable board with at least one legal normal swap.

CreateOptionstype

Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.

decodeGamefunction

Validates and reconstructs a state by replay; serialized board snapshots are never trusted.

encodeGamefunction

Encodes the initial rules plus accepted actions and logical inputs in canonical JSON.

GameEventtype

An event emitted by one native transition; type selects the event’s additional fields.

GameModetype

The native free, timed, daily or authored-challenge game mode.

GameOutcometype

The terminal outcome; null means the run has no terminal outcome yet.

GamePhasetype

The native ready, resolution and ending phases.

GameStatetype

The immutable authoritative native game state, including its board, random state and recording.

GameStatustype

A compact native status derived from the authoritative state for a host’s labels.

Gemtype

A gem has a stable identity and stored colour until it is cleared.

GEM_SWAP_CAMPAIGNconstant

The frozen measured Gem Swap challenges with stable ids, setups, witnesses and review status.

GEM_SWAP_LESSONSconstant

The frozen bilingual Gem Swap lessons with setup, teaching steps and witnesses.

GemSwapCampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

GemSwapLessontype

One bilingual native lesson with its authored setup, teaching steps and winning witness.

GemSwapLessonSteptype

One bilingual native lesson instruction and the corresponding action or tick step.

GemSwapOptionsErrorclass

Typed error for invalid settings or a board that cannot be generated safely.

GemSwapReviewStatustype

The existing campaign’s human-review-pending status; an engine witness is not human review.

Goaltype

The native authored goal; its discriminant selects the required collection or clearing condition.

GRADING_VERSIONconstant

The measurement/normalization revision used to grade Gem Swap challenges.

GRADING_WEIGHTSconstant

The bounded Gem Swap metric weights used in the recorded grading formula.

HintActiontype

Requests a native Gem Swap hint and marks assisted play.

hintGamefunction

Returns a deterministic legal swap hint and permanently marks the run assisted.

legalActionsfunction

Lists all legal swaps that would be accepted from the current stable state.

OrdinaryToolKindtype

A Gem Swap stored tool excluding the separately charged Black Hole.

PlannedSpecialtype

The native Gem Swap cell and special kind planned for the end of a clear wave.

ReplayErrorclass

A typed rejection of a malformed, unsupported or inconsistent native replay.

ReplayOperationtype

One native Gem Swap action, fixed-tick advance or elapsed-time replay operation.

reshuffleGamefunction

Shuffles existing gem records in Relaxed play, preserving their colour and special counts.

restartGamefunction

Starts the exact initial ruleset and seed again, discarding all run progress.

SAMPLE_BUDGETconstant

The fixed number of seeded playout samples used in the stored Gem Swap grading.

Sealtype

A Gem Swap row-major seal cell and its remaining layers.

SelectToolActiontype

Selects a stored Gem Swap tool without committing its target.

Settingstype

Validated settings fixed at native game creation.

SpecialKindtype

A Gem Swap beam, bomb or colour-burst special retained at its chosen anchor.

statusOffunction

Derive the native phase, score, legal-move count, tools and goal/timer progress for host labels.

SwapActiontype

Swaps two row-major cell addresses.

ToolKindtype

A Gem Swap stored tool or advanced Black Hole selection.

Transitiontype

The resulting native state, emitted events and acceptance decision; rejected actions preserve the input.

UndoActiontype

Requests restoration of the prior Gem Swap move.

undoGamefunction

Restores the last committed swap in Relaxed or Challenge play and marks assistance.

@johnmorrisdotca/houseki/nature

applyEarthquakefunction

Commit one bounded environmental resolution; matching, gravity and score remain the host game's job.

applyPowerDropfunction

Commit a previewed landing as one immutable operation.

AttractionPairPreviewtype

A pure attraction decision including the paired ids, axis, gap, midpoint and moves.

createNatureStatefunction

Create a validated seeded native environment grid with fixed masks and mechanic switches.

EarthquakeKindtype

The native fault, jumble or combined earthquake mode.

EnvironmentEventtype

A committed earthquake or lightning event with its native preview fields.

FaultPreviewtype

A pure earthquake fault path, removed ids and resulting occupants/passability mask.

JumblePreviewtype

A pure eligible-patch shuffle and resulting occupants; reason explains when no patch exists.

LightningOptionstype

Lightning enablement and explicit columns or a bounded column count.

LightningPreviewtype

A pure selected-column removal and resulting occupants/random state.

MagneticPreviewtype

A pure magnetic-pulse result; no input state or random source is consumed.

MarkingOptionstype

The probability and optional count/anchor bounds used to mark magnetic stones.

markMagneticStonesfunction

Deterministically assign magnetic markings to settled stones without changing their IDs or colours.

NatureErrorCodetype

Stable native validation codes for grid, cell, marking and power-drop failures.

NatureEventtype

An emitted native magnetic marking, attraction or power-drop event.

NatureMovetype

One native stable-id move between two board coordinates.

NatureOptionstype

The native grid dimensions, passability mask, occupants, seed and magnetic/rebound settings.

NatureOptionsErrorclass

A typed native grid, cell, marking or power-drop validation error.

NaturePieceCelltype

A falling native stone with its cell coordinates and stable id.

NatureRulestype

The fixed native magnetic and rebound rule switches.

NatureStatetype

The immutable native environment state with stable ids, seeded random state and placement count.

NatureTransitiontype

The native environment result, emitted events and optional pure preview.

PowerDropPreviewtype

The pure normal landing, rebound attempts and final lock cells with resulting random state.

PowerDropRequesttype

The native piece cells, pivot id and host-selected power/rebound options.

previewEarthquakefunction

Preview an earthquake, with Combined always fracturing before its one jumble attempt.

previewFaultfunction

Preview a bounded top-to-bottom fracture.

previewJumblefunction

Preview one seeded, nontrivial stone permutation inside a fully active connected rectangle no larger than 3×3.

previewLightningfunction

Preview seeded or explicitly selected columns; a mask gap or obstacle blocks the strike below it.

previewMagneticPulsefunction

Preview one bounded deterministic attraction pulse without mutating the state.

previewPowerDropfunction

Preview a single normal landing and, for a power drop, at most one validated one-cell rebound.

QuarterTurntype

A counterclockwise, unchanged or clockwise quarter-turn chosen by the host.

ReboundAttemptPreviewtype

One tested rebound direction and quarter-turn with its collision-validity result.

ReboundDirectionModetype

Whether rebound prefers recent input/alternation or the seeded random source.

@johnmorrisdotca/houseki/magnetic-blocks

Actiontype

A native player action accepted or rejected according to the current phase and rules.

advanceTicksfunction

Advances fixed 60 Hz time, resolving phases in all modes and falling/locking only in Arcade.

applyActionfunction

Applies one movement, rotation, floor-switch or placement action without mutation.

Blocktype

The native active 2×2 block, orientation and fixed-tick descent/lock counters.

blockBondsfunction

List the native stable-id bonds connecting adjacent gems in the active block.

blockCellsfunction

Returns stable-gem addresses after rotating the square block around its centre.

Bondtype

An undirected stable-id connection between two gems in a magnetic block.

calmGravityfunction

Settles bonded connected components one cell per deterministic bottom/ID priority step.

campaignManifestconstant

The frozen native campaign manifest with its ordering, revisions, checksum and measured levels.

canPlacefunction

Test whether the whole native block fits passable empty board cells.

Colourtype

A standard gem colour used by a magnetic block.

createGamefunction

Creates an immutable seeded 2×2-block game with a fixed queue and explicit floor schedule.

createLessonfunction

Creates a fresh lesson game with its authored setup and queue.

createLevelfunction

Creates a fresh game with the authored rules, board, queue, and finite move budget.

CreateOptionstype

Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.

decodeGamefunction

Replays bounded canonical input and verifies every saved checkpoint field.

encodeGamefunction

Encodes canonical settings, accepted tick-stamped actions and a verified replay checkpoint.

Floortype

The native calm or magnetic floor used when settling blocks.

FloorScheduletype

A fixed, periodic or authored schedule selecting the floor for committed block placements.

GameEventtype

An event emitted by one native transition; type selects the event’s additional fields.

GameStatetype

The immutable authoritative native game state, including its board, random state and recording.

GameStatustype

A compact native status derived from the authoritative state for a host’s labels.

Gemtype

A native gem with a stable run-local id and colour.

getLessonfunction

Finds one of the three bilingual rules lessons by stable ID.

getLevelfunction

Finds a Magnetic Blocks campaign level by stable ID or one-based display number.

getTutorialfunction

Find a magnetic-block lesson by stable id; returns undefined when no lesson has that id.

Goaltype

The native authored goal; its discriminant selects the required collection or clearing condition.

GRAVITY_TICKSconstant

Fixed 60 Hz ticks in the magnetic-block gravity phase.

impactSupportIdsfunction

Collects the occupied one-cell support layer under both block columns at first contact.

landingYfunction

Find the last legal block row before downward collision.

legalActionsfunction

Lists accepted controls for the current falling or resolution phase.

lessonManifestconstant

The frozen native bilingual lessons and their authored teaching steps.

levelManifestconstant

The frozen ordered native levels; array indices start at zero and display numbers start at one.

MagneticCampaignLeveltype

One authored native challenge with its stable id, setup, winning witness, measurements and review status.

MagneticCampaignManifesttype

The ordered native campaign, its generation/grading revisions, checksum and measured levels.

MagneticDifficultyMetricstype

The bounded engine measurements used to grade this campaign; they do not claim human difficulty.

magneticGravityfunction

Magnetic floor removes all bonds and settles each column segment independently.

MagneticLessontype

One bilingual native lesson with its authored setup, teaching steps and winning witness.

MARK_TICKSconstant

The fixed 60 Hz ticks showing the magnetic-block match mark phase.

matchGroupsfunction

Computes deterministic orthogonal colour components of at least four gems.

Modetype

The native game mode; authored challenges have fixed setup and queue rules.

Phasetype

The native falling, resolution, pause and ending phases.

RecordedActiontype

A native action recording with the logical position needed for deterministic replay.

REMOVE_TICKSconstant

Fixed 60 Hz ticks in the magnetic-block removal phase.

removeIdsfunction

Remove the selected native cell indices and discard bonds whose endpoint gems were removed.

restartGamefunction

Restarts the same seed, custom starting board, fixed queue, rules and floor options.

Settingstype

Validated settings fixed at native game creation.

settlefunction

Settle surviving gems with the chosen floor rule and retain valid stable-id bonds.

statusOffunction

Returns a compact immutable status including current and upcoming floor state.

Transitiontype

The resulting native state, emitted events and acceptance decision; rejected actions preserve the input.

tutorialManifestconstant

Alias kept alongside other Houseki campaign lesson APIs.

@johnmorrisdotca/houseki