Interface TeeSkinRenderOptions

Skin rendering options

interface TeeSkinRenderOptions {
    customColors?: {
        bodyTWcode?: null | number;
        decorationTWcode?: null | number;
        eyesTWcode?: null | number;
        feetTWcode?: null | number;
        markingTWcode?: null | number;
    };
    eyeVariant?:
        | "eye-default"
        | "eye-evil"
        | "eye-hurt"
        | "eye-happy"
        | "eye-surprised";
    saveFilePath?: null | string;
    size?: number;
}

Properties

customColors?: {
    bodyTWcode?: null | number;
    decorationTWcode?: null | number;
    eyesTWcode?: null | number;
    feetTWcode?: null | number;
    markingTWcode?: null | number;
}

Custom colors to use in TW color code format.

Type declaration

  • OptionalbodyTWcode?: null | number

    TW code for the body color.

  • OptionaldecorationTWcode?: null | number

    TW code for the decoration color.

  • OptionaleyesTWcode?: null | number

    TW code for the eyes color.

  • OptionalfeetTWcode?: null | number

    TW code for the feet color.

  • OptionalmarkingTWcode?: null | number

    TW code for the marking color.

Both TW color codes for feet and body must be provided for 0.6 skins.

eyeVariant?:
    | "eye-default"
    | "eye-evil"
    | "eye-hurt"
    | "eye-happy"
    | "eye-surprised"

The eye variant to render with.

"eye-default"
saveFilePath?: null | string

If provided, will save the output buffer as a png to the specified path.

"./skins/output.png"
size?: number

The size in pixels of the final image.

96