Class SerializedSkin

constructor

• new SerializedSkin(
      identifier: string,
      playFabIdentifier: string,
      resourcePatch: string,
      skinImage: SkinImage,
      animations: SkinAnimation[],
      capeImage: SkinImage,
      geometryData: string,
      geometryVersion: string,
      animationData: string,
      capeIdentifier: string,
      fullIdentifier: string,
      armSize: string,
      skinColor: string,
      personaPieces: SkinPersonaPiece[],
      tintPieces: SkinPersonaTintPiece[],
      isPremium: boolean,
      isPersona: boolean,
      isPersonaCapeOnClassic: boolean,
      isPrimaryUser: boolean,
      overridingPlayerAppearance: boolean,
  ): SerializedSkin

  Creates a new serialized skin.

  Parameters

  • identifier: string

    The identifier of the skin.
  • playFabIdentifier: string

    The playfab identifier of the skin.
  • resourcePatch: string

    The resource patch of the skin.
  • skinImage: SkinImage

    The skin image.
  • animations: SkinAnimation[]

    The animations of the skin.
  • capeImage: SkinImage

    The cape image.
  • geometryData: string

    The geometry data of the skin.
  • geometryVersion: string

    The geometry version of the skin.
  • animationData: string

    The animation data of the skin.
  • capeIdentifier: string

    The cape identifier of the skin.
  • fullIdentifier: string

    The full identifier of the skin.
  • armSize: string

    The arm size of the skin.
  • skinColor: string
  • personaPieces: SkinPersonaPiece[]

    The persona pieces of the skin.
  • tintPieces: SkinPersonaTintPiece[]

    The tint pieces of the skin.
  • isPremium: boolean

    If the skin is premium.
  • isPersona: boolean

    If the skin is persona.
  • isPersonaCapeOnClassic: boolean

    If there is a persona cape on classic skin.
  • isPrimaryUser: boolean

    If the skin is used by its primary user.
  • overridingPlayerAppearance: boolean

    If the skin will override the player appearance.

  Returns SerializedSkin

  A new serialized skin.

animationData

animations

armSize

capeIdentifier

capeImage

fullIdentifier

geometryData

geometryVersion

identifier

isPersona

isPersonaCapeOnClassic

isPremium

isPrimaryUser

overridingPlayerAppearance

personaPieces

playFabIdentifier

resourcePatch

skinColor

skinImage

tintPieces

Staticempty

• empty(): SerializedSkin

  Returns an empty serialized skin.

  Returns SerializedSkin

  An empty serialized skin.

Staticfrom

• from(data: ClientData): SerializedSkin

  Converts the client data to a serialized skin.

  Parameters

  • data: ClientData

    The client data to convert.

  Returns SerializedSkin

  The serialized skin.

Staticread

• read(stream: BinaryStream): SerializedSkin

  Read a value from the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to read from.

  Returns SerializedSkin

  The value read from the stream.

Staticwrite

• write(stream: BinaryStream, skin: SerializedSkin): void

  Write a value to the stream.

  Parameters

  • stream: BinaryStream

    The BinaryStream to write to.
  • skin: SerializedSkin

  Returns void