Struct ObstacleEventInfo

Namespace

GridForge.Grids

Assembly

GridForge.dll

Immutable snapshot describing a single obstacle mutation on a voxel.

public readonly struct ObstacleEventInfo

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ObstacleEventInfo(WorldVoxelIndex, ObstacleToken, byte, uint, GridChangeStamp)

Initializes a new immutable obstacle mutation snapshot.

public ObstacleEventInfo(WorldVoxelIndex voxelIndex, ObstacleToken obstacleToken, byte obstacleCount, uint gridVersion, GridChangeStamp changeStamp = default)

Parameters

voxelIndex WorldVoxelIndex

obstacleToken ObstacleToken

obstacleCount 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

GridVersion

The grid version recorded after the mutation completes.

public readonly uint GridVersion

Field Value

uint

ObstacleCount

The number of active obstacles on the voxel after the mutation completes.

public readonly byte ObstacleCount

Field Value

byte

ObstacleToken

The token identifying the obstacle that was added or removed.

public readonly ObstacleToken ObstacleToken

Field Value

ObstacleToken

VoxelIndex

The voxel affected by the obstacle mutation.

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