@ash.ts/tools
TypeScript icon, indicating that this package has built-in type declarations

1.3.2 • Public • Published

@ash.ts/tools

This package contains various tools for use with Ash - an entity component system framework for game development.

Instalation

Using npm:

npm i @ash.ts/tools

Using yarn:

yarn add @ash.ts/tools

Usage

ListIteratingSystem

Utility class declared as abstract class with updateNode method marked as required. There are also 2 optional callback methods that can be declared in an inherited class:

  • protected nodeAdded?:(node:Node) => void;
  • protected nodeRemoved?:(node:Node) => void;

Example usage:

import { ListIteratingSystem } from '@ash.ts/ash';
import { MovementNode } from '../nodes';

export class MovementSystem extends ListIteratingSystem<MovementNode> {
  constructor() {
    super(MovementNode);
  }

  // required
  public updateNode(node:MovementNode, time:number):void {
    // update logic
  }
  
  // optional
  public nodeAdded = (node:MovementNode) => {
    // logic to execute when new node is added to the system
  };
  
  // optional
  public nodeRemoved = (node:MovementNode) => {
    // logic to execute when new node is removed from the system
  };
}

ComponentPool

TBD

Package Sidebar

Install

npm i @ash.ts/tools

Weekly Downloads

1

Version

1.3.2

License

MIT

Unpacked Size

16.8 kB

Total Files

8

Last publish

Collaborators

  • icek