hytopia 0.2.8 → 0.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -68,5 +68,24 @@ string
68
68
  </td><td>
69
69
 
70
70
 
71
+ </td></tr>
72
+ <tr><td>
73
+
74
+ [playerId?](./server.chateventpayload.sendbroadcastmessage.playerid.md)
75
+
76
+
77
+ </td><td>
78
+
79
+
80
+ </td><td>
81
+
82
+ string
83
+
84
+
85
+ </td><td>
86
+
87
+ _(Optional)_
88
+
89
+
71
90
  </td></tr>
72
91
  </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [ChatEventPayload](./server.chateventpayload.md) &gt; [SendBroadcastMessage](./server.chateventpayload.sendbroadcastmessage.md) &gt; [playerId](./server.chateventpayload.sendbroadcastmessage.playerid.md)
4
+
5
+ ## ChatEventPayload.SendBroadcastMessage.playerId property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ playerId?: string;
11
+ ```
@@ -9,8 +9,9 @@ A player in the game.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export default class Player
12
+ export default class Player implements protocol.Serializable
13
13
  ```
14
+ **Implements:** protocol.Serializable
14
15
 
15
16
  ## Remarks
16
17
 
@@ -93,6 +93,27 @@ Description
93
93
  </th></tr></thead>
94
94
  <tbody><tr><td>
95
95
 
96
+ [nametagSceneUI](./server.playerentity.nametagsceneui.md)
97
+
98
+
99
+ </td><td>
100
+
101
+ `readonly`
102
+
103
+
104
+ </td><td>
105
+
106
+ [SceneUI](./server.sceneui.md)
107
+
108
+
109
+ </td><td>
110
+
111
+ The SceneUI instance for the player entity's nametag.
112
+
113
+
114
+ </td></tr>
115
+ <tr><td>
116
+
96
117
  [player](./server.playerentity.player.md)
97
118
 
98
119
 
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntity](./server.playerentity.md) &gt; [nametagSceneUI](./server.playerentity.nametagsceneui.md)
4
+
5
+ ## PlayerEntity.nametagSceneUI property
6
+
7
+ The SceneUI instance for the player entity's nametag.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly nametagSceneUI: SceneUI;
13
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hytopia",
3
- "version": "0.2.8",
3
+ "version": "0.2.10",
4
4
  "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
5
5
  "main": "server.js",
6
6
  "bin": {
package/server.api.json CHANGED
@@ -4485,6 +4485,33 @@
4485
4485
  "startIndex": 1,
4486
4486
  "endIndex": 2
4487
4487
  }
4488
+ },
4489
+ {
4490
+ "kind": "PropertySignature",
4491
+ "canonicalReference": "server!ChatEventPayload.SendBroadcastMessage#playerId:member",
4492
+ "docComment": "",
4493
+ "excerptTokens": [
4494
+ {
4495
+ "kind": "Content",
4496
+ "text": "playerId?: "
4497
+ },
4498
+ {
4499
+ "kind": "Content",
4500
+ "text": "string"
4501
+ },
4502
+ {
4503
+ "kind": "Content",
4504
+ "text": ";"
4505
+ }
4506
+ ],
4507
+ "isReadonly": false,
4508
+ "isOptional": true,
4509
+ "releaseTag": "Public",
4510
+ "name": "playerId",
4511
+ "propertyTypeTokenRange": {
4512
+ "startIndex": 1,
4513
+ "endIndex": 2
4514
+ }
4488
4515
  }
4489
4516
  ],
4490
4517
  "extendsTokenRanges": []
@@ -22611,7 +22638,16 @@
22611
22638
  "excerptTokens": [
22612
22639
  {
22613
22640
  "kind": "Content",
22614
- "text": "export default class Player "
22641
+ "text": "export default class Player implements "
22642
+ },
22643
+ {
22644
+ "kind": "Reference",
22645
+ "text": "protocol.Serializable",
22646
+ "canonicalReference": "@hytopia.com/server-protocol!Serializable:interface"
22647
+ },
22648
+ {
22649
+ "kind": "Content",
22650
+ "text": " "
22615
22651
  }
22616
22652
  ],
22617
22653
  "fileUrlPath": "src/players/Player.ts",
@@ -22950,7 +22986,12 @@
22950
22986
  "isAbstract": false
22951
22987
  }
22952
22988
  ],
22953
- "implementsTokenRanges": []
22989
+ "implementsTokenRanges": [
22990
+ {
22991
+ "startIndex": 1,
22992
+ "endIndex": 2
22993
+ }
22994
+ ]
22954
22995
  },
22955
22996
  {
22956
22997
  "kind": "Class",
@@ -25482,6 +25523,37 @@
25482
25523
  }
25483
25524
  ]
25484
25525
  },
25526
+ {
25527
+ "kind": "Property",
25528
+ "canonicalReference": "server!PlayerEntity#nametagSceneUI:member",
25529
+ "docComment": "/**\n * The SceneUI instance for the player entity's nametag.\n */\n",
25530
+ "excerptTokens": [
25531
+ {
25532
+ "kind": "Content",
25533
+ "text": "readonly nametagSceneUI: "
25534
+ },
25535
+ {
25536
+ "kind": "Reference",
25537
+ "text": "SceneUI",
25538
+ "canonicalReference": "server!SceneUI:class"
25539
+ },
25540
+ {
25541
+ "kind": "Content",
25542
+ "text": ";"
25543
+ }
25544
+ ],
25545
+ "isReadonly": true,
25546
+ "isOptional": false,
25547
+ "releaseTag": "Public",
25548
+ "name": "nametagSceneUI",
25549
+ "propertyTypeTokenRange": {
25550
+ "startIndex": 1,
25551
+ "endIndex": 2
25552
+ },
25553
+ "isStatic": false,
25554
+ "isProtected": false,
25555
+ "isAbstract": false
25556
+ },
25485
25557
  {
25486
25558
  "kind": "Property",
25487
25559
  "canonicalReference": "server!PlayerEntity#player:member",
package/server.d.ts CHANGED
@@ -570,6 +570,7 @@ export declare namespace ChatEventPayload {
570
570
  export interface SendBroadcastMessage {
571
571
  message: string;
572
572
  color?: string;
573
+ playerId?: string;
573
574
  }
574
575
  export interface SendPlayerMessage {
575
576
  player: Player;
@@ -2922,7 +2923,7 @@ export declare type PathfindingOptions = {
2922
2923
  *
2923
2924
  * @public
2924
2925
  */
2925
- export declare class Player {
2926
+ export declare class Player implements protocol.Serializable {
2926
2927
  /** The unique HYTOPIA UUID for the player. */
2927
2928
  readonly id: string;
2928
2929
  /** The unique HYTOPIA username for the player. */
@@ -2965,6 +2966,7 @@ export declare class Player {
2965
2966
 
2966
2967
 
2967
2968
 
2969
+
2968
2970
  }
2969
2971
 
2970
2972
  /**
@@ -3225,11 +3227,14 @@ export declare type PlayerCameraOrientation = {
3225
3227
  export declare class PlayerEntity extends Entity {
3226
3228
  /** The player the player entity is assigned to and controlled by. */
3227
3229
  readonly player: Player;
3230
+ /** The SceneUI instance for the player entity's nametag. */
3231
+ readonly nametagSceneUI: SceneUI;
3228
3232
  /**
3229
3233
  * @param options - The options for the player entity.
3230
3234
  */
3231
3235
  constructor(options: PlayerEntityOptions);
3232
3236
 
3237
+
3233
3238
  }
3234
3239
 
3235
3240
  /**