Table of Contents

Struct ObstacleClearEventInfo

Namespace
GridForge.Grids
Assembly
GridForge.dll

Immutable snapshot describing a bulk obstacle clear operation on a voxel.

public readonly struct ObstacleClearEventInfo
Inherited Members

Constructors

ObstacleClearEventInfo(WorldVoxelIndex, byte, uint)

Initializes a new immutable obstacle clear snapshot.

public ObstacleClearEventInfo(WorldVoxelIndex voxelIndex, byte clearedObstacleCount, uint gridVersion)

Parameters

voxelIndex WorldVoxelIndex
clearedObstacleCount byte
gridVersion uint

Fields

ClearedObstacleCount

The number of obstacles removed by the clear operation.

public readonly byte ClearedObstacleCount

Field Value

byte

GridVersion

The grid version recorded after the clear operation completes.

public readonly uint GridVersion

Field Value

uint

VoxelIndex

The voxel that had its obstacles cleared.

public readonly WorldVoxelIndex VoxelIndex

Field Value

WorldVoxelIndex

Properties

GridIndex

The grid index containing VoxelIndex.

public ushort GridIndex { get; }

Property Value

ushort