Skip to main content

generateSpiritTreeTier

Callable


  • Generates a tier-based spirit tree image as a Buffer.

    @example
    import { generateSpiritTreeTier } from './SpiritTreeTierRenderer';
    import type { ISpiritTree } from '@skyhelperbot/constants/skygame-planner';

    const tree: ISpiritTree = getSpiritTreeData();
    const buffer = await generateSpiritTreeTier(tree, {
    season: true,
    spiritName: "Grateful Spirit",
    spiritSubtitle: "Season of Gratitude",
    highlightItems: ["item1", "item2"],
    scale: 1
    });

    Parameters

    NameTypeDefaultDescription
    treeany

    The spirit tree data to render (must have tier structure).

    optionsGenerateSpiritTreeTierOptions = {}

    rendering options.

    Returns Promise<Buffer>

    A promise that resolves to a PNG image buffer of the rendered spirit tree.