Skip to content
Last Updated
Mar 28, 2025, 03:08

Class PlayerModel ​

🏭 Constructors ​

constructor ​

ts
PlayerModel(): PlayerModel

Return Type ​

  • PlayerModel

Defined in: packages/model/player.ts:217

🏷️ Properties ​

materialCape readonly ​

ts
materialCape: MeshBasicMaterial

Defined in: packages/model/player.ts:213

materialPlayer readonly ​

ts
materialPlayer: MeshBasicMaterial

Defined in: packages/model/player.ts:211

materialTransparent readonly ​

ts
materialTransparent: MeshBasicMaterial

Defined in: packages/model/player.ts:212

playerObject3d readonly ​

ts
playerObject3d: PlayerObject3D

Defined in: packages/model/player.ts:210

textureCape readonly ​

ts
textureCape: CanvasTexture

Defined in: packages/model/player.ts:214

texturePlayer readonly ​

ts
texturePlayer: CanvasTexture

Defined in: packages/model/player.ts:215

🔧 Methods ​

setCape ​

ts
setCape(cape: undefined | TextureSource): Promise<void>

Parameters ​

  • cape: undefined | TextureSource

Return Type ​

  • Promise<void>

Defined in: packages/model/player.ts:275

setSkin ​

ts
setSkin(skin: TextureSource, isSlim: boolean= false): Promise<void>

Parameters ​

  • skin: TextureSource The skin texture source. Should be url string, URL object, or a Image HTML element
  • isSlim: boolean Is this skin slim

Return Type ​

  • Promise<void>

Defined in: packages/model/player.ts:256

create static ​

ts
create(): PlayerModel

Return Type ​

  • PlayerModel

Defined in: packages/model/player.ts:208