Rexboard Grids And Coordinates
Developmentrexboard-grids-and-coordinatesRexboard Grids And Coordinates is an Agent Skill for development published in the rexrainbow/phaser3-rex-notes repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use this skill when working with RexBoard grid coordinates, quadGrid, hexagonGrid, tileXY, worldXY, tile-to-world conversion, world-to-tile conversion, orthogonal, isometric, staggeraxis, staggerindex, direction indexes, neighbor tiles, or board grid shape queries. Triggers on: RexBoard grid, rexBoard quadGrid, rexBoard hexagonGrid, tileXY, worldXY, getWorldXY, getTileXY, RexBoard direction, RexBoard neighbors.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/rexrainbow/phaser3-rex-notes/blob/HEAD/skills/rexboard/rexboard-grids-and-coordinates/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/rexboard-grids-and-coordinates, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
RexBoard Grids And Coordinates
Use this skill for RexBoard coordinate systems and board geometry. It covers quad/hex grid creation, tile/world conversion, neighbor directions, and shape-to-tile queries.
Use This First
Pick the grid factory before writing board logic:
| Need | Use |
|---|---|
| Orthogonal square/rect board | quadGrid with type: 'orthogonal' |
| Isometric diamond board | quadGrid with type: 'isometric' |
| Hex board | hexagonGrid with staggeraxis and staggerindex |
Then pass the grid into this.rexBoard.add.board({ grid, width, height }) or new Board(scene, { grid, width, height }).
Required Setup
This skill assumes RexBoard is available as this.rexBoard or through direct imports from board-components.js. If not, use rexboard-setup-and-factory.
References
Read these only when needed:
references/grid-config.md: quad/hex config fields and embedded board grid configs.references/coordinate-conversion.md:getWorldXY,getTileXY, board conversion, bounds, and shape queries.references/directions-and-neighbors.md: direction indexes, neighbor APIs, range queries, and quad/hex direction notes.references/grid-recipes.md: reduced recipes for orthogonal, isometric, hex, and pointer-to-tile patterns.
Core Rules
- A
Boarddelegates coordinate conversion to itsgrid. - Prefer board conversion methods after a board exists:
tileXYToWorldXY,worldXYToTileXY, andworldXYSnapToGrid. - Use raw grid methods only for grid-only work:
grid.getWorldXY,grid.getTileXY,grid.getGridPoints, andgrid.getBounds. - Quad
dir: '4dir'versusdir: '8dir'changes neighbor directions. - Hex
staggeraxisandstaggerindexaffect both visual layout and adjacency. - Direction indexes depend on grid mode. Avoid hard-coding semantic names unless the grid mode is fixed.
Source File Map
plugins/board/grid/quad/Quad.d.ts: quad grid config and conversion methods.plugins/board/grid/hexagon/Hexagon.d.ts: hex grid config and conversion methods.plugins/board/board/LogicBoard.d.ts: board-level conversion, bounds, neighbors, ranges, and shape queries.plugins/board/grid/quad/Factory.js:quadGridfactory signature.plugins/board/grid/hexagon/Factory.js:hexagonGridfactory signature.
Related Skills
rexboard-setup-and-factory: plugin setup and factory discovery.rexboard-components-catalog: choose a board component family.rexboard-board-and-chess: board construction,tileZ, occupancy, and input events.rexboard-map-generation-and-import: generated hex map coordinate sets.
Gotchas
wrapandinfinityare board settings, not grid settings, but they change neighbor and bounds behavior.tileX/tileYidentify grid coordinates; chess placement also needstileZ.- Shape-to-tile queries return tile coordinate arrays, not chess objects.