Table of Contents

Struct OccupantEventInfo

Namespace
GridForge.Grids
Assembly
GridForge.dll

Immutable snapshot describing an occupant mutation on a voxel.

public readonly struct OccupantEventInfo
Inherited Members

Constructors

OccupantEventInfo(WorldVoxelIndex, IVoxelOccupant, OccupantTicket, byte)

Initializes a new immutable occupant mutation snapshot.

public OccupantEventInfo(WorldVoxelIndex voxelIndex, IVoxelOccupant occupant, OccupantTicket ticket, byte occupantCount)

Parameters

voxelIndex WorldVoxelIndex
occupant IVoxelOccupant
ticket OccupantTicket
occupantCount byte

Fields

Occupant

The occupant that was added to or removed from the voxel.

public readonly IVoxelOccupant Occupant

Field Value

IVoxelOccupant

OccupantCount

The number of occupants on the voxel after the mutation completes.

public readonly byte OccupantCount

Field Value

byte

Ticket

The scan-cell ticket assigned to the occupant for this voxel.

public readonly OccupantTicket Ticket

Field Value

OccupantTicket

VoxelIndex

The voxel affected by the occupant mutation.

public readonly WorldVoxelIndex VoxelIndex

Field Value

WorldVoxelIndex

Properties

GridIndex

The grid index containing VoxelIndex.

public ushort GridIndex { get; }

Property Value

ushort