Small World Engine API Reference - v0.46.1
    Preparing search index...

    Class HeightmapGenerator

    Utility class for heightmap generation using various algorithms.

    Index

    Constructors

    Methods

    • Generates a heightmap using the Diamond-Square algorithm as an ImageBitmap.

      Parameters

      • detail: number = 8

        Size = 2^detail + 1.

      • roughness: number = 0.6

        The roughness factor.

      Returns Promise<ImageBitmap>

      A promise resolving to an ImageBitmap.

    • Generates a heightmap as a Float32Array using the Diamond-Square algorithm.

      Parameters

      • detail: number = 8

        Size = 2^detail + 1.

      • roughness: number = 0.6

        The roughness factor.

      • Optionalseed: string

        Optional seed for random generation.

      Returns Promise<Float32Array<ArrayBufferLike>>

      A promise resolving to a Float32Array.

    • Generates a heightmap using Perlin noise.

      Parameters

      • detail: number = 8

        Size = 2^detail + 1.

      • scale: number = 0.02

        Noise scale.

      • offsetX: number = 0

        X offset.

      • offsetY: number = 0

        Y offset.

      • octaves: number = 4

        Number of octaves.

      • persistence: number = 0.5

        Persistence factor.

      Returns Promise<Float32Array<ArrayBufferLike>>

      A promise resolving to a Float32Array.

    • Generates a heightmap using Simplex noise.

      Parameters

      • detail: number = 8

        Size = 2^detail + 1.

      • scale: number = 0.02

        Noise scale.

      • offsetX: number = 0

        X offset.

      • offsetY: number = 0

        Y offset.

      • octaves: number = 4

        Number of octaves.

      • persistence: number = 0.5

        Persistence factor.

      Returns Promise<Float32Array<ArrayBufferLike>>

      A promise resolving to a Float32Array.