Class PlayerSkin

Index

Constructors

Accessors

Methods

getGeometry getSerialized getSkinImage setGeometry setSerialized setSkinImage

Constructors

constructor

new PlayerSkin(player: Player, source: SerializedSkin): PlayerSkin
Create a new player skin.
Parameters
- player: Player
  The player that is attached to this skin.
- source: SerializedSkin
  The original source of the skin.
Returns PlayerSkin
- Defined in packages/core/src/entity/skin.ts:30

Accessors

identifier

get identifier(): string
Gets the identifier of the skin.

Returns string
- Defined in packages/core/src/entity/skin.ts:184

Methods

getGeometry

getGeometry(): Record<string, unknown>
Get the current geometry of the skin.

Returns Record<string, unknown>
The geometry of the skin.
- Defined in packages/core/src/entity/skin.ts:40

getSerialized

getSerialized(): SerializedSkin
Get the serialized skin.

Returns SerializedSkin
The serialized skin.
- Defined in packages/core/src/entity/skin.ts:169

getSkinImage

getSkinImage(): Promise<Bitmap>
Get the skin image as a bitmap.

Returns Promise<Bitmap>
The skin image bitmap.
- Defined in packages/core/src/entity/skin.ts:119

setGeometry

setGeometry(geometry: string | Record<string, unknown>): void
Set the geometry of the skin.
Parameters
- geometry: string | Record<string, unknown>
  The geometry to set, either as a record or a string.
Returns void
- Defined in packages/core/src/entity/skin.ts:49

setSerialized

setSerialized(skin: SerializedSkin): void
Sets the serialized skin.
Parameters
- skin: SerializedSkin
  The serialized skin to set.
Returns void
- Defined in packages/core/src/entity/skin.ts:177

setSkinImage

setSkinImage(image: string | Buffer<ArrayBufferLike> | Bitmap): Promise<void>
Set the skin image from a bitmap or buffer.
Parameters
- image: string | Buffer<ArrayBufferLike> | Bitmap
  The skin image to set, either as a bitmap or buffer.
Returns Promise<void>
Note
When setting a skin, you must also set the geometry, otherwise the skin will not be displayed correctly.
- Defined in packages/core/src/entity/skin.ts:132