Blockbench Reference Docs
    Preparing search index...

    Interface Array<T>

    interface Array<T> {
        allAre(callback: (item: T, index: number) => boolean): boolean;
        allEqual(item: T): boolean;
        atWrapped(index: number): T;
        empty(): this;
        equals(array: any[]): boolean;
        findHighest(callback: (item: T) => number): T;
        findInArray(key: string, value: any): number;
        forEachReverse(callback: (item: T, index: number) => void): void;
        last(): T;
        overlap(arr: any[]): number;
        positiveItems(): number;
        random(): T;
        remove(item: any): boolean;
        replace(items: T[]): boolean;
        safePush(...items: any): boolean;
        toggle(item: T, state?: boolean): boolean;
        V3_add(x: number, y: number, z: number): ArrayVector3;
        V3_add(values: ArrayVector3): ArrayVector3;
        V3_add(value: Vector3): ArrayVector3;
        V3_divide(x: number, y: number, z: number): ArrayVector3;
        V3_divide(values: ArrayVector3): ArrayVector3;
        V3_divide(value: Vector3): ArrayVector3;
        V3_multiply(x: number, y: number, z: number): ArrayVector3;
        V3_multiply(values: ArrayVector3): ArrayVector3;
        V3_multiply(value: Vector3): ArrayVector3;
        V3_set(x: number, y: number, z: number): ArrayVector3;
        V3_set(values: ArrayVector3): ArrayVector3;
        V3_subtract(x: number, y: number, z: number): ArrayVector3;
        V3_subtract(values: ArrayVector3): ArrayVector3;
        V3_subtract(value: Vector3): ArrayVector3;
        V3_toThree(): Vector3;
        [n: number]: T;
    }

    Type Parameters

    • T

    Hierarchy

    • RelativeIndexable<T>
      • Array

    Indexable

    • [n: number]: T
    Index

    Methods

    allAre allEqual atWrapped empty equals findHighest findInArray forEachReverse last overlap positiveItems random remove replace safePush toggle V3_add V3_divide V3_multiply V3_set V3_subtract V3_toThree

    Methods

    • Parameters

      • callback: (item: T, index: number) => boolean

      Returns boolean

    • Get the item at the specified index with a modulo applied, so any index will return a value

      Parameters

      • index: number

      Returns T

    • Same as forEach, but in reverse order

      Parameters

      • callback: (item: T, index: number) => void

      Returns void

    • Returns the amount of items that exist in this array and the reference array

      Parameters

      • arr: any[]

      Returns number

    • Adds items to the array if they are not yet in the array

      Parameters

      • ...items: any

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Methods