Engine API Reference - v2.6.1
    Preparing search index...

    Class Batch

    Holds information about batched mesh instances. Created in BatchManager#create.

    Index

    Constructors

    • Create a new Batch instance.

      Parameters

      • meshInstances: MeshInstance[]

        The mesh instances to be batched.

      • dynamic: boolean

        Whether this batch is dynamic (supports transforming mesh instances at runtime).

      • batchGroupId: number

        Link this batch to a specific batch group. This is done automatically with default batches.

      Returns Batch

    Properties

    batchGroupId: number

    Link this batch to a specific batch group. This is done automatically with default batches.

    dynamic: boolean

    Whether this batch is dynamic (supports transforming mesh instances at runtime).

    meshInstance: MeshInstance = null

    A single combined mesh instance, the result of batching.

    origMeshInstances: MeshInstance[]

    An array of original mesh instances, from which this batch was generated.

    Methods

    • Removes the batch from the layers and destroys it.

      Parameters

      • scene: Scene

        The scene.

      • layers: number[]

        The layers to remove the batch from.

      Returns void