## Summary Multi-Z cells (bridges, stairs, paver-over-ground, multi-floor structures) now carry **per-stratum walkability data** in the cache instead of falling through to the slow path. The data is computed at chunk-build time, persisted in the `.swb` file, and selected at query time by matching the request's `sourceZ` against each stratum's `zCenter` (within `StepHeight` tolerance). This is the Tier 4 strata feature, deferred from PR #2447 / PR #2448 / PR #2449. Builds on PR #2449's lazy backing store and public bake helpers. ## Wire format change (v1 → v2) `StepCacheFile.FormatVersion = 2`. `MinSupportedVersion = 2`. v1 `.swb` files are silently rejected at open time (treated as missing) and overwritten on the next `SaveToFile` / `BakeMap`. **No migration** — older files just get re-baked. The `MinSupportedVersion` sentinel is the model going forward: bump the constant when an incompatible change lands; admins re-bake on the next deploy. No matrix of v1↔v2↔v3 migration logic to maintain. ## What changed - **`StepProbe.ComputeStrataAt(map, x, y)`** — enumerates walkable standing-Zs at the cell (one per land surface plus one per walkable static), collapses Zs within `2*StepHeight`, runs `ComputeMaskAt` at each surviving Z. Returns `null` for single-Z cells (caller uses the chunk's main mask). - **`StepChunk`** — replaces the old `MultiZCells` bitmap with a **strata storage pair**: - `ushort[256] StrataOffsetByCell` (sentinel `NoStrata = 0xFFFF` = "no strata for that cell") - `byte[] StrataData` packed: `u8 stratumCount`, then `count × 19-byte stratum` - `sbyte zCenter, byte walkMask, byte wetMask, sbyte walkZ_N..NW (8), sbyte swimZ_N..NW (8)` - `IsCellMultiZ` derives from `StrataOffsetByCell[cell] != NoStrata` — same semantics, single source of truth. - **`StepCache.BuildChunk`** — populates strata for cells flagged multi-Z via `SetStrata`. Chunks with zero multi-Z cells pay zero strata overhead (offset array + data array stay null). - **`StepCache.TryGetMask`** — for multi-Z cells, scans strata with `TryStratumHit`; returns the matching one with `HitKind=Hit`. Falls through to slow path only when no stratum matches the query `sourceZ`. - **`StepCacheFile`** — v2 serialization with strata trailer per chunk + `recordLength` in index entry. Lazy reader sizes scratch per-chunk-record using the recorded length, growing on demand for multi-Z-heavy chunks. Patches `IndexOffset` on `w.Buffer` (BufferWriter's current backing array) since it grows during variable-size chunk writes. ## File layout v2 ``` Header (48 bytes): u32 Magic = 0x42575300 ('SWB\0') u32 Version = 2 u32 MapId u64 Fingerprint XxHash3 over LandTable + ItemTable flags + map files (mapX.mul/.uop, staidxX.mul, staticsX.mul) u64 BakeTimestamp informational u32 ChunkCount u64 IndexOffset position where chunk index begins Per chunk (variable size): u16 ChunkX, ChunkY u32 BuiltMultisVersion u8 HasStrata 0 = no strata trailer; 1 = strata trailer follows byte WalkMask[256], WetMask[256] sbyte SourceZ[256], WalkZN..WalkZNW[256], SwimZN..SwimZNW[256] // Strata trailer (only when HasStrata == 1): u16 StrataOffsetByCell[256] // NoStrata sentinel = 0xFFFF u32 StrataDataLength byte StrataData[StrataDataLength] Per multi-Z cell: u8 count, then count × Stratum (19 bytes) Index trailer (20 × ChunkCount bytes): per chunk: { u64 chunkKey, u64 fileOffset, u32 recordLength } ```
384 lines
12 KiB
C#
384 lines
12 KiB
C#
using System;
|
|
using CalcMoves = Server.Movement.Movement;
|
|
|
|
namespace Server.Engines.Pathing.Cache;
|
|
|
|
/// <summary>
|
|
/// Computes static-only walkability for a single cell — the per-cell, per-direction
|
|
/// "can step" mask and destination Z, based purely on land + statics + multis. Mirrors
|
|
/// <see cref="MovementImpl"/>.Check minus the item and mobile collision phases.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Bakes two rule sets per cell: walker (canSwim=false, cantWalk=false) and swim-only
|
|
/// (canSwim=true, cantWalk=true). Item / mobile collision phases are omitted (they're
|
|
/// the dynamic-obstacle pass's job). Diagonal corner-cut is NOT applied here; callers
|
|
/// must AND the partner-cell results at query time.
|
|
/// </remarks>
|
|
public static class StepProbe
|
|
{
|
|
private const int PersonHeight = 16;
|
|
private const int StepHeight = 2;
|
|
|
|
public readonly struct ComputedStratum(sbyte zCenter, StepMask mask)
|
|
{
|
|
public readonly sbyte ZCenter = zCenter;
|
|
public readonly StepMask Mask = mask;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tier 4 strata builder: enumerates the distinct walkable standing-Zs at (x, y)
|
|
/// — one per land surface plus one per walkable static — and runs
|
|
/// <see cref="ComputeMaskAt"/> at each, producing a per-stratum walkability snapshot.
|
|
/// Returns null when the cell has 0 or 1 strata (single-Z; the caller should use
|
|
/// the chunk's main mask).
|
|
/// </summary>
|
|
public static ComputedStratum[] ComputeStrataAt(Map map, int x, int y)
|
|
{
|
|
if (map == null || map == Map.Internal)
|
|
{
|
|
return null;
|
|
}
|
|
if (x < 0 || y < 0 || x >= map.Width || y >= map.Height)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Collect candidate Zs. 16 slots is generous — multi-Z cells in practice rarely
|
|
// exceed 3-4 surfaces (bridge over land, paver-over-ground, multi-floor stairs).
|
|
Span<int> zs = stackalloc int[16];
|
|
var count = 0;
|
|
|
|
var landTile = map.Tiles.GetLandTile(x, y);
|
|
var landFlags = TileData.LandTable[landTile.ID & TileData.MaxLandValue].Flags;
|
|
if (!landTile.Ignored && (landFlags & TileFlag.Impassable) == 0)
|
|
{
|
|
map.GetAverageZ(x, y, out _, out var landCenter, out _);
|
|
zs[count++] = landCenter;
|
|
}
|
|
|
|
foreach (var tile in map.Tiles.GetStaticAndMultiTiles(x, y))
|
|
{
|
|
if (count >= zs.Length)
|
|
{
|
|
break;
|
|
}
|
|
var data = TileData.ItemTable[tile.ID & TileData.MaxItemValue];
|
|
if (!data.Surface || data.Impassable)
|
|
{
|
|
continue;
|
|
}
|
|
zs[count++] = tile.Z + data.CalcHeight;
|
|
}
|
|
|
|
if (count <= 1)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
// Sort and merge near-equal Zs. Two Zs separated by less than 2*StepHeight collapse
|
|
// into a single stratum — the slow path's tolerance treats them as the same surface.
|
|
zs[..count].Sort();
|
|
Span<int> distinct = stackalloc int[16];
|
|
var distinctCount = 0;
|
|
for (var i = 0; i < count; i++)
|
|
{
|
|
if (distinctCount == 0 || zs[i] - distinct[distinctCount - 1] > 2 * StepHeight)
|
|
{
|
|
distinct[distinctCount++] = zs[i];
|
|
}
|
|
}
|
|
|
|
if (distinctCount <= 1)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
var strata = new ComputedStratum[distinctCount];
|
|
for (var i = 0; i < distinctCount; i++)
|
|
{
|
|
var z = (sbyte)Math.Clamp(distinct[i], sbyte.MinValue, sbyte.MaxValue);
|
|
strata[i] = new ComputedStratum(z, ComputeMaskAt(map, x, y, z));
|
|
}
|
|
return strata;
|
|
}
|
|
|
|
public static StepMask ComputeMaskAt(Map map, int x, int y, sbyte sourceZ)
|
|
{
|
|
if (map == null || map == Map.Internal)
|
|
{
|
|
return default;
|
|
}
|
|
|
|
GetStaticStartZ(map, x, y, sourceZ, canSwim: false, cantWalk: false,
|
|
out var walkStartZ, out var walkStartTop, out _);
|
|
GetStaticStartZ(map, x, y, sourceZ, canSwim: true, cantWalk: true,
|
|
out var swimStartZ, out var swimStartTop, out _);
|
|
|
|
byte walkMask = 0;
|
|
byte wetMask = 0;
|
|
Span<sbyte> walkZs = stackalloc sbyte[8];
|
|
Span<sbyte> swimZs = stackalloc sbyte[8];
|
|
// stackalloc is NOT zero-initialized — unwritten slots hold whatever was on the
|
|
// stack. Clear before use; the loop only writes slots where the step succeeds.
|
|
walkZs.Clear();
|
|
swimZs.Clear();
|
|
|
|
for (var d = 0; d < 8; d++)
|
|
{
|
|
var dx = x;
|
|
var dy = y;
|
|
CalcMoves.Offset((Direction)d, ref dx, ref dy);
|
|
|
|
if (CheckStaticStep(map, dx, dy, walkStartZ, walkStartTop,
|
|
canSwim: false, cantWalk: false, out var walkZ))
|
|
{
|
|
walkMask |= (byte)(1 << d);
|
|
walkZs[d] = (sbyte)walkZ;
|
|
}
|
|
|
|
if (CheckStaticStep(map, dx, dy, swimStartZ, swimStartTop,
|
|
canSwim: true, cantWalk: true, out var swimZ))
|
|
{
|
|
wetMask |= (byte)(1 << d);
|
|
swimZs[d] = (sbyte)swimZ;
|
|
}
|
|
}
|
|
|
|
return new StepMask(
|
|
walkMask, wetMask,
|
|
walkZs[0], walkZs[1], walkZs[2], walkZs[3],
|
|
walkZs[4], walkZs[5], walkZs[6], walkZs[7],
|
|
swimZs[0], swimZs[1], swimZs[2], swimZs[3],
|
|
swimZs[4], swimZs[5], swimZs[6], swimZs[7]
|
|
);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the slow path's standing-Z for a default walker at (x, y). Mirrors
|
|
/// MovementImpl.Check's surface-selection — paver Z+1 for paver-over-ground,
|
|
/// landCenter for bare land. Used by <see cref="StepCache"/> to bake SourceZ so
|
|
/// A*'s tracked-per-cell Z matches the cache's bake-time assumption.
|
|
/// </summary>
|
|
public static int ComputeStandingZ(Map map, int x, int y, int locZ)
|
|
{
|
|
GetStaticStartZ(map, x, y, locZ, canSwim: false, cantWalk: false,
|
|
out _, out _, out var zCenter);
|
|
return zCenter;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mirrors GetStartZ from MovementImpl, parameterized by canSwim / cantWalk.
|
|
/// </summary>
|
|
private static void GetStaticStartZ(
|
|
Map map, int x, int y, int locZ, bool canSwim, bool cantWalk,
|
|
out int zLow, out int zTop, out int zCenter
|
|
)
|
|
{
|
|
var landTile = map.Tiles.GetLandTile(x, y);
|
|
var flags = TileData.LandTable[landTile.ID & TileData.MaxLandValue].Flags;
|
|
var impassable = (flags & TileFlag.Impassable) != 0;
|
|
|
|
// Mirrors MovementImpl: impassable + swim on water is OK; otherwise block on
|
|
// cantWalk or impassable.
|
|
var landBlocks = (cantWalk || impassable)
|
|
&& !(impassable && canSwim && (flags & TileFlag.Wet) != 0);
|
|
|
|
map.GetAverageZ(x, y, out var landZ, out var landCenter, out var landTop);
|
|
|
|
var considerLand = !landTile.Ignored;
|
|
|
|
zCenter = zLow = zTop = 0;
|
|
var isSet = false;
|
|
|
|
if (considerLand && !landBlocks && locZ >= landCenter)
|
|
{
|
|
zLow = landZ;
|
|
zCenter = landCenter;
|
|
zTop = landTop;
|
|
isSet = true;
|
|
}
|
|
|
|
foreach (var tile in map.Tiles.GetStaticAndMultiTiles(x, y))
|
|
{
|
|
var id = TileData.ItemTable[tile.ID & TileData.MaxItemValue];
|
|
var calcTop = tile.Z + id.CalcHeight;
|
|
|
|
if (isSet && calcTop < zCenter || locZ < calcTop || !id.Surface && !(canSwim && id.Wet))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
zLow = tile.Z;
|
|
zCenter = calcTop;
|
|
|
|
var top = tile.Z + id.Height;
|
|
|
|
if (!isSet || top > zTop)
|
|
{
|
|
zTop = top;
|
|
}
|
|
|
|
isSet = true;
|
|
}
|
|
|
|
if (!isSet)
|
|
{
|
|
zLow = zTop = locZ;
|
|
}
|
|
else if (locZ > zTop)
|
|
{
|
|
zTop = locZ;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mirrors MovementImpl.Check for static tiles only, parameterized by canSwim / cantWalk.
|
|
/// Items and mobile collision phases are omitted.
|
|
/// </summary>
|
|
private static bool CheckStaticStep(
|
|
Map map, int x, int y, int startZ, int startTop, bool canSwim, bool cantWalk,
|
|
out int newZ
|
|
)
|
|
{
|
|
newZ = 0;
|
|
|
|
if (x < 0 || y < 0 || x >= map.Width || y >= map.Height)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var landTile = map.Tiles.GetLandTile(x, y);
|
|
var flags = TileData.LandTable[landTile.ID & TileData.MaxLandValue].Flags;
|
|
var impassable = (flags & TileFlag.Impassable) != 0;
|
|
|
|
var landBlocks = (cantWalk || impassable)
|
|
&& !(impassable && canSwim && (flags & TileFlag.Wet) != 0);
|
|
|
|
var considerLand = !landTile.Ignored;
|
|
|
|
map.GetAverageZ(x, y, out var landZ, out var landCenter, out _);
|
|
|
|
var moveIsOk = false;
|
|
|
|
var stepTop = startTop + StepHeight;
|
|
var checkTop = startZ + PersonHeight;
|
|
|
|
int testTop;
|
|
|
|
foreach (var tile in map.Tiles.GetStaticAndMultiTiles(x, y))
|
|
{
|
|
var itemData = TileData.ItemTable[tile.ID & TileData.MaxItemValue];
|
|
var notWater = !itemData.Wet;
|
|
|
|
// Mirrors MovementImpl: skip if not a passable surface AND not swimmable water,
|
|
// OR if the mobile can't walk and this isn't water.
|
|
if ((!itemData.Surface || itemData.Impassable) && (!canSwim || notWater)
|
|
|| cantWalk && notWater)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
var itemZ = tile.Z;
|
|
var itemTop = itemZ;
|
|
var ourZ = itemZ + itemData.CalcHeight;
|
|
testTop = checkTop;
|
|
|
|
if (moveIsOk)
|
|
{
|
|
var cmp = Math.Abs(ourZ - startZ) - Math.Abs(newZ - startZ);
|
|
|
|
if (cmp > 0 || cmp == 0 && ourZ > newZ)
|
|
{
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if (ourZ + PersonHeight > testTop)
|
|
{
|
|
testTop = ourZ + PersonHeight;
|
|
}
|
|
|
|
if (!itemData.Bridge)
|
|
{
|
|
itemTop += itemData.Height;
|
|
}
|
|
|
|
if (stepTop < itemTop)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
var landCheck = itemZ + Math.Min(itemData.Height, StepHeight);
|
|
|
|
if (considerLand && landCheck < landCenter && landCenter > ourZ && testTop > landZ)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
if (StaticsBlockAt(map, x, y, ourZ, testTop))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
newZ = ourZ;
|
|
moveIsOk = true;
|
|
}
|
|
|
|
if (!considerLand || landBlocks || stepTop < landZ)
|
|
{
|
|
return moveIsOk;
|
|
}
|
|
|
|
testTop = checkTop;
|
|
|
|
if (landCenter + PersonHeight > testTop)
|
|
{
|
|
testTop = landCenter + PersonHeight;
|
|
}
|
|
|
|
var shouldCheck = true;
|
|
|
|
if (moveIsOk)
|
|
{
|
|
var cmp = Math.Abs(landCenter - startZ) - Math.Abs(newZ - startZ);
|
|
|
|
if (cmp > 0 || cmp == 0 && landCenter > newZ)
|
|
{
|
|
shouldCheck = false;
|
|
}
|
|
}
|
|
|
|
if (shouldCheck && !StaticsBlockAt(map, x, y, landCenter, testTop))
|
|
{
|
|
newZ = landCenter;
|
|
moveIsOk = true;
|
|
}
|
|
|
|
return moveIsOk;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Mirrors the static-tile portion of IsOk: returns true if any static tile at (x,y)
|
|
/// has ImpassableSurface and overlaps the vertical range (ourZ, testTop).
|
|
/// </summary>
|
|
private static bool StaticsBlockAt(Map map, int x, int y, int ourZ, int testTop)
|
|
{
|
|
foreach (var check in map.Tiles.GetStaticAndMultiTiles(x, y))
|
|
{
|
|
var itemData = TileData.ItemTable[check.ID & TileData.MaxItemValue];
|
|
|
|
if (itemData.ImpassableSurface)
|
|
{
|
|
var checkZ = check.Z;
|
|
var checkTop = checkZ + itemData.CalcHeight;
|
|
|
|
if (checkTop > ourZ && testTop > checkZ)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|