add documentation

This commit is contained in:
Alexander Borisov
2026-04-08 20:58:30 +03:00
parent 31826bd4e0
commit 1681e44c5e
11 changed files with 240 additions and 0 deletions
@@ -2,6 +2,9 @@ using UnityEngine;
namespace InfiniteWorld.VoxelWorld.Contracts
{
/// <summary>
/// Signals that a chunk now has valid nav geometry and dependent coverage windows should invalidate cached builds.
/// </summary>
public readonly struct ChunkNavGeometryReadyMessage
{
public ChunkNavGeometryReadyMessage(Vector2Int coord, int version)
@@ -10,10 +13,20 @@ namespace InfiniteWorld.VoxelWorld.Contracts
Version = version;
}
/// <summary>
/// Chunk coordinate whose nav geometry became available.
/// </summary>
public Vector2Int Coord { get; }
/// <summary>
/// Version of the chunk runtime state associated with this notification.
/// </summary>
public int Version { get; }
}
/// <summary>
/// Signals that a chunk's nav geometry is being removed so dependent coverage windows can drop stale build data.
/// </summary>
public readonly struct ChunkNavGeometryRemovedMessage
{
public ChunkNavGeometryRemovedMessage(Vector2Int coord, int version)
@@ -22,10 +35,20 @@ namespace InfiniteWorld.VoxelWorld.Contracts
Version = version;
}
/// <summary>
/// Chunk coordinate whose nav geometry is no longer available.
/// </summary>
public Vector2Int Coord { get; }
/// <summary>
/// Last known version of the chunk state before removal.
/// </summary>
public int Version { get; }
}
/// <summary>
/// Invalidates consumers that cache the current world interest set.
/// </summary>
public readonly struct WorldInterestChangedMessage
{
public WorldInterestChangedMessage(int version)
@@ -33,9 +56,15 @@ namespace InfiniteWorld.VoxelWorld.Contracts
Version = version;
}
/// <summary>
/// Monotonic version of the world interest state after the change.
/// </summary>
public int Version { get; }
}
/// <summary>
/// Invalidates consumers that cache transient nav coverage hints.
/// </summary>
public readonly struct NavCoverageHintChangedMessage
{
public NavCoverageHintChangedMessage(int version)
@@ -43,6 +72,9 @@ namespace InfiniteWorld.VoxelWorld.Contracts
Version = version;
}
/// <summary>
/// Monotonic version of the active nav hint state after the change.
/// </summary>
public int Version { get; }
}
}