Interface IScyllaGrid<TCoord, TCell>

Base interface for all spatially-addressed Scylla grid collections. Extends IScyllaCollection with coordinate-keyed cell access and a topology-neutral contract that works identically for square, hexagonal, and triangular grid layouts.

Inherited Members
Namespace: Scylla.Core.Structures
Assembly: ScyllaCore.dll
Syntax
public interface IScyllaGrid<TCoord, TCell> : IScyllaCollection where TCoord : struct, IEquatable<TCoord>
Type Parameters
Name Description
TCoord

The coordinate type used to address cells. Must be a value type that implements IEquatable<T> so that equality comparisons and dictionary lookups are allocation-free. Concrete coordinate types are SquareCoord, HexCoord, and TriCoord.
TCell

The type of data stored in each grid cell. May be any type, including value types, reference types, or Unity structs such as Color or Vector2.
Remarks

This interface abstracts over two storage strategies used by concrete implementations:

Use this interface when writing code that must work with any grid topology or storage strategy. Prefer the concrete types for performance-critical paths that require direct indexer access or topology-specific operations such as neighbor queries, world-space conversions, or ring/range enumeration.

Properties

CellCount

Gets the number of populated (logically active) cells in the grid.

Declaration
int CellCount { get; }
Property Value
Type Description
int

For dense grids, this always equals Count - every cell slot is pre-allocated and considered populated regardless of its stored value. The value is fixed at construction and never changes.

For sparse grids, this equals the number of cells that have been explicitly written via TrySet(TCoord, TCell) and not yet removed. The value may be zero on a freshly created or cleared sparse grid.

See Also

Methods

Contains(TCoord)

Determines whether the specified coordinate is addressable and populated in this grid.

Declaration
bool Contains(TCoord coord)
Parameters
Type Name Description
TCoord coord

The coordinate to test.
Returns
Type Description
bool

For dense grids, returns true when coord maps to a valid index within the grid's pre-allocated array - that is, when the coordinate is geometrically within the grid's dimensions, regardless of the stored value.

For sparse grids, returns true only when coord has been explicitly written via TrySet(TCoord, TCell) and not since removed. An in-bounds coordinate that has never been written returns false.

Remarks

This method is equivalent to checking whether TryGet(TCoord, out TCell) would return true for the same coordinate. Use it when you only need the existence check and do not need the value.

See Also

TryGet(TCoord, out TCell)

Attempts to retrieve the value stored at the specified coordinate without throwing on failure.

Declaration
bool TryGet(TCoord coord, out TCell value)
Parameters
Type Name Description
TCoord coord

The grid coordinate to look up.
TCell value

When this method returns true, contains the cell value at coord. When this method returns false, contains default(TCell). This parameter is passed uninitialized and is always written before this method returns.
Returns
Type Description
bool

true if coord is within the grid's valid range and a value was successfully read; false if the coordinate is out of bounds (dense grids) or has not been explicitly written (sparse grids).
Remarks

Prefer this method over direct indexer access when the coordinate's validity is not guaranteed, as it avoids the cost of exception handling on out-of-bounds access. For dense grids, "within bounds" means the coordinate maps to a valid flat-array index. For sparse grids, "within bounds" additionally requires that the cell has been set.

See Also

TrySet(TCoord, TCell)

Attempts to store a value at the specified coordinate without throwing on failure.

Declaration
bool TrySet(TCoord coord, TCell value)
Parameters
Type Name Description
TCoord coord

The grid coordinate to write to.
TCell value

The value to store at coord.
Returns
Type Description
bool

true if the coordinate is valid and the value was successfully stored; false if the coordinate is out of bounds and no change was made.
Remarks

For dense grids, this writes to the pre-allocated cell at coord and returns false if the coordinate falls outside the grid's dimensions.

For sparse grids, this inserts or updates the entry at coord and returns false only when the grid is bounded and coord falls outside the defined bounds. On unbounded sparse grids this method always returns true.

A successful call increments CellCount on sparse grids when coord is newly written for the first time.

See Also

Extension Methods

See Also