npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

flow-field-ts

v1.0.2

Published

Implements a flow field using typescript.

Downloads

5

Readme

Flow Field

Implements a flow field using typescript.

Installation

npm i flow-field-ts

Usage

1. Create an InitialGrid

This is the first structure to create that represents the entire grid area.

import { InitialGrid, vec } from 'flow-field-ts'
const grid = new InitialGrid(vec(10, 10));

2. Convert to CostGrid

The next step is to convert to a CostGrid by providing the destination vector, the initial cost value, and a tuple array of vectors that have different weights.

import { InitialGrid, vec } from 'flow-field-ts'

const grid = new InitialGrid(vec(10, 10));
const costGrid = grid.toCostGrid(vec(9, 9), 1, []); // destination would be GridCell at 9,9

3. Convert to IntegrationGrid

The final step to to convert to IntegrationGrid which will create the destination vector of each GridCell.

import { InitialGrid, vec } from 'flow-field-ts'

const grid = new InitialGrid(vec(10, 10));
const costGrid = grid.toCostGrid(vec(9, 9), 1, []);
const iGrid = costGrid.toIntegrationGrid();

The integration grid is what you will use to determine the flow of entities.

Example

// Using ExcaliburJs to demo game loop
import { Actor, CollisionType, Color, Engine, Vector, vec } from 'excalibur'
import { InitialGrid, vec as ffVec } from 'flow-field-ts'

/**
 *  Grid can represent any dimensions.  It's best not to represent 1 pixel.
 * In this case, 1x1 grid square represent 60 width and 80 height
 **/
const WIDTH = 800;
const HEIGHT = 600;

const xGridLength = 10;
const yGridLength = 10;

const xCellWidth = WIDTH / xGridLength;
const yCellHeight = HEIGHT / yGridLength;
const SPEED = 30;

const g = new InitialGrid(ffVec(10, 10));
const cg = g.toCostGrid(ffVec(9, 9), 1, []);
const ig = cg.toIntegrationGrid();

const game = new Engine({
    width: WIDTH,
    height: HEIGHT,
});

game.start().then(() => {
    // generating 1000 actors
    for (let i = 0; i < 1000; i++) {
        // Create random location for actor to spawn
        const randomX = Math.trunc(Math.random() * WIDTH);
        const randomY = Math.trunc(Math.random() * HEIGHT);

        const actor = new Actor({
            x: randomX,
            y: randomY,
            width: 2,
            height: 2,
            color: Color.Black,
            collisionType: CollisionType.Active
        });
        
        // Calculate velocity in update loop
        actor.on('postupdate', () => {
            // Here is where the actor position is converted to GridCell
            const xCellValue = Math.trunc(actor.pos.x / xCellWidth);
            const yCellValue = Math.trunc(actor.pos.y / yCellHeight);
            const gridCell = ig.getCell(ffVec(xCellValue, yCellValue));
            
            if (gridCell) {
                // Sets velocity to move actor
                // note: This is an excaliburjs Vector
                actor.vel = vec(
                    gridCell.direction.x * SPEED,
                    gridCell.direction.y * SPEED
                );
            }
            
            if (actor.vel.equals(Vector.Zero)) {
                // kill if reaches destination
                setTimeout(() => {
                    actor.kill();
                }, 300);
            }
        });
        game.add(actor);
    }
});

Demo.gif