Skip to main content
Version: 0.2.0

Struct Entity

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

Represents an entity in the ECS.

public readonly struct Entity

Inherited Members​

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

Properties​

Id​

The identifier of the entity.

public int Id { get; }

Property Value​

int

Methods​

GetComponent<T>()​

Gets a reference to the component of type T associated with this entity.

public ref T GetComponent<T>() where T : struct

Returns​

T

A mutable reference to the component.

Type Parameters​

T

Type of the component

Remarks​

Attempting to access a component that does not exist on the entity's archetype will crash your mod.