Skip to content

API.md

Latest commit

 

History

History
1810 lines (1073 loc) · 38.4 KB

API.md

File metadata and controls

1810 lines (1073 loc) · 38.4 KB

Table of Contents

ComponentRef

Represents a reference to a component.

Type: any

ComponentData

Represents the data associated with a component.

Properties

  • id number The unique identifier for the component.
  • generationId number The generation ID of the component.
  • bitflag number The bitflag used for component masking.
  • ref ComponentRef Reference to the component.
  • queries Set<Query> Set of queries associated with the component.
  • setObservable Observable Observable for component changes.

registerComponent

Registers a component with the world.

Parameters

  • world World The world object.
  • component ComponentRef The component to register.
  • Throws Error If the component is null or undefined.

Returns ComponentData The registered component data.

registerComponents

Registers multiple components with the world.

Parameters

  • world World The world object.
  • components Array<ComponentRef> Array of components to register.

hasComponent

Checks if an entity has a specific component.

Parameters

  • world World The world object.
  • eid number The entity ID.
  • component ComponentRef The component to check for.

Returns boolean True if the entity has the component, false otherwise.

getComponent

Retrieves the data associated with a component for a specific entity.

Parameters

  • world World The world object.
  • eid EntityId The entity ID.
  • component ComponentRef The component to retrieve data for.

Returns any The component data, or undefined if the component is not found or the entity doesn't have the component.

set

Helper function to set component data.

Parameters

  • component ComponentRef The component to set.
  • data any The data to set for the component.

Returns {component: ComponentRef, data: any} An object containing the component and its data.

recursivelyInherit

Recursvely inherits components from one entity to another.

Parameters

  • ctx WorldContext
  • world World The world object.
  • baseEid number The ID of the entity inheriting components.
  • inheritedEid number The ID of the entity being inherited from.
  • visited (optional, default new Set<EntityId>())
  • isFirstSuper boolean Whether this is the first super in the inheritance chain.

Returns void

ComponentSetter

Represents a component with data to be set on an entity.

Type: {component: ComponentRef, data: T}

Properties

setComponent

Sets component data on an entity. Always calls the setter observable even if entity already has the component.

Parameters

  • world World The world object.
  • eid EntityId The entity ID.
  • component ComponentRef The component to set.
  • data any The data to set for the component.
  • Throws Error If the entity does not exist in the world.

Returns void

addComponent

Adds a single component to an entity.

Parameters

  • Throws Error If the entity does not exist in the world.

Returns boolean True if component was added, false if it already existed.

addComponents

Adds multiple components to an entity.

Parameters

  • Throws Error If the entity does not exist in the world.

Returns void

removeComponent

Removes one or more components from an entity.

Parameters

  • world World The world object.
  • eid number The entity ID.
  • components ...ComponentRef Components to remove.
  • Throws Error If the entity does not exist in the world.

removeComponents

Removes one or more components from an entity. This is an alias for removeComponent.

Parameters

  • world World The world object.
  • eid EntityId The entity ID.
  • components ...ComponentRef Components to remove.
  • Throws Error If the entity does not exist in the world.

addPrefab

Creates a new prefab entity in the world. Prefabs are special entities marked with the Prefab component that are excluded from normal queries and can be used as templates for creating other entities.

Parameters

  • world World The world object to create the prefab in.

Returns EntityId The entity ID of the created prefab.

addEntity

Adds a new entity to the specified world.

Parameters

  • world World

Returns number eid

removeEntity

Removes an existing entity from the specified world.

Parameters

getEntityComponents

Returns an array of components that an entity possesses.

Parameters

  • world any
  • eid any

Returns Array<ComponentRef>

entityExists

Checks the existence of an entity in a world

Parameters

EntityIndex

Represents the structure for managing entity IDs.

Type: {aliveCount: number, dense: Array<number>, sparse: Array<number>, maxId: number, versioning: boolean, versionBits: number, entityMask: number, versionShift: number, versionMask: number}

Properties

aliveCount

The number of currently alive entities.

Type: number

dense

Array of entity IDs, densely packed.

Type: Array<number>

sparse

Sparse array mapping entity IDs to their index in the dense array.

Type: Array<number>

maxId

The highest entity ID that has been assigned.

Type: number

versioning

Flag indicating if versioning is enabled.

Type: boolean

versionBits

Number of bits used for versioning.

Type: number

entityMask

Bit mask for entity ID.

Type: number

versionShift

Bit shift for version.

Type: number

versionMask

Bit mask for version.

Type: number

getId

Extracts the entity ID from a versioned entity ID by stripping off the version.

Parameters

  • index EntityIndex The EntityIndex containing the masks.
  • id number The versioned entity ID.

Returns number The entity ID without the version.

getVersion

Extracts the version from an entity ID.

Parameters

  • index EntityIndex The EntityIndex containing the masks and shifts.
  • id number The entity ID.

Returns number The version.

incrementVersion

Increments the version of an entity ID.

Parameters

  • index EntityIndex The EntityIndex containing the masks and shifts.
  • id number The entity ID.

Returns number The new entity ID with incremented version.

withVersioning

Creates configuration options for entity ID recycling with versioning.

Parameters

  • versionBits number? Optional number of bits to use for version numbers. Defaults to 8 if not specified.

Returns object Configuration object with versioning enabled and specified version bits.

createEntityIndex

Creates and initializes a new EntityIndex.

Parameters

  • options (object | function)? Optional configuration object from withVersioning() or withVersioning function.

    • options.versioning boolean Flag to enable versioning for recycled IDs.
    • options.versionBits number Number of bits to use for versioning (default: 8).

Returns EntityIndex A new EntityIndex object.

addEntityId

Adds a new entity ID to the index or recycles an existing one.

Parameters

Returns number The new or recycled entity ID.

removeEntityId

Removes an entity ID from the index.

Parameters

  • index EntityIndex The EntityIndex to remove from.
  • id number The entity ID to remove.

Returns void

isEntityIdAlive

Checks if an entity ID is currently alive in the index.

Parameters

Returns boolean True if the entity ID is alive, false otherwise.

growDepthsArray

Grows the depths array to accommodate a specific entity

Parameters

  • hierarchyData HierarchyData
  • entity EntityId

Returns Uint32Array

updateDepthCache

Updates the depthToEntities cache when an entity's depth changes

Parameters

  • hierarchyData HierarchyData
  • entity EntityId
  • newDepth number
  • oldDepth number?

Returns void

updateMaxDepth

Updates max depth if the new depth is greater

Parameters

  • hierarchyData HierarchyData
  • depth number

Returns void

setEntityDepth

Sets entity depth and updates all related caches

Parameters

  • hierarchyData HierarchyData
  • entity EntityId
  • newDepth number
  • oldDepth number?

Returns void

invalidateQueryCache

Invalidates hierarchy query cache for a relation

Parameters

Returns void

getHierarchyData

Gets hierarchy data for a relation, activating tracking if needed

Parameters

Returns HierarchyData

populateExistingDepths

Populates depth calculations for all existing entities with this relation

Parameters

Returns void

ensureDepthTracking

Ensures depth tracking is initialized for a relation. This must be called before using hierarchy features for a specific relation component.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component to initialize tracking for.

Returns void

calculateEntityDepth

Calculates the hierarchy depth of an entity for a given relation. Depth is measured as the distance from the root entities (entities with no parent relations).

Parameters

  • world World The world object.
  • relation ComponentRef The relation component to calculate depth for.
  • entity EntityId The entity ID to calculate depth for.
  • visited Set<EntityId>? Internal set to track visited entities for cycle detection. (optional, default new Set<EntityId>())

Returns number The hierarchy depth of the entity.

getEntityDepthWithVisited

Internal helper to get entity depth with cycle detection

Parameters

Returns number

getEntityDepth

Gets the cached depth of an entity, calculating if needed

Parameters

Returns number

markChildrenDirty

Marks an entity and its children as needing depth recalculation. This is used internally when hierarchy changes occur.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component.
  • parent EntityId The parent entity ID.
  • dirty SparseSet The set to mark dirty entities in.
  • visited SparseSet? Internal set to track visited entities for cycle detection. (optional, default createSparseSet())

Returns void

updateHierarchyDepth

Updates hierarchy depth when a relation is added. This function is called automatically when components are added to maintain accurate depth tracking.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component.
  • entity EntityId The entity ID that had a relation added.
  • parent EntityId? The parent entity ID in the relation.
  • updating Set<EntityId>? Internal set to track entities being updated. (optional, default new Set<EntityId>())

Returns void

invalidateHierarchyDepth

Invalidates hierarchy depth when a relation is removed. This function is called automatically when components are removed to maintain accurate depth tracking.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component.
  • entity EntityId The entity ID that had a relation removed.

Returns void

invalidateSubtree

Recursively invalidates an entire subtree

Parameters

Returns void

flushDirtyDepths

Processes all dirty depth calculations for a relation. This ensures all cached depth values are up to date before performing hierarchy operations.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component to flush dirty depths for.

Returns void

queryHierarchy

Query entities in hierarchical order (depth-based ordering). Returns entities grouped by depth: all depth 0, then depth 1, then depth 2, etc. This ensures parents always come before their children.

Parameters

  • world World The world object.

  • relation ComponentRef The relation component that defines the hierarchy.

  • components Array<ComponentRef> Additional components to filter by.

  • options Object? Query options. (optional, default {})

    • options.buffered boolean? Whether to return results as Uint32Array instead of number[].

Returns QueryResult Array or Uint32Array of entity IDs in hierarchical order.

queryHierarchyDepth

Get all entities at a specific depth level in the hierarchy.

Parameters

  • world World The world object.

  • relation ComponentRef The relation component that defines the hierarchy.

  • depth number The specific depth level to query (0 = root level).

  • options Object? Query options. (optional, default {})

    • options.buffered boolean? Whether to return results as Uint32Array instead of number[].

Returns QueryResult Array or Uint32Array of entity IDs at the specified depth.

getHierarchyDepth

Get the hierarchy depth of a specific entity for a given relation.

Parameters

  • world World The world object.
  • entity EntityId The entity ID to get depth for.
  • relation ComponentRef The relation component that defines the hierarchy.

Returns number The depth of the entity (0 = root level, higher numbers = deeper).

getMaxHierarchyDepth

Get the maximum depth in the hierarchy for a given relation.

Parameters

  • world World The world object.
  • relation ComponentRef The relation component that defines the hierarchy.

Returns number The maximum depth found in the hierarchy.

QueryResult

The result of a query, either as a Uint32Array or a readonly array of numbers.

Type: (Uint32Array | any)

QueryOptions

Options for configuring query behavior.

Type: Object

Properties

  • commit boolean? Whether to commit pending entity removals before querying.
  • buffered boolean? Whether to return results as Uint32Array instead of number[].

Query

Represents a query in the ECS using original blazing-fast bitmask evaluation.

Type: Object

Properties

  • allComponents Array<ComponentRef> All components referenced in the query.
  • orComponents Array<ComponentRef> Components in an OR relationship.
  • notComponents Array<ComponentRef> Components that should not be present.
  • masks Record<number, number> Bitmasks for each component generation.
  • orMasks Record<number, number> OR bitmasks for each component generation.
  • notMasks Record<number, number> NOT bitmasks for each component generation.
  • hasMasks Record<number, number> HAS bitmasks for each component generation.
  • generations Array<number> Component generations.
  • toRemove SparseSet Set of entities to be removed.

QueryOperatorType

Types of query operators.

Type: ("Or" | "And" | "Not")

$opType

Symbol for query operator type.

Type: Symbol

$opTerms

Symbol for query operator terms.

Type: Symbol

OpReturnType

Type: Object

Properties

  • $opType symbol? The type of the operator.
  • $opTerms symbol? The components involved in the operation.

QueryOperator

A function that creates a query operator.

Type: Function

Parameters

  • components ...ComponentRef The components to apply the operator to.

Returns OpReturnType The result of the operator.

QueryTerm

A term in a query, either a component reference, query operator, or hierarchy term.

Type: (ComponentRef | QueryOperator | HierarchyTerm)

HierarchyTerm

Represents a hierarchy query term for topological ordering.

Type: Object

Properties

  • $hierarchyType symbol? Always 'Hierarchy'.
  • $hierarchyRel ComponentRef? The relation component for hierarchy.
  • $hierarchyDepth number? Optional depth limit.

Hierarchy

Creates a hierarchy query term for topological ordering (parents before children).

Parameters

  • relation ComponentRef The relation component (e.g., ChildOf).
  • depth number? Optional depth limit.

Returns HierarchyTerm The hierarchy term.

Cascade

Alias for Hierarchy - creates a hierarchy query term for topological ordering.

Parameters

  • relation ComponentRef The relation component (e.g., ChildOf).
  • depth number? Optional depth limit.

Returns HierarchyTerm The hierarchy term.

QueryModifier

Represents a query modifier that can be mixed into query terms.

Type: Object

Properties

  • $modifierType symbol? The type of modifier ('buffer' | 'nested').

ObservableHook

A function that creates an observable hook for queries.

Type: Function

Parameters

  • terms ...QueryTerm The query terms to observe.

observe

Observes changes in entities based on specified components.

Parameters

  • world World The world object.
  • hook ObservableHook The observable hook.
  • callback function (number): any The callback function to execute when changes occur.

Returns function (): void A function to unsubscribe from the observation.

queryHash

Generates a hash for a query based on its terms.

Parameters

  • world World The world object.
  • terms Array<QueryTerm> The query terms.

Returns string The generated hash.

registerQuery

Registers a new query in the world using unified clause-mask compilation.

Parameters

  • world World The world object.

  • terms Array<QueryTerm> The query terms.

  • options Object? Additional options.

    • options.buffered boolean? Whether the query should be buffered.

Returns Query The registered query.

queryInternal

Internal implementation for nested queries.

Parameters

  • world World The world object.

  • terms Array<QueryTerm> The query terms.

  • options Object? Additional options.

    • options.buffered boolean? Whether the query should be buffered.

Returns QueryResult The result of the query.

query

Performs a unified query operation with configurable options.

Parameters

  • world World The world object.
  • terms Array<QueryTerm> The query terms.
  • modifiers ...QueryModifier Query modifiers (asBuffer, isNested, etc.).

Returns QueryResult The result of the query.

queryCheckEntity

Original blazing-fast query evaluation using simple bitmasks.

Parameters

  • world World The world object.
  • query Query The query to check against.
  • eid number The entity ID to check.

Returns boolean True if the entity matches the query, false otherwise.

queryCheckComponent

Checks if a component matches a query.

Parameters

Returns boolean True if the component matches the query, false otherwise.

queryAddEntity

Adds an entity to a query.

Parameters

  • query Query The query to add the entity to.
  • eid number The entity ID to add.

queryCommitRemovals

Commits removals for a query.

Parameters

  • query Query The query to commit removals for.

commitRemovals

Commits all pending removals for queries in the world.

Parameters

  • world World The world object.

queryRemoveEntity

Removes an entity from a query.

Parameters

  • world World The world object.
  • query Query The query to remove the entity from.
  • eid number The entity ID to remove.

removeQuery

Removes a query from the world.

Parameters

  • world World The world object.
  • terms Array<QueryTerm> The query terms of the query to remove.

OnTargetRemovedCallback

Callback function type for when a target is removed from a relation.

Type: Function

Parameters

  • subject number The subject entity ID.
  • target number The target entity ID.

RelationTarget

Possible types for a relation target.

Type: (number | "*" | any)

$relation

Symbol for accessing the relation of a component.

Type: Symbol

$pairTarget

Symbol for accessing the pair target of a component.

Type: Symbol

$isPairComponent

Symbol for checking if a component is a pair component.

Type: Symbol

$relationData

Symbol for accessing the relation data of a component.

Type: Symbol

RelationData

Interface for relation data.

Relation

Type definition for a Relation function.

Type: function

Parameters

Returns T The relation component.

createBaseRelation

Creates a base relation.

Returns Relation<T> The created base relation.

withStore

Adds a store to a relation.

Parameters

  • createStore function (): T Function to create the store.

Returns function (Relation<T>): Relation<T> A function that modifies the relation.

makeExclusive

Makes a relation exclusive.

Parameters

  • relation Relation<T> The relation to make exclusive.

Returns Relation<T> The modified relation.

withAutoRemoveSubject

Adds auto-remove subject behavior to a relation.

Parameters

  • relation Relation<T> The relation to modify.

Returns Relation<T> The modified relation.

withOnTargetRemoved

Adds an onTargetRemoved callback to a relation.

Parameters

Returns function (Relation<T>): Relation<T> A function that modifies the relation.

withValidation

Adds validation to a relation.

Parameters

  • validateFn function (T): boolean The validation function.

Returns function (Relation<T>): Relation<T> A function that modifies the relation.

Pair

Creates a pair from a relation and a target.

Parameters

  • Throws Error If the relation is undefined.

Returns T The created pair.

getRelationTargets

Gets the relation targets for an entity.

Parameters

  • world World The world object.
  • eid number The entity ID.
  • relation Relation<any> The relation to get targets for.

Returns Array<any> An array of relation targets.

createRelation

Creates a new relation.

Parameters

Returns Relation<T> The created relation.

createRelation

Creates a new relation with options.

Parameters

  • options Object Options for creating the relation.

    • options.store function (): T? Function to create the store.
    • options.exclusive boolean? Whether the relation is exclusive.
    • options.autoRemoveSubject boolean? Whether to auto-remove the subject.
    • options.onTargetRemoved OnTargetRemovedCallback? Callback for when a target is removed.

Returns Relation<T> The created relation.

$wildcard

Symbol used to mark a relation as a wildcard relation

createWildcardRelation

Creates a wildcard relation that matches any target.

Returns Relation<T> The created wildcard relation.

getWildcard

Gets the singleton wildcard instance.

Returns Relation<any> The global wildcard relation instance.

Wildcard

Wildcard relation.

Type: Relation<any>

createIsARelation

Creates an IsA relation.

Returns Relation<T> The created IsA relation.

getIsA

Gets the singleton IsA instance.

Returns Relation<any> The global IsA relation instance.

IsA

IsA relation.

Type: Relation<any>

isWildcard

Checks if a relation is a wildcard relation.

Parameters

  • relation any The relation to check.

Returns boolean True if the relation is a wildcard relation, false otherwise.

isRelation

Checks if a component is a relation.

Parameters

  • component any The component to check.

Returns boolean True if the component is a relation, false otherwise.

createWorld

Creates a new world with various configurations.

Parameters

Returns World<T> The created world.

resetWorld

Resets a world.

Parameters

  • world World

Returns object

deleteWorld

Deletes a world by removing its internal data.

Parameters

  • world World The world to be deleted.

getWorldComponents

Returns all components registered to a world

Parameters

  • world World

Returns any Array

getAllEntities

Returns all existing entities in a world

Parameters

  • world World

Returns any Array