Skip to main content
Version: 0.2.0

Interface IArchetypeRegistry

Namespace: ReadyM.Api.ECS.Worlds
Assembly: ReadyM.Api.dll

Allows registering and modifying entity archetypes in the ECS.

public interface IArchetypeRegistry

Methods

ModifyArchetype(ArchetypeId, Action<ArchetypeBuilder>)

Extends an existing entity archetype with additional components.

void ModifyArchetype(ArchetypeId archetypeId, Action<ArchetypeBuilder> callback)

Parameters

archetypeId ArchetypeId

The identifier of the archetype to modify.

callback Action<ArchetypeBuilder>

This callback will be invoked immediately to modify the existing registered archetype builder. It is NOT invoked on each call

RegisterArchetype(ArchetypeBuilder)

Registers a new entity archetype with the configured components.

ArchetypeId RegisterArchetype(ArchetypeBuilder builder)

Parameters

builder ArchetypeBuilder

The archetype builder with the configured components.

Returns

ArchetypeId

The identifier of the defined archetype.

  • Methods
    • ModifyArchetype(ArchetypeId, Action<ArchetypeBuilder>)
    • RegisterArchetype(ArchetypeBuilder)