hytopia 0.10.7 → 0.10.9

package/docs/server.defaultplayerentity.cosmetichiddenslots.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntity](./server.defaultplayerentity.md) &gt; [cosmeticHiddenSlots](./server.defaultplayerentity.cosmetichiddenslots.md)
+
+## DefaultPlayerEntity.cosmeticHiddenSlots property
+
+The cosmetic slots that are hidden.
+
+**Signature:**
+
+```typescript
+get cosmeticHiddenSlots(): PlayerCosmeticSlot[];
+```

package/docs/server.defaultplayerentity.md

@@ -60,3 +60,49 @@ Constructs a new instance of the `DefaultPlayerEntity` class
 </td></tr>
 </tbody></table>
 
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cosmeticHiddenSlots](./server.defaultplayerentity.cosmetichiddenslots.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+PlayerCosmeticSlot\[\]
+
+
+</td><td>
+
+The cosmetic slots that are hidden.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/server.defaultplayerentityoptions.md

@@ -9,7 +9,9 @@ Options for creating a DefaultPlayerEntity instance.
 **Signature:**
 
 ```typescript
-export type DefaultPlayerEntityOptions = {} & PlayerEntityOptions;
+export type DefaultPlayerEntityOptions = {
+    cosmeticHiddenSlots?: PlayerCosmeticSlot[];
+} & PlayerEntityOptions;
 ```
 **References:** [PlayerEntityOptions](./server.playerentityoptions.md)
 

package/docs/server.md

@@ -1789,6 +1789,28 @@ Options for the [PathfindingEntityController.pathfind()](./server.pathfindingent
 The camera orientation state of a Player.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCosmetics](./server.playercosmetics.md)
+
+
+</td><td>
+
+The cosmetics of a player.
+
+
+</td></tr>
+<tr><td>
+
+[PlayerCosmeticsEquippedItem](./server.playercosmeticsequippeditem.md)
+
+
+</td><td>
+
+An equipped item of a player's cosmetics.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.cosmetics.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [cosmetics](./server.player.cosmetics.md)
+
+## Player.cosmetics property
+
+The cosmetics for the player
+
+**Signature:**
+
+```typescript
+readonly cosmetics: Promise<PlayerCosmetics | void>;
+```

package/docs/server.player.md

@@ -68,6 +68,27 @@ Description
 The camera for the player.
 
 
+</td></tr>
+<tr><td>
+
+[cosmetics](./server.player.cosmetics.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Promise&lt;[PlayerCosmetics](./server.playercosmetics.md) \| void&gt;
+
+
+</td><td>
+
+The cosmetics for the player
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercosmetics.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCosmetics](./server.playercosmetics.md)
+
+## PlayerCosmetics type
+
+The cosmetics of a player.
+
+**Signature:**
+
+```typescript
+export type PlayerCosmetics = {
+    equippedItems: {
+        slot: string;
+        item: PlayerCosmeticsEquippedItem;
+    }[];
+    hairStyle: number;
+    skinTextureUri: string;
+};
+```
+**References:** [PlayerCosmeticsEquippedItem](./server.playercosmeticsequippeditem.md)
+

package/docs/server.playercosmeticsequippeditem.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCosmeticsEquippedItem](./server.playercosmeticsequippeditem.md)
+
+## PlayerCosmeticsEquippedItem type
+
+An equipped item of a player's cosmetics.
+
+**Signature:**
+
+```typescript
+export type PlayerCosmeticsEquippedItem = {
+    flags: string[];
+    type: string;
+    modelUrl: string;
+    textureUrl?: string;
+};
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.10.7",
+  "version": "0.10.9",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./server.mjs",

package/server.api.json

@@ -11012,6 +11012,41 @@
                   "isOptional": false
                 }
               ]
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!DefaultPlayerEntity#cosmeticHiddenSlots:member",
+              "docComment": "/**\n * The cosmetic slots that are hidden.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get cosmeticHiddenSlots(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerCosmeticSlot",
+                  "canonicalReference": "server!~PlayerCosmeticSlot:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cosmeticHiddenSlots",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
             }
           ],
           "extendsTokenRange": {
@@ -12927,7 +12962,16 @@
             },
             {
               "kind": "Content",
-              "text": "{} & "
+              "text": "{\n    cosmeticHiddenSlots?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlayerCosmeticSlot",
+              "canonicalReference": "server!~PlayerCosmeticSlot:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n} & "
             },
             {
               "kind": "Reference",
@@ -12944,7 +12988,7 @@
           "name": "DefaultPlayerEntityOptions",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 3
+            "endIndex": 5
           }
         },
         {
@@ -35375,6 +35419,50 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Player#cosmetics:member",
+              "docComment": "/**\n * The cosmetics for the player\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly cosmetics: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerCosmetics",
+                  "canonicalReference": "server!PlayerCosmetics:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cosmetics",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Player#disconnect:member(1)",
@@ -38359,6 +38447,67 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PlayerCosmetics:type",
+          "docComment": "/**\n * The cosmetics of a player.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PlayerCosmetics = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    equippedItems: {\n        slot: string;\n        item: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlayerCosmeticsEquippedItem",
+              "canonicalReference": "server!PlayerCosmeticsEquippedItem:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    }[];\n    hairStyle: number;\n    skinTextureUri: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/networking/PlatformGateway.ts",
+          "releaseTag": "Public",
+          "name": "PlayerCosmetics",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PlayerCosmeticsEquippedItem:type",
+          "docComment": "/**\n * An equipped item of a player's cosmetics.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PlayerCosmeticsEquippedItem = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    flags: string[];\n    type: string;\n    modelUrl: string;\n    textureUrl?: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/networking/PlatformGateway.ts",
+          "releaseTag": "Public",
+          "name": "PlayerCosmeticsEquippedItem",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!PlayerEntity:class",

package/server.d.ts

@@ -1435,7 +1435,11 @@ export declare const DEFAULT_ENTITY_RIGID_BODY_OPTIONS: RigidBodyOptions;
  * @public
  */
 export declare class DefaultPlayerEntity extends PlayerEntity {
+    private _cosmeticHiddenSlots;
     constructor(options: DefaultPlayerEntityOptions);
+    /** The cosmetic slots that are hidden. @public */
+    get cosmeticHiddenSlots(): PlayerCosmeticSlot[];
+
 }
 
 /**
@@ -1653,7 +1657,9 @@ export declare interface DefaultPlayerEntityControllerOptions {
 }
 
 /** Options for creating a DefaultPlayerEntity instance. @public */
-export declare type DefaultPlayerEntityOptions = {} & PlayerEntityOptions;
+export declare type DefaultPlayerEntityOptions = {
+    cosmeticHiddenSlots?: PlayerCosmeticSlot[];
+} & PlayerEntityOptions;
 
 /** The options for a dynamic rigid body, also the default type. @public */
 export declare interface DynamicRigidBodyOptions extends BaseRigidBodyOptions {
@@ -4368,6 +4374,8 @@ export declare class Player extends EventRouter implements protocol.Serializable
     /** The camera for the player. */
     readonly camera: PlayerCamera;
 
+    /** The cosmetics for the player */
+    readonly cosmetics: Promise<PlayerCosmetics | void>;
     /** The UI for the player. */
     readonly ui: PlayerUI;
 
@@ -4718,6 +4726,27 @@ export declare type PlayerCameraOrientation = {
     yaw: number;
 };
 
+/** The cosmetics of a player. @public */
+export declare type PlayerCosmetics = {
+    equippedItems: {
+        slot: string;
+        item: PlayerCosmeticsEquippedItem;
+    }[];
+    hairStyle: number;
+    skinTextureUri: string;
+};
+
+/** An equipped item of a player's cosmetics. @public */
+export declare type PlayerCosmeticsEquippedItem = {
+    flags: string[];
+    type: string;
+    modelUrl: string;
+    textureUrl?: string;
+};
+
+/** The slots used for player cosmetics. @public */
+declare type PlayerCosmeticSlot = 'ALL' | 'BACK' | 'HEAD' | 'LEFT_ARM' | 'LEFT_FOOT' | 'LEFT_HAND' | 'LEFT_ITEM' | 'LEFT_LEG' | 'RIGHT_ARM' | 'RIGHT_FOOT' | 'RIGHT_HAND' | 'RIGHT_ITEM' | 'RIGHT_LEG' | 'TORSO';
+
 /**
  * Represents an entity controlled by a player in a world.
  *