Skip to main content
Version: 0.3.1

Class EcsApi

Namespace: ReadyM.Relay.Server.Sdk.Ecs
Assembly: ReadyM.Relay.Server.Sdk.dll

Mod-side ECS API. Wraps the function pointers exposed by the AOT server. All component types - whether defined in the server binary or in this mod - are identified by int component IDs assigned at registration time.

public class EcsApi

Inheritance​

object ← EcsApi

Inherited Members​

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Methods​

CreateEntity(ArchetypeId)​

public Entity CreateEntity(ArchetypeId archetypeId)

Parameters​

archetypeId ArchetypeId

Returns​

Entity

Query<T>(EmbedForEach<T>)​

public void Query<T>(EcsApi.EmbedForEach<T> callback) where T : struct

Parameters​

callback EcsApi.EmbedForEach<T>

Type Parameters​

T

Query<T, TState>(TState, EmbedForEachStateManaged<T, TState>)​

public void Query<T, TState>(TState state, EcsApi.EmbedForEachStateManaged<T, TState> callback) where T : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T, TState>

Type Parameters​

T

TState

Query<T, TState>(ref TState, EmbedForEachState<T, TState>)​

public void Query<T, TState>(ref TState state, EcsApi.EmbedForEachState<T, TState> callback) where T : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T, TState>

Type Parameters​

T

TState

Query<T1, T2>(EmbedForEach<T1, T2>)​

public void Query<T1, T2>(EcsApi.EmbedForEach<T1, T2> callback) where T1 : struct where T2 : struct

Parameters​

callback EcsApi.EmbedForEach<T1, T2>

Type Parameters​

T1

T2

Query<T1, T2, TState>(TState, EmbedForEachStateManaged<T1, T2, TState>)​

public void Query<T1, T2, TState>(TState state, EcsApi.EmbedForEachStateManaged<T1, T2, TState> callback) where T1 : struct where T2 : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T1, T2, TState>

Type Parameters​

T1

T2

TState

Query<T1, T2, TState>(ref TState, EmbedForEachState<T1, T2, TState>)​

public void Query<T1, T2, TState>(ref TState state, EcsApi.EmbedForEachState<T1, T2, TState> callback) where T1 : struct where T2 : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T1, T2, TState>

Type Parameters​

T1

T2

TState

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

public void Query<T1, T2, T3>(EcsApi.EmbedForEach<T1, T2, T3> callback) where T1 : struct where T2 : struct where T3 : struct

Parameters​

callback EcsApi.EmbedForEach<T1, T2, T3>

Type Parameters​

T1

T2

T3

Query<T1, T2, T3, TState>(TState, EmbedForEachStateManaged<T1, T2, T3, TState>)​

public void Query<T1, T2, T3, TState>(TState state, EcsApi.EmbedForEachStateManaged<T1, T2, T3, TState> callback) where T1 : struct where T2 : struct where T3 : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T1, T2, T3, TState>

Type Parameters​

T1

T2

T3

TState

Query<T1, T2, T3, TState>(ref TState, EmbedForEachState<T1, T2, T3, TState>)​

public void Query<T1, T2, T3, TState>(ref TState state, EcsApi.EmbedForEachState<T1, T2, T3, TState> callback) where T1 : struct where T2 : struct where T3 : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T1, T2, T3, TState>

Type Parameters​

T1

T2

T3

TState

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

public void Query<T1, T2, T3, T4>(EcsApi.EmbedForEach<T1, T2, T3, T4> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct

Parameters​

callback EcsApi.EmbedForEach<T1, T2, T3, T4>

Type Parameters​

T1

T2

T3

T4

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

public void Query<T1, T2, T3, T4, TState>(TState state, EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, TState>

Type Parameters​

T1

T2

T3

T4

TState

Query<T1, T2, T3, T4, TState>(ref TState, EmbedForEachState<T1, T2, T3, T4, TState>)​

public void Query<T1, T2, T3, T4, TState>(ref TState state, EcsApi.EmbedForEachState<T1, T2, T3, T4, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T1, T2, T3, T4, TState>

Type Parameters​

T1

T2

T3

T4

TState

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

public void Query<T1, T2, T3, T4, T5>(EcsApi.EmbedForEach<T1, T2, T3, T4, T5> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct

Parameters​

callback EcsApi.EmbedForEach<T1, T2, T3, T4, T5>

Type Parameters​

T1

T2

T3

T4

T5

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

public void Query<T1, T2, T3, T4, T5, TState>(TState state, EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, T5, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, T5, TState>

Type Parameters​

T1

T2

T3

T4

T5

TState

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

public void Query<T1, T2, T3, T4, T5, TState>(ref TState state, EcsApi.EmbedForEachState<T1, T2, T3, T4, T5, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T1, T2, T3, T4, T5, TState>

Type Parameters​

T1

T2

T3

T4

T5

TState

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

public void Query<T1, T2, T3, T4, T5, T6>(EcsApi.EmbedForEach<T1, T2, T3, T4, T5, T6> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct where T6 : struct

Parameters​

callback EcsApi.EmbedForEach<T1, T2, T3, T4, T5, T6>

Type Parameters​

T1

T2

T3

T4

T5

T6

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

public void Query<T1, T2, T3, T4, T5, T6, TState>(TState state, EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, T5, T6, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct where T6 : struct where TState : class

Parameters​

state TState

callback EcsApi.EmbedForEachStateManaged<T1, T2, T3, T4, T5, T6, TState>

Type Parameters​

T1

T2

T3

T4

T5

T6

TState

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

public void Query<T1, T2, T3, T4, T5, T6, TState>(ref TState state, EcsApi.EmbedForEachState<T1, T2, T3, T4, T5, T6, TState> callback) where T1 : struct where T2 : struct where T3 : struct where T4 : struct where T5 : struct where T6 : struct where TState : unmanaged

Parameters​

state TState

callback EcsApi.EmbedForEachState<T1, T2, T3, T4, T5, T6, TState>

Type Parameters​

T1

T2

T3

T4

T5

T6

TState

  • Methods
    • CreateEntity(ArchetypeId)
    • Query<T>(EmbedForEach<T>)
    • Query<T, TState>(TState, EmbedForEachStateManaged<T, TState>)
    • Query<T, TState>(ref TState, EmbedForEachState<T, TState>)
    • Query<T1, T2>(EmbedForEach<T1, T2>)
    • Query<T1, T2, TState>(TState, EmbedForEachStateManaged<T1, T2, TState>)
    • Query<T1, T2, TState>(ref TState, EmbedForEachState<T1, T2, TState>)
    • Query<T1, T2, T3>(EmbedForEach<T1, T2, T3>)
    • Query<T1, T2, T3, TState>(TState, EmbedForEachStateManaged<T1, T2, T3, TState>)
    • Query<T1, T2, T3, TState>(ref TState, EmbedForEachState<T1, T2, T3, TState>)
    • Query<T1, T2, T3, T4>(EmbedForEach<T1, T2, T3, T4>)
    • Query<T1, T2, T3, T4, TState>(TState, EmbedForEachStateManaged<T1, T2, T3, T4, TState>)
    • Query<T1, T2, T3, T4, TState>(ref TState, EmbedForEachState<T1, T2, T3, T4, TState>)
    • Query<T1, T2, T3, T4, T5>(EmbedForEach<T1, T2, T3, T4, T5>)
    • Query<T1, T2, T3, T4, T5, TState>(TState, EmbedForEachStateManaged<T1, T2, T3, T4, T5, TState>)
    • Query<T1, T2, T3, T4, T5, TState>(ref TState, EmbedForEachState<T1, T2, T3, T4, T5, TState>)
    • Query<T1, T2, T3, T4, T5, T6>(EmbedForEach<T1, T2, T3, T4, T5, T6>)
    • Query<T1, T2, T3, T4, T5, T6, TState>(TState, EmbedForEachStateManaged<T1, T2, T3, T4, T5, T6, TState>)
    • Query<T1, T2, T3, T4, T5, T6, TState>(ref TState, EmbedForEachState<T1, T2, T3, T4, T5, T6, TState>)