Scrawl-canvas API
    Preparing search index...

    Interface GridFactoryFunctions

    interface GridFactoryFunctions {
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        checkHit?: (tests: HitTests) => boolean | HitOutput;
        clearFilters?: () => EntityInstance;
        clickAnchor?: () => void;
        clickButton?: () => void;
        clone: (item?: GridFactoryInputs) => GridInstance;
        columnIndex: (index: number) => number;
        dropArtefact?: () => ArtefactInstance;
        fillColumn: (CommonObjectInput: any) => GridInstance;
        fillRect: (CommonObjectInput: any) => GridInstance;
        fillRow: (CommonObjectInput: any) => GridInstance;
        get: (item: string) => any;
        getTileSource: (row: number, col?: number) => number;
        getTilesUsingSource: (key: number) => number[];
        importPacket: (
            item: string | string[],
            override?: CommonObjectInput,
        ) => any;
        kill: (item?: any) => void;
        pickupArtefact?: (
            items: CommonHereObjectInput | CommonTwoElementArrayInput,
        ) => ArtefactInstance;
        positionIndices: (index: number) => [number, number] | [];
        removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        removeTileSource: (index: number) => GridInstance;
        reverseByDelta: () => ArtefactInstance;
        rowIndex: (index: number) => number;
        saveAsPacket: (item?: boolean | GridSaveInputs) => string;
        set: (item?: GridFactoryInputs) => GridInstance;
        setAllTilesTo: (index: number) => GridInstance;
        setDelta: (item?: GridFactoryDeltaInputs) => GridInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        setTileFill: (item: number[]) => GridInstance;
        setTileSourceTo: (index: number, obj: GridTileObject) => GridInstance;
        setTilesTo: (tiles: number[], val: number) => GridInstance;
        simpleStamp: (host: CellInstance, items?: GridFactoryInputs) => void;
        tileIndexFromPosition: (row: number, column: number) => number;
        updateByDelta: () => ArtefactInstance;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionPacket: (item: string, override?: CommonObjectInput) => any
    addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    checkHit?: (tests: HitTests) => boolean | HitOutput
    clearFilters?: () => EntityInstance
    clickAnchor?: () => void
    clickButton?: () => void
    clone: (item?: GridFactoryInputs) => GridInstance
    columnIndex: (index: number) => number
    dropArtefact?: () => ArtefactInstance
    fillColumn: (CommonObjectInput: any) => GridInstance
    fillRect: (CommonObjectInput: any) => GridInstance
    fillRow: (CommonObjectInput: any) => GridInstance
    get: (item: string) => any
    getTileSource: (row: number, col?: number) => number
    getTilesUsingSource: (key: number) => number[]
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    kill: (item?: any) => void
    pickupArtefact?: (
        items: CommonHereObjectInput | CommonTwoElementArrayInput,
    ) => ArtefactInstance
    positionIndices: (index: number) => [number, number] | []
    removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    removeTileSource: (index: number) => GridInstance
    reverseByDelta: () => ArtefactInstance
    rowIndex: (index: number) => number
    saveAsPacket: (item?: boolean | GridSaveInputs) => string
    setAllTilesTo: (index: number) => GridInstance
    setDelta: (item?: GridFactoryDeltaInputs) => GridInstance
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    setTileFill: (item: number[]) => GridInstance
    setTileSourceTo: (index: number, obj: GridTileObject) => GridInstance
    setTilesTo: (tiles: number[], val: number) => GridInstance
    simpleStamp: (host: CellInstance, items?: GridFactoryInputs) => void
    tileIndexFromPosition: (row: number, column: number) => number
    updateByDelta: () => ArtefactInstance