| | | 1 | | //======================================================================= |
| | | 2 | | // ObstacleClearEventInfo.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024–present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using GridForge.Spatial; |
| | | 9 | | |
| | | 10 | | namespace GridForge.Grids; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Immutable snapshot describing a bulk obstacle clear operation on a voxel. |
| | | 14 | | /// </summary> |
| | | 15 | | public readonly struct ObstacleClearEventInfo |
| | | 16 | | { |
| | | 17 | | /// <summary> |
| | | 18 | | /// The voxel that had its obstacles cleared. |
| | | 19 | | /// </summary> |
| | | 20 | | public readonly WorldVoxelIndex VoxelIndex; |
| | | 21 | | |
| | | 22 | | /// <summary> |
| | | 23 | | /// The number of obstacles removed by the clear operation. |
| | | 24 | | /// </summary> |
| | | 25 | | public readonly byte ClearedObstacleCount; |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// The grid version recorded after the clear operation completes. |
| | | 29 | | /// </summary> |
| | | 30 | | public readonly uint GridVersion; |
| | | 31 | | |
| | | 32 | | /// <summary> |
| | | 33 | | /// The grid index containing <see cref="VoxelIndex"/>. |
| | | 34 | | /// </summary> |
| | 1 | 35 | | public readonly ushort GridIndex => VoxelIndex.GridIndex; |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Initializes a new immutable obstacle clear snapshot. |
| | | 39 | | /// </summary> |
| | | 40 | | public ObstacleClearEventInfo( |
| | | 41 | | WorldVoxelIndex voxelIndex, |
| | | 42 | | byte clearedObstacleCount, |
| | | 43 | | uint gridVersion) |
| | | 44 | | { |
| | 561 | 45 | | VoxelIndex = voxelIndex; |
| | 561 | 46 | | ClearedObstacleCount = clearedObstacleCount; |
| | 561 | 47 | | GridVersion = gridVersion; |
| | 561 | 48 | | } |
| | | 49 | | } |