skin3d/dist/Nametag.d.ts

Skin3d is a lightweight JS library that renders any Minecraft skin as a smooth, interactive 3D model you can drop straight into a webpage.

/**
 * @file Nametag.ts
 * @description This file defines the NameTagObject class for creating Minecraft-style name tags.
 * @author Cosmic-fi
 * @license MIT
 */
import { Sprite } from "three";
export interface NameTagOptions {
    /**
     * Font specification using CSS font syntax (e.g., "48px Arial").
     *
     * @defaultValue `"48px Minecraft"`
     *
     * @remarks
     * To use the Minecraft font, add this @font-face rule to your CSS:
     * ```css
     * @font-face {
     *   font-family: 'Minecraft';
     *   src: url('/path/to/minecraft.woff2') format('woff2');
     * }
     * ```
     * Get the font from {@link https://github.com/South-Paw/typeface-minecraft}.
     */
    font?: string;
    /**
     * Whether to repaint the name tag after the desired font is loaded.
     *
     * The font specified in `font` option may not be available when a {@link NameTagObject} is created,
     * especially when you are using a web font. In this case, a fallback font will be used.
     *
     * If `repaintAfterLoaded` is `true`, the name tag is repainted after the desired font is loaded.
     * This process can be monitored using {@link NameTagObject.painted}.
     *
     * @defaultValue `true`
     */
    repaintAfterLoaded?: boolean;
    /**
     * The space (in pixels) between the text and the border of the name tag.
     *
     * Order: **top**, **right**, **bottom**, **left** (clockwise).
     *
     * @defaultValue `[5, 10, 5, 10]`
     */
    margin?: [number, number, number, number];
    /**
     * The color, gradient, or pattern used to draw the text.
     *
     * @defaultValue `"white"`
     */
    textStyle?: string | CanvasGradient | CanvasPattern;
    /**
     * The color, gradient, or pattern used to draw the background.
     *
     * @defaultValue `"rgba(0,0,0,.25)"`
     */
    backgroundStyle?: string | CanvasGradient | CanvasPattern;
    /**
     * The height of the name tag object.
     *
     * @defaultValue `4.0`
     */
    height?: number;
}
/**
 * A Minecraft name tag, i.e. a text label with background.
 */
export declare class NameTagObject extends Sprite {
    /**
     * A promise that is resolved after the name tag is fully painted.
     *
     * This will be a resolved promise, if
     * {@link NameTagOptions.repaintAfterLoaded} is `false`, or
     * the desired font is available when the `NameTagObject` is created.
     *
     * If {@link NameTagOptions.repaintAfterLoaded} is `true`, and
     * the desired font hasn't been loaded when the `NameTagObject` is created,
     * the name tag will be painted with the fallback font first, and then
     * repainted with the desired font after it's loaded. This promise is
     * resolved after repainting is done.
     */
    readonly painted: Promise<void>;
    private text;
    private font;
    private margin;
    private textStyle;
    private backgroundStyle;
    private height;
    private textMaterial;
    constructor(text?: string, options?: NameTagOptions);
    /**
     * Set the text of the name tag.
     * @param newText The new text.
     */
    private loadAndPaint;
    /**
     * Paint the name tag.
     * This method creates a canvas, draws the text and background,
     * and applies it as a texture to the sprite.
     * @private
     */
    private paint;
}