geary-core/com.mineinabyss.geary.engine.archetypes/Archetype

Archetype

data class Archetype(val type: EntityType, val id: Int)

Archetypes store a list of entities with the same EntityType, and provide functions to quickly move them between archetypes.

An example use case: If a query matches an archetype, it will also match all entities inside which gives a large performance boost to system iteration.

Constructors

Archetype

constructor(type: EntityType, id: Int)

Functions

addEventHandler

fun addEventHandler(handler: Handler)

Adds an event handler that listens to certain events relating to entities in this archetype.

addSourceListener

fun addSourceListener(handler: Listener)

addTargetListener

fun addTargetListener(handler: Listener)

contains

operator fun contains(componentId: ComponentId): Boolean

get

operator fun get(row: Int, componentId: ComponentId): Component?

getEntity

fun getEntity(row: Int): Entity

minus

operator fun minus(componentId: ComponentId): Archetype

Returns the archetype associated with removing componentId to this archetype's type.

plus

operator fun plus(componentId: ComponentId): Archetype

Returns the archetype associated with adding componentId to this archetype's type.

removeEntity

fun removeEntity(row: Int)

Removes the entity at a row in this archetype, notifying running archetype iterators.

Properties

entities

val entities: List<Entity>

eventHandlers

val eventHandlers: Set<Handler>

A map of event class type to a set of event handlers which fire on that event.

val id: Int

size

val size: Int

The amount of entities stored in this archetype.

sourceListeners

val sourceListeners: Set<Listener>

targetListeners

val targetListeners: Set<Listener>

type

val type: EntityType