Fix: GameMaker ds_grid Index Out of Bounds

You build a grid-based level system, spawn tiles into a ds_grid, and the game crashes the moment the player steps on the rightmost column. The error says “index out of bounds” and points at a perfectly innocent-looking grid access. The bug is a classic off-by-one: you are treating the grid’s width as a valid index when it is actually the count.

The Off-by-One

ds_grid_create(10, 8) creates a grid with 10 columns (x: 0–9) and 8 rows (y: 0–7). The maximum valid index is always width - 1 and height - 1. Accessing ds_grid_get(grid, 10, 0) is out of bounds.

The bug hides because most loops iterate for (var i = 0; i < width; i++) with a strict less-than, which is correct. The crash appears when you use <= or when you compute an index from game coordinates and forget to clamp.

// BAD: off-by-one
for (var xx = 0; xx <= ds_grid_width(grid); xx++) {
    for (var yy = 0; yy <= ds_grid_height(grid); yy++) {
        var val = ds_grid_get(grid, xx, yy); // crashes on last iteration
    }
}

// GOOD: strict less-than
for (var xx = 0; xx < ds_grid_width(grid); xx++) {
    for (var yy = 0; yy < ds_grid_height(grid); yy++) {
        var val = ds_grid_get(grid, xx, yy);
    }
}

World Coordinates to Grid Indices

The second common cause is converting world pixel coordinates to grid indices without clamping. A player at position (639, 480) in a 32-pixel tile grid maps to index (19, 15). If the grid was created with ds_grid_create(20, 15), x = 19 is valid but y = 15 is out of bounds (max is 14).

// Safe world-to-grid conversion
function grid_get_safe(grid, world_x, world_y, tile_size) {
    var gx = clamp(floor(world_x / tile_size), 0, ds_grid_width(grid) - 1);
    var gy = clamp(floor(world_y / tile_size), 0, ds_grid_height(grid) - 1);
    return ds_grid_get(grid, gx, gy);
}

The clamp is cheap and prevents every possible out-of-bounds access from world coordinates.

ds_grid_resize Pitfalls

ds_grid_resize(grid, new_w, new_h) preserves existing data and initializes new cells to 0. But code that was written for the old dimensions still uses the old width and height. If you resize from 10×10 to 5×5, any loop that still runs to 10 crashes.

Always re-read ds_grid_width and ds_grid_height after a resize. Never cache them in variables that outlive the resize call.

Memory Leaks

Unlike arrays, ds_grid allocates on the heap and is not garbage-collected. Every ds_grid_create must be matched by a ds_grid_destroy, usually in the Destroy or Clean Up event of the object that owns it.

// Clean Up event
if (ds_exists(grid, ds_type_grid)) {
    ds_grid_destroy(grid);
}

If you create a grid per level and forget to destroy the old one on room change, you leak one grid per level load. Over a long session, this adds up.

When to Use Arrays Instead

GameMaker 2.3+ supports 2D arrays natively (var arr = array_create(w) with each element being another array). Arrays are garbage-collected and do not need manual destruction. For simple tile data, arrays are simpler and safer. Use ds_grid when you need the built-in region functions (ds_grid_get_max, ds_grid_get_sum, ds_grid_sort) or when you need to pass the grid to functions that expect a ds_grid ID.

Verifying the Fix

Add a debug overlay that draws each grid cell as a colored rectangle. Red cells at the edges confirm you are accessing the full range. If the last row or column is missing, your loop is stopping one short. If the game crashes when the overlay runs, your loop goes one too far.

Understanding the issue

This bug class falls into a pattern that's worth understanding beyond the specific case. In GameMaker Studio, the underlying behavior is shaped by how the engine layers its abstractions - the public API you call, the runtime systems that respond, and the platform-specific implementations underneath. A bug at any layer can produce symptoms that look like they originate at a different layer. Triaging effectively means recognizing which layer the symptom belongs to, even when the gameplay code is what's visible.

The specific bug described above is the kind that surfaces during integration rather than unit testing. It depends on a combination of factors: the asset configuration, the runtime state, the platform's specific behavior. In isolation, each piece looks correct; in combination, the bug emerges. This is why thorough integration testing - playing the actual game in realistic conditions - catches things that automated tests miss.

Why this happens

This bug class disproportionately affects late-stage development. The work to surface it is interactive testing in realistic conditions, which only really happens after the gameplay is in place and assets are populated. Catching it early requires deliberate testing of conditions that look unimportant.

At the engine level, the behavior comes from a deliberate design decision in GameMaker. The engine team chose a particular trade-off - usually performance versus convenience, or generality versus specificity - and that trade-off has consequences when you push against it. Understanding the trade-off is what turns 'this bug is mysterious' into 'this bug is the expected consequence of this design'.

Verifying the fix

Verifying this fix in isolation is straightforward: reproduce the bug, apply the change, confirm the bug no longer reproduces. The harder verification is regression - did this fix introduce a new bug elsewhere? Run your standard regression suite, plus any tests that exercise the same code path with different inputs.

Reproducibility is the prerequisite for verification. If you can't reliably reproduce the bug pre-fix, you can't reliably verify it post-fix. Spend time getting a clean reproduction before you write any fix code. The fix is fast once you understand the reproduction; the reproduction is the slow part.

Variations to watch for

Related bug classes often share the same root cause. If you find yourself fixing this issue, look for cousins: similar symptoms in adjacent systems, the same data flow but a different value, or the same fix pattern in another module. The catalog of 'we've seen this before' becomes valuable institutional knowledge.

Adjacent bugs often share a root cause. After fixing the case you've found, spend an hour searching the codebase for similar patterns. What's the same call with different arguments? The same data flow with a different entity type? The same lifecycle issue in a sibling system? Each match is a candidate for the same fix, or a related fix that prevents future bugs of the same class.

In production

In shipping builds, this issue may interact with other production-only behavior. Stripping, encryption, asset bundling, and platform-specific code paths can each modify the symptoms. When players report a related issue, capture build SHA, platform, and any feature flags - those three fields cover most of the production-only variations.

When triaging a similar issue in production, prioritize gathering data over hypothesizing causes. A player report describes a symptom; what you need is a build SHA, a session timestamp, and ideally a screen recording or session replay. With those, the bug becomes tractable. Without them, you're guessing at hypothetical reproductions that may not match what the player actually hit.

Performance considerations

Performance implications matter when this bug class scales with player count or asset count. A bug that fires once per session is annoying; a bug that fires once per frame compounds. After fixing, profile the affected code path under realistic load. The fix that's correct for one entity may be too slow for ten thousand.

Diagnostic approach

Diagnosing this class of bug benefits from a structured approach: confirm the symptom, isolate the variables, hypothesize the cause, and verify the hypothesis before writing fix code. Skipping the isolation step is the most common mistake; without it, fixes often address symptoms while the underlying cause continues to produce other variations.

For GameMaker-specific diagnostics, the editor's profiler is the canonical starting point. Capture a representative frame with the symptom present; compare against a frame without the symptom; the diff often points directly at the cause. If the symptom is non-deterministic, capture multiple frames and look for the pattern - the cause is usually a state transition or a specific input value rather than a continuous effect.

Tooling and ecosystem

Third-party plugins often provide better diagnostics for their own behavior than the engine does. If the affected code is in a plugin, check the plugin's documentation for debug modes, verbose logging, or inspector tools - these can save hours of investigation when they exist.

Within GameMaker, the relevant diagnostic surfaces include the standard frame debugger, memory profiler, and engine-specific debug overlays. Each one shows a different facet of what's happening. The frame debugger reveals draw call ordering and state transitions; the memory profiler shows allocation patterns; the debug overlay reveals per-system state. Bugs that resist one tool usually surrender to another - the trick is knowing which tool to reach for first.

Edge cases and pitfalls

Edge cases for this class of issue often involve specific timing: the first frame after a state change, the last frame before a transition, frames where multiple subsystems update simultaneously. Reproducing these reliably is part of what makes the bug class hard to test.

When writing a regression test for this fix, focus on the boundary conditions that surfaced the original bug. Tests that exercise the happy path catch obvious regressions; tests that exercise the boundary catch the subtler regressions that look like new bugs but are really the original returning. The latter are the tests that earn their keep over the long life of the project.

Team communication

Document the fix and its rationale in the commit message or attached engineering doc. Future engineers will encounter related issues; the rationale tells them whether your fix is reusable or specific to the case at hand. Without rationale, the fix gets reverted or copied incorrectly.

If this fix touches a system several engineers work in, a short writeup in the team's engineering channel helps. Not a full design doc - a paragraph explaining what was wrong, what's fixed, and what to watch for. Future engineers encountering similar symptoms will search for the fix; making it findable is a small investment that pays back later.

“Every ds_grid bug is an off-by-one or a missing destroy. Check both and you have fixed 95% of the reports you will ever see about grids.”

Related Issues

For broader GameMaker data lifecycle issues, see GameMaker instance variables resetting on room change. For save data that references grid indices, see GameMaker save best practices.

Wrap every ds_grid access in a bounds check during development. The check is one line and saves hours of debugging silent crashes on edge tiles.