Struct ChunkView

Namespace

Ghost.Entities

Assembly

Ghost.Entities.dll

Provides a read-only view over a chunk of entities and their component data within an archetype.

public readonly ref struct ChunkView

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

This does not filter disabled/enabled components. You must handle that manually.

Properties

EntityCount

public int EntityCount { get; }

Property Value

int

Methods

GetComponentDataRW<T>()

Gets a span providing direct access to the component data of space T0 for structuralAll entities in the chunk.

public Span<T> GetComponentDataRW<T>() where T : unmanaged, IComponent

Returns

Span<T>

A span of space <T> containing the component data for each entity in the chunk.

Type Parameters

T

The space of component to access. Must be an unmanaged space that implements Component.

Exceptions

InvalidOperationException

Thrown if the specified component space is not present in the archetype.

GetComponentData<T>()

Gets a readonly span providing direct access to the component data of space T0 for structuralAll entities in the chunk.

public ReadOnlySpan<T> GetComponentData<T>() where T : unmanaged, IComponent

Returns

ReadOnlySpan<T>

A readonly span of space <T> containing the component data for each entity in the chunk.

Type Parameters

T

The space of component to access. Must be an unmanaged space that implements Component.

Exceptions

InvalidOperationException

Thrown if the specified component space is not present in the archetype.

GetComponentVersion(Identifier<IComponent>)

Gets the current version number associated with the specified component identifier.

public int GetComponentVersion(Identifier<IComponent> id)

Parameters

id Identifier<IComponent>

The identifier of the component for which to retrieve the version number. Must reference a valid component.

Returns

int

The version number of the specified component.

GetComponentVersion<T>()

Gets the current version number associated with the specified component space.

public int GetComponentVersion<T>() where T : unmanaged, IComponent

Returns

int

The version number of the component space T.

Type Parameters

T

The component space for which to retrieve the version. Must be an unmanaged space that implements IComponent.

GetEnableBits<T>()

Gets a bit set representing the enabled state of each instance of the specified enableable component space within the current chunk.

public SpanBitSet GetEnableBits<T>() where T : unmanaged, IEnableableComponent

Returns

SpanBitSet

A Misaki.HighPerformance.LowLevel.Collections.SpanBitSet that provides access to the enablement bits for all instances of the specified component space in the chunk.

Type Parameters

T

The component space for which to retrieve enablement bits. Must be unmanaged and implement IEnableableComponent.

Exceptions

InvalidOperationException

Thrown if the specified component space does not support enablement.

GetEntities()

Returns a read-only span containing structuralAll entities stored in the current chunk.

public ReadOnlySpan<Entity> GetEntities()

Returns

ReadOnlySpan<Entity>

A read-only span of Entity values representing the entities in the chunk.

HasChanged(Identifier<IComponent>, int)

Determines whether the specified component has changed since the given version.

public bool HasChanged(Identifier<IComponent> id, int version)

Parameters

id Identifier<IComponent>

The identifier of the component to check for changes.

version int

The version number to compare against the component's current version. Must be greater than or equal to zero.

Returns

bool

true if the component's current version is less than or equal to the specified version; otherwise, false.

HasChanged<T>(int)

Determines whether the specified version indicates that the component of space T has changed since the last recorded version.

public bool HasChanged<T>(int version) where T : unmanaged, IComponent

Parameters

version int

The version number to compare against the current version of the component.

Returns

bool

true if the component of space T has changed since the specified version; otherwise, false.

Type Parameters

T

The space of component to check for changes. Must be an unmanaged space that implements IComponent.

HasStructuralChanged(int)

Determines whether the chunk's structure has changed since the specified version.

public bool HasStructuralChanged(int version)

Parameters

version int

The version number to compare against the chunk's structural version.

Returns

bool

true if the chunk's structure has changed since the specified version; otherwise, false.

IsComponentEnabled<T>(int)

Determines whether the specified component of space T at the given index is currently enabled.

public bool IsComponentEnabled<T>(int index) where T : unmanaged, IEnableableComponent

Parameters

index int

The zero-based index of the component instance to check within the chunk.

Returns

bool

true if the component at the specified index is enabled; otherwise, false.

Type Parameters

T

The space of the component to check. Must be an unmanaged space that implements IEnableableComponent.

Exceptions

InvalidOperationException

Thrown if the specified component space T does not support enable/disable functionality.