Skip to main content
Version: 1.0.0

Interface IEntities

Namespace: ReadyM.SDK.Client.Entities
Assembly: ReadyM.SDK.Client.dll

The entities this client can see: query, look up, create and delete them.

public interface IEntities : IEntitiesBase

Implements​

IEntitiesBase

Methods​

Delete<T>(in T)​

Removes the entity a shape names: an archetype, a mixin, or, where the runtime has them, the chunk view of either. False when it was already gone.

bool Delete<T>(in T shape) where T : IEntityShape, allows ref struct

Parameters​

shape T

Returns​

bool

Type Parameters​

T

Remarks​

Inside a query the removal is held until the loop ends. The anti-constraint is the only part that differs by target, and a netstandard2.0 build has no chunk views to pass anyway.

Query<T>()​

Every entity of a shape. Walked by chunk when the shape and the runtime allow it, by identity otherwise, which is decided when the loop is compiled rather than when it runs.

EntityQuery<T> Query<T>() where T : struct, IArchetypeQueryable

Returns​

EntityQuery<T>

Type Parameters​

T

Query<T1, T2>()​

Every entity carrying all 2 shapes, walked the same way a single one is.

EntityQuery<T1, T2> Query<T1, T2>() where T1 : struct, IArchetypeQueryable where T2 : struct, IArchetypeMixin

Returns​

EntityQuery<T1, T2>

Type Parameters​

T1

T2

Query<T1, T2, T3>()​

Every entity carrying all 3 shapes, walked the same way a single one is.

EntityQuery<T1, T2, T3> Query<T1, T2, T3>() where T1 : struct, IArchetypeQueryable where T2 : struct, IArchetypeMixin where T3 : struct, IArchetypeMixin

Returns​

EntityQuery<T1, T2, T3>

Type Parameters​

T1

T2

T3

Query<T1, T2, T3, T4>()​

Every entity carrying all 4 shapes, walked the same way a single one is.

EntityQuery<T1, T2, T3, T4> Query<T1, T2, T3, T4>() where T1 : struct, IArchetypeQueryable where T2 : struct, IArchetypeMixin where T3 : struct, IArchetypeMixin where T4 : struct, IArchetypeMixin

Returns​

EntityQuery<T1, T2, T3, T4>

Type Parameters​

T1

T2

T3

T4

Query<T1, T2, T3, T4, T5>()​

Every entity carrying all 5 shapes, walked the same way a single one is.

EntityQuery<T1, T2, T3, T4, T5> Query<T1, T2, T3, T4, T5>() where T1 : struct, IArchetypeQueryable where T2 : struct, IArchetypeMixin where T3 : struct, IArchetypeMixin where T4 : struct, IArchetypeMixin where T5 : struct, IArchetypeMixin

Returns​

EntityQuery<T1, T2, T3, T4, T5>

Type Parameters​

T1

T2

T3

T4

T5

Query<T1, T2, T3, T4, T5, T6>()​

Every entity carrying all 6 shapes, walked the same way a single one is.

EntityQuery<T1, T2, T3, T4, T5, T6> Query<T1, T2, T3, T4, T5, T6>() where T1 : struct, IArchetypeQueryable where T2 : struct, IArchetypeMixin where T3 : struct, IArchetypeMixin where T4 : struct, IArchetypeMixin where T5 : struct, IArchetypeMixin where T6 : struct, IArchetypeMixin

Returns​

EntityQuery<T1, T2, T3, T4, T5, T6>

Type Parameters​

T1

T2

T3

T4

T5

T6

  • Methods
    • Delete<T>(in T)
    • Query<T>()
    • Query<T1, T2>()
    • Query<T1, T2, T3>()
    • Query<T1, T2, T3, T4>()
    • Query<T1, T2, T3, T4, T5>()
    • Query<T1, T2, T3, T4, T5, T6>()