threejs-worldgen
    Preparing search index...

    Interface BoidParams

    Steering weights and limits of a flock. All plain numbers (JSON).

    interface BoidParams {
        alignment: number;
        avoid: number;
        cohesion: number;
        flee: number;
        homeRadius: number;
        homeStrength: number;
        lookAhead: number;
        margin: number;
        maxAccel: number;
        maxSpeed: number;
        minDistance: number;
        minSpeed: number;
        neighborRadius: number;
        separation: number;
        separationDistance: number;
        verticalDamping: number;
        wander: number;
        wanderRate: number;
    }
    Index
    alignment: number

    Weight of matching the neighbours' velocity.

    avoid: number

    Strength of the push away from the floor, the top and obstacles.

    cohesion: number

    Weight of steering towards the neighbours' centre.

    flee: number

    Strength of fleeing from predators.

    homeRadius: number

    Members past this distance (metres, horizontal) from home are pulled back.

    homeStrength: number

    Strength of the pull back home.

    lookAhead: number

    Seconds of travel probed ahead for obstacles (dry land, shallows, cliffs).

    margin: number

    Distance (metres) members keep from the floor and the top of their band.

    maxAccel: number

    Largest acceleration, m/s².

    maxSpeed: number

    Fastest speed, m/s.

    minDistance: number

    Hard minimum distance between two members (metres), enforced after every step. 0 = off.

    minSpeed: number

    Slowest speed, m/s.

    neighborRadius: number

    Neighbours closer than this (metres) count for alignment and cohesion.

    separation: number

    Weight of steering away from close neighbours.

    separationDistance: number

    Neighbours closer than this (metres) push each other apart.

    verticalDamping: number

    0…1: how strongly vertical motion is damped (fish and birds mostly move level).

    wander: number

    Weight of the random-walk wander force.

    wanderRate: number

    How fast the wander heading drifts, radians per second.