Interface SkinViewerOptions

interface SkinViewerOptions {
    animation?: PlayerAnimation;
    armors?: null | RemoteImage | TextureSource | (RemoteImage | TextureSource | null)[];
    background?: Texture | ColorRepresentation;
    canvas?: HTMLCanvasElement;
    cape?: RemoteImage | TextureSource;
    ears?: {
        source: RemoteImage | TextureSource;
        textureType: "skin" | "standalone";
    } | "current-skin";
    enableControls?: boolean;
    fov?: number;
    height?: number;
    model?: ModelType | "auto-detect";
    nameTag?: string | NameTagObject;
    panorama?: RemoteImage | TextureSource;
    pixelRatio?: number | "match-device";
    preserveDrawingBuffer?: boolean;
    renderPaused?: boolean;
    skin?: RemoteImage | TextureSource;
    width?: number;
    zoom?: number;
}

Properties

animation? armors? background? canvas? cape? ears? enableControls? fov? height? model? nameTag? panorama? pixelRatio? preserveDrawingBuffer? renderPaused? skin? width? zoom?

Properties

Optional animation

animation?: PlayerAnimation

The animation to play on the player.

Default Value

If unspecified, no animation will be played.

Optional armors

armors?: null | RemoteImage | TextureSource | (RemoteImage | TextureSource | null)[]

The armor textures of the player.

You can specify a single armor material or an array of armor materials. An armor material can be a RemoteImage, a TextureSource, or null (to hide that piece).

When a single material is provided, its type ("main" for helmet, chestplate, boots; or "legs" for leggings) will be automatically detected and applied to the corresponding armor pieces.

When an array is provided, its length must be 1, 2, or 4:

  • Length 1: Treated the same as providing a single material (auto‑detect type).
  • Length 2: Automatically detects the two materials' types (expected one "main" and one "legs") and applies them.
  • Length 4: Materials are applied in order: [helmet, chestplate, leggings, boots]. Any element can be null to leave that slot empty.

If the option is omitted, set to null, or an empty array, no armor will be visible.

Default Value

undefined (no armor)

Optional background

background?: Texture | ColorRepresentation

The background of the scene.

Default Value

transparent

Optional canvas

canvas?: HTMLCanvasElement

The canvas where the renderer draws its output.

Default Value

If unspecified, a new canvas element will be created.

Optional cape

cape?: RemoteImage | TextureSource

The cape texture of the player.

Default Value

If unspecified, the cape will be invisible.

Optional ears

ears?: {
    source: RemoteImage | TextureSource;
    textureType: "skin" | "standalone";
} | "current-skin"

The ear texture of the player.

When set to "current-skin", the ears drawn on the current skin texture (as is specified in the skin option) will be shown.

To use an individual ear texture, you have to specify the textureType and the source option. source is the texture to use, and textureType can be either "standalone" or "skin":

  • "standalone" means the provided texture is a 14x7 image that only contains the ears.
  • "skin" means the provided texture is a skin texture with ears, and we will show its ear part.

Type declaration

  • source: RemoteImage | TextureSource
  • textureType: "skin" | "standalone"

Default Value

If unspecified, the ears will be invisible.

Optional enableControls

enableControls?: boolean

Whether to enable mouse control function.

This function is implemented using OrbitControls. By default, zooming and rotating are enabled, and panning is disabled.

Default Value

true

Optional fov

fov?: number

Camera vertical field of view, in degrees.

The distance between the player and the camera will be automatically computed from fov and zoom.

Default Value

50

See

SkinViewer.adjustCameraDistance

Optional height

height?: number

The CSS height of the canvas.

Optional model

model?: ModelType | "auto-detect"

The model of the player ("default" for normal arms, and "slim" for slim arms).

When set to "auto-detect", the model will be inferred from the skin texture.

If the skin option is not specified, this option will have no effect.

Default Value

"auto-detect"

Optional nameTag

nameTag?: string | NameTagObject

The name tag to display above the player.

Default Value

If unspecified, no name tag will be displayed.

See

SkinViewer.nameTag

Optional panorama

panorama?: RemoteImage | TextureSource

The panorama background to use.

This option overrides the background option.

Optional pixelRatio

pixelRatio?: number | "match-device"

The pixel ratio of the canvas.

When set to "match-device", the current device pixel ratio will be used, and it will be automatically updated when the device pixel ratio changes.

Default Value

"match-device"

Optional preserveDrawingBuffer

preserveDrawingBuffer?: boolean

Whether to preserve the buffers until manually cleared or overwritten.

Default Value

false

Optional renderPaused

renderPaused?: boolean

Whether to pause the rendering and animation loop.

Default Value

false

Optional skin

skin?: RemoteImage | TextureSource

The skin texture of the player.

Default Value

If unspecified, the skin will be invisible.

Optional width

width?: number

The CSS width of the canvas.

Optional zoom

zoom?: number

Zoom ratio of the player.

This value affects the distance between the object and the camera. When set to 1.0, the top edge of the player's head coincides with the edge of the canvas.

The distance between the player and the camera will be automatically computed from fov and zoom.

Default Value

0.9

See

SkinViewer.adjustCameraDistance

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc