Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "skins"

Index

Functions

isAlex

  • isAlex(id: string): number

resetSkin

  • resetSkin(accessToken: string, id: string): Promise<void>
  • Reset (delete) a profile's in-game skin.

    see

    http://wiki.vg/Mojang_API#Reset_Skin

    Parameters

    • accessToken: string

      Access token from yggdrasil

    • id: string

      Profile UUID belonging to same user

    Returns Promise<void>

setSkin

  • setSkin(accessToken: string, profileId: string, url: string, slim?: boolean): Promise<void>
  • Set a profile's in-game skin using an online image.

    see

    http://wiki.vg/Mojang_API#Change_Skin

    Parameters

    • accessToken: string

      Access token from yggdrasil

    • profileId: string
    • url: string

      Internet-accessible URL of the skin image

    • Default value slim: boolean = false

      If true, skin will use slim character model

    Returns Promise<void>

uploadSkin

  • uploadSkin(accessToken: string, profileId: string, file: Stream | Buffer, slim?: boolean): Promise<void>
  • Set a profile's in-game skin using a file upload.

    see

    http://wiki.vg/Mojang_API#Change_Skin

    Parameters

    • accessToken: string

      Access token from yggdrasil

    • profileId: string
    • file: Stream | Buffer

      new skin's binary image data

    • Default value slim: boolean = false

      If true, skin will use slim character model

    Returns Promise<void>

Generated using TypeDoc