Variable gridEventsEnum`Const`

gridEventsEnum: {
    BOUNDARY: string;
    BOUNDARY_X: string;
    BOUNDARY_Y: string;
    CREATED: string;
    DESTROYED: string;
    MOVE_BLOCKED: string;
    MOVE_COLLISION: string;
    MOVE_DETTACH: string;
    MOVE_DOWN: string;
    MOVE_LAND: string;
    MOVE_LEFT: string;
    MOVE_RIGHT: string;
    MOVE_UP: string;
    RENDERED: string;
    WRAP: string;
    WRAP_X: string;
    WRAP_Y: string;
} = ...

String names of bubbling CustomEvents emitted by GameGrid.

Type Declaration

BOUNDARY: string
Aggregate finite-edge clamp fired after axis-specific gridEventsEnum.BOUNDARY_X / gridEventsEnum.BOUNDARY_Y.
BOUNDARY_X: string
X-axis requested outside row length while IOptions.infiniteX is falsy — coordinate clamped.
BOUNDARY_Y: string
Y-axis requested outside matrix height while IOptions.infiniteY is falsy — coordinate clamped.
CREATED: string
Dispatched at the end of construction (after optional initial GameGrid.render).
DESTROYED: string
Dispatched from GameGrid.destroy; always fired even if the grid stayed headless or unmounted.
MOVE_BLOCKED: string
Target rejected by IOptions.blockOnType or IOptions.moveOnType allow-list; coords roll back.
MOVE_COLLISION: string
Avatar entered an IOptions.collideOnType cell (movement may still succeed).
MOVE_DETTACH: string
Avatar left a collide-type cell (IOptions.collideOnType) from the square it occupied before this move attempt.
MOVE_DOWN: string
MOVE_LAND: string
Finished resolving block/collide boundary/wrap choreography; mirrors the onLand callback in IOptions.callbacks.
MOVE_LEFT: string
onMove already ran; precedes GameGrid.setActiveCell for keyboard/pointer navigation.
MOVE_RIGHT: string
MOVE_UP: string
RENDERED: string
Dispatched after GameGrid.render wires the container; detail follows IGameGridEventDetail.
WRAP: string
Aggregate wrap fired after gridEventsEnum.WRAP_X / gridEventsEnum.WRAP_Y repositioning with IOptions.infiniteX / IOptions.infiniteY enabled.
WRAP_X: string
Horizontal infinite teleport to opposite edge (runs alongside onWrapX in IOptions.callbacks).
WRAP_Y: string
Vertical infinite teleport (runs alongside onWrapY in IOptions.callbacks).

Remarks

Every dispatch funnels through the internal helper fireGameGridEvent; detail matches IGameGridEventDetail (always carries gameGridInstance).
Prefer IOptions.eventTarget (or attach on a bubbled ancestor) when running multiple grids on one page.

Example

const target = gg.options.eventTarget ?? window;
target.addEventListener(gridEventsEnum.MOVE_LAND, (event: GameGridDOMEvent) => {
  const { gameGridInstance } = event.detail;
  console.log(gameGridInstance.getState());
});

Variable gridEventsEnumConst

Type Declaration

BOUNDARY: string

BOUNDARY_X: string

BOUNDARY_Y: string

CREATED: string

DESTROYED: string

MOVE_BLOCKED: string

MOVE_COLLISION: string

MOVE_DETTACH: string

MOVE_DOWN: string

MOVE_LAND: string

MOVE_LEFT: string

MOVE_RIGHT: string

MOVE_UP: string

RENDERED: string

WRAP: string

WRAP_X: string

WRAP_Y: string

Remarks

Example

Settings

Variable gridEventsEnum`Const`