hytopia 0.6.22 → 0.6.24

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hytopia",
3
- "version": "0.6.22",
3
+ "version": "0.6.24",
4
4
  "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
5
5
  "type": "module",
6
6
  "main": "./node-server.mjs",
package/server.api.json CHANGED
@@ -29098,69 +29098,6 @@
29098
29098
  "isAbstract": false,
29099
29099
  "name": "getGlobalData"
29100
29100
  },
29101
- {
29102
- "kind": "Method",
29103
- "canonicalReference": "server!PersistenceManager#getPlayerData:member(1)",
29104
- "docComment": "/**\n * Get player data from the data persistence service.\n *\n * @param player - The player to get the data from.\n *\n * @returns The data from the persistence layer.\n */\n",
29105
- "excerptTokens": [
29106
- {
29107
- "kind": "Content",
29108
- "text": "getPlayerData(player: "
29109
- },
29110
- {
29111
- "kind": "Reference",
29112
- "text": "Player",
29113
- "canonicalReference": "server!Player:class"
29114
- },
29115
- {
29116
- "kind": "Content",
29117
- "text": "): "
29118
- },
29119
- {
29120
- "kind": "Reference",
29121
- "text": "Promise",
29122
- "canonicalReference": "!Promise:interface"
29123
- },
29124
- {
29125
- "kind": "Content",
29126
- "text": "<"
29127
- },
29128
- {
29129
- "kind": "Reference",
29130
- "text": "Record",
29131
- "canonicalReference": "!Record:type"
29132
- },
29133
- {
29134
- "kind": "Content",
29135
- "text": "<string, unknown> | void>"
29136
- },
29137
- {
29138
- "kind": "Content",
29139
- "text": ";"
29140
- }
29141
- ],
29142
- "isStatic": false,
29143
- "returnTypeTokenRange": {
29144
- "startIndex": 3,
29145
- "endIndex": 7
29146
- },
29147
- "releaseTag": "Public",
29148
- "isProtected": false,
29149
- "overloadIndex": 1,
29150
- "parameters": [
29151
- {
29152
- "parameterName": "player",
29153
- "parameterTypeTokenRange": {
29154
- "startIndex": 1,
29155
- "endIndex": 2
29156
- },
29157
- "isOptional": false
29158
- }
29159
- ],
29160
- "isOptional": false,
29161
- "isAbstract": false,
29162
- "name": "getPlayerData"
29163
- },
29164
29101
  {
29165
29102
  "kind": "Property",
29166
29103
  "canonicalReference": "server!PersistenceManager.instance:member",
@@ -29274,90 +29211,6 @@
29274
29211
  "isOptional": false,
29275
29212
  "isAbstract": false,
29276
29213
  "name": "setGlobalData"
29277
- },
29278
- {
29279
- "kind": "Method",
29280
- "canonicalReference": "server!PersistenceManager#setPlayerData:member(1)",
29281
- "docComment": "/**\n * Set player data in the data persistence service. This data is persisted even after a player disconnects, and is retrievable no matter the lobby for your game that they join.\n *\n * @param player - The player to set the data to.\n *\n * @param data - The data to set.\n */\n",
29282
- "excerptTokens": [
29283
- {
29284
- "kind": "Content",
29285
- "text": "setPlayerData(player: "
29286
- },
29287
- {
29288
- "kind": "Reference",
29289
- "text": "Player",
29290
- "canonicalReference": "server!Player:class"
29291
- },
29292
- {
29293
- "kind": "Content",
29294
- "text": ", data: "
29295
- },
29296
- {
29297
- "kind": "Reference",
29298
- "text": "Record",
29299
- "canonicalReference": "!Record:type"
29300
- },
29301
- {
29302
- "kind": "Content",
29303
- "text": "<string, unknown>"
29304
- },
29305
- {
29306
- "kind": "Content",
29307
- "text": "): "
29308
- },
29309
- {
29310
- "kind": "Reference",
29311
- "text": "Promise",
29312
- "canonicalReference": "!Promise:interface"
29313
- },
29314
- {
29315
- "kind": "Content",
29316
- "text": "<"
29317
- },
29318
- {
29319
- "kind": "Reference",
29320
- "text": "Record",
29321
- "canonicalReference": "!Record:type"
29322
- },
29323
- {
29324
- "kind": "Content",
29325
- "text": "<string, unknown> | void>"
29326
- },
29327
- {
29328
- "kind": "Content",
29329
- "text": ";"
29330
- }
29331
- ],
29332
- "isStatic": false,
29333
- "returnTypeTokenRange": {
29334
- "startIndex": 6,
29335
- "endIndex": 10
29336
- },
29337
- "releaseTag": "Public",
29338
- "isProtected": false,
29339
- "overloadIndex": 1,
29340
- "parameters": [
29341
- {
29342
- "parameterName": "player",
29343
- "parameterTypeTokenRange": {
29344
- "startIndex": 1,
29345
- "endIndex": 2
29346
- },
29347
- "isOptional": false
29348
- },
29349
- {
29350
- "parameterName": "data",
29351
- "parameterTypeTokenRange": {
29352
- "startIndex": 3,
29353
- "endIndex": 5
29354
- },
29355
- "isOptional": false
29356
- }
29357
- ],
29358
- "isOptional": false,
29359
- "isAbstract": false,
29360
- "name": "setPlayerData"
29361
29214
  }
29362
29215
  ],
29363
29216
  "implementsTokenRanges": []
@@ -29461,21 +29314,12 @@
29461
29314
  {
29462
29315
  "kind": "Method",
29463
29316
  "canonicalReference": "server!Player#getPersistedData:member(1)",
29464
- "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method is asynchronous and returns a promise that resolves to the player data.\n *\n * @returns The persisted data for the player.\n */\n",
29317
+ "docComment": "/**\n * Get the persisted data for the player.\n *\n * @remarks\n *\n * This method returns the player persisted data.\n *\n * @returns The persisted data for the player.\n */\n",
29465
29318
  "excerptTokens": [
29466
29319
  {
29467
29320
  "kind": "Content",
29468
29321
  "text": "getPersistedData(): "
29469
29322
  },
29470
- {
29471
- "kind": "Reference",
29472
- "text": "Promise",
29473
- "canonicalReference": "!Promise:interface"
29474
- },
29475
- {
29476
- "kind": "Content",
29477
- "text": "<"
29478
- },
29479
29323
  {
29480
29324
  "kind": "Reference",
29481
29325
  "text": "Record",
@@ -29483,7 +29327,7 @@
29483
29327
  },
29484
29328
  {
29485
29329
  "kind": "Content",
29486
- "text": "<string, unknown> | void>"
29330
+ "text": "<string, unknown> | undefined"
29487
29331
  },
29488
29332
  {
29489
29333
  "kind": "Content",
@@ -29493,7 +29337,7 @@
29493
29337
  "isStatic": false,
29494
29338
  "returnTypeTokenRange": {
29495
29339
  "startIndex": 1,
29496
- "endIndex": 5
29340
+ "endIndex": 3
29497
29341
  },
29498
29342
  "releaseTag": "Public",
29499
29343
  "isProtected": false,
@@ -29696,15 +29540,6 @@
29696
29540
  "kind": "Content",
29697
29541
  "text": "): "
29698
29542
  },
29699
- {
29700
- "kind": "Reference",
29701
- "text": "Promise",
29702
- "canonicalReference": "!Promise:interface"
29703
- },
29704
- {
29705
- "kind": "Content",
29706
- "text": "<"
29707
- },
29708
29543
  {
29709
29544
  "kind": "Reference",
29710
29545
  "text": "Record",
@@ -29712,7 +29547,7 @@
29712
29547
  },
29713
29548
  {
29714
29549
  "kind": "Content",
29715
- "text": "<string, unknown> | void>"
29550
+ "text": "<string, unknown>"
29716
29551
  },
29717
29552
  {
29718
29553
  "kind": "Content",
@@ -29722,7 +29557,7 @@
29722
29557
  "isStatic": false,
29723
29558
  "returnTypeTokenRange": {
29724
29559
  "startIndex": 4,
29725
- "endIndex": 8
29560
+ "endIndex": 6
29726
29561
  },
29727
29562
  "releaseTag": "Public",
29728
29563
  "isProtected": false,
package/server.d.ts CHANGED
@@ -3713,12 +3713,7 @@ export declare class PersistenceManager {
3713
3713
  * @returns The data from the persistence layer.
3714
3714
  */
3715
3715
  getGlobalData(key: string): Promise<Record<string, unknown> | void>;
3716
- /**
3717
- * Get player data from the data persistence service.
3718
- * @param player - The player to get the data from.
3719
- * @returns The data from the persistence layer.
3720
- */
3721
- getPlayerData(player: Player): Promise<Record<string, unknown> | void>;
3716
+
3722
3717
  /**
3723
3718
  * Set global data in the data persistence service. This
3724
3719
  * data is available and shared by all lobbies of your game.
@@ -3726,15 +3721,7 @@ export declare class PersistenceManager {
3726
3721
  * @param data - The data to set.
3727
3722
  */
3728
3723
  setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
3729
- /**
3730
- * Set player data in the data persistence service. This
3731
- * data is persisted even after a player disconnects, and
3732
- * is retrievable no matter the lobby for your game that
3733
- * they join.
3734
- * @param player - The player to set the data to.
3735
- * @param data - The data to set.
3736
- */
3737
- setPlayerData(player: Player, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
3724
+
3738
3725
 
3739
3726
  }
3740
3727
 
@@ -3771,6 +3758,7 @@ export declare class Player extends EventRouter implements protocol.Serializable
3771
3758
 
3772
3759
 
3773
3760
 
3761
+
3774
3762
  /** The current {@link PlayerInput} of the player. */
3775
3763
  get input(): PlayerInput;
3776
3764
  /** The current {@link World} the player is in. */
@@ -3783,12 +3771,11 @@ export declare class Player extends EventRouter implements protocol.Serializable
3783
3771
  * Get the persisted data for the player.
3784
3772
  *
3785
3773
  * @remarks
3786
- * This method is asynchronous and returns a promise that
3787
- * resolves to the player data.
3774
+ * This method returns the player persisted data.
3788
3775
  *
3789
3776
  * @returns The persisted data for the player.
3790
3777
  */
3791
- getPersistedData(): Promise<Record<string, unknown> | void>;
3778
+ getPersistedData(): Record<string, unknown> | undefined;
3792
3779
  /**
3793
3780
  * Joins a player to a world.
3794
3781
  *
@@ -3801,6 +3788,7 @@ export declare class Player extends EventRouter implements protocol.Serializable
3801
3788
  */
3802
3789
  joinWorld(world: World): void;
3803
3790
 
3791
+
3804
3792
  /**
3805
3793
  * Resets all inputs keys
3806
3794
  */
@@ -3818,7 +3806,7 @@ export declare class Player extends EventRouter implements protocol.Serializable
3818
3806
  * @param data - The data to set.
3819
3807
  * @returns The persisted data for the player.
3820
3808
  */
3821
- setPersistedData(data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
3809
+ setPersistedData(data: Record<string, unknown>): Record<string, unknown>;
3822
3810
 
3823
3811
 
3824
3812
 
@@ -1,55 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [getPlayerData](./server.persistencemanager.getplayerdata.md)
4
-
5
- ## PersistenceManager.getPlayerData() method
6
-
7
- Get player data from the data persistence service.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- getPlayerData(player: Player): Promise<Record<string, unknown> | void>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- player
36
-
37
-
38
- </td><td>
39
-
40
- [Player](./server.player.md)
41
-
42
-
43
- </td><td>
44
-
45
- The player to get the data from.
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
50
- **Returns:**
51
-
52
- Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
53
-
54
- The data from the persistence layer.
55
-
@@ -1,69 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [setPlayerData](./server.persistencemanager.setplayerdata.md)
4
-
5
- ## PersistenceManager.setPlayerData() method
6
-
7
- Set player data in the data persistence service. This data is persisted even after a player disconnects, and is retrievable no matter the lobby for your game that they join.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- setPlayerData(player: Player, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- player
36
-
37
-
38
- </td><td>
39
-
40
- [Player](./server.player.md)
41
-
42
-
43
- </td><td>
44
-
45
- The player to set the data to.
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- data
52
-
53
-
54
- </td><td>
55
-
56
- Record&lt;string, unknown&gt;
57
-
58
-
59
- </td><td>
60
-
61
- The data to set.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
66
- **Returns:**
67
-
68
- Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
69
-