Interface SkinLoadOptions

interface SkinLoadOptions {
    armors?: null | RemoteImage | TextureSource | (RemoteImage | TextureSource | null)[];
    ears?: boolean | "load-only";
    makeVisible?: boolean;
    model?: ModelType | "auto-detect";
}

Hierarchy (view full)

Properties

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

The armor textures to load along with the skin.

This option behaves exactly the same as the armors option in SkinViewerOptions. You can specify a single armor material, null (to hide all armor), or an array of armor materials. The array length must be 1, 2, or 4, with the same semantics as described in SkinViewerOptions.

If unspecified, the armor will not be changed (i.e., remains as previously set).

ears?: boolean | "load-only"

Whether to display the ears drawn on the skin texture.

  • true - Display the ears drawn on the skin texture.
  • "load-only" - Loads the ear texture, but do not make them visible. You can make them visible later by setting PlayerObject.ears.visible to true.
  • false - Do not load or show the ears.

Default Value

false

makeVisible?: boolean

Whether to make the object visible after the texture is loaded.

Default Value

true

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.

Default Value

"auto-detect"

Generated using TypeDoc