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

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ObstacleClearEventInfo(WorldVoxelIndex, byte, uint, GridChangeStamp)

Initializes a new immutable obstacle clear snapshot.

public ObstacleClearEventInfo(WorldVoxelIndex voxelIndex, byte clearedObstacleCount, uint gridVersion, GridChangeStamp changeStamp = default)

Parameters

voxelIndex WorldVoxelIndex

clearedObstacleCount byte

gridVersion uint

changeStamp GridChangeStamp

Fields

ChangeStamp

The world-owned ordering and cause identity for this committed mutation.

public readonly GridChangeStamp ChangeStamp

Field Value

GridChangeStamp

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

CauseId

The logical cause shared with the corresponding grid notification.

public ulong CauseId { get; }

Property Value

ulong

ChangeSequence

The world-local commit order of this event.

public ulong ChangeSequence { get; }

Property Value

ulong

GridIndex

The grid index containing VoxelIndex.

public ushort GridIndex { get; }

Property Value

ushort