hytopia 0.3.1 → 0.3.3

package/docs/server.md

@@ -247,6 +247,17 @@ Manages model data for all known models of the game.
 A pathfinding entity controller built on top of [SimpleEntityController](./server.simpleentitycontroller.md)<!-- -->.
 
 
+</td></tr>
+<tr><td>
+
+[PersistenceManager](./server.persistencemanager.md)
+
+
+</td><td>
+
+Manages persistence of player and global data.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.persistencemanager.getglobaldata.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [getGlobalData](./server.persistencemanager.getglobaldata.md)
+
+## PersistenceManager.getGlobalData() method
+
+Get global data from the data persistence service.
+
+**Signature:**
+
+```typescript
+getGlobalData(key: string): Promise<Record<string, unknown> | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+key
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The key to get the data from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+
+The data from the persistence layer.
+

package/docs/server.persistencemanager.getplayerdata.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [getPlayerData](./server.persistencemanager.getplayerdata.md)
+
+## PersistenceManager.getPlayerData() method
+
+Get player data from the data persistence service.
+
+**Signature:**
+
+```typescript
+getPlayerData(player: Player): Promise<Record<string, unknown> | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player to get the data from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+
+The data from the persistence layer.
+

package/docs/server.persistencemanager.instance.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [instance](./server.persistencemanager.instance.md)
+
+## PersistenceManager.instance property
+
+**Signature:**
+
+```typescript
+static readonly instance: PersistenceManager;
+```

package/docs/server.persistencemanager.md

@@ -0,0 +1,139 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md)
+
+## PersistenceManager class
+
+Manages persistence of player and global data.
+
+**Signature:**
+
+```typescript
+export default class PersistenceManager 
+```
+
+## Remarks
+
+This class is a singleton accessible with the static property `PersistenceManager.instance`<!-- -->. Convenience methods are also available on the `Player` and `GameServer` classes.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[instance](./server.persistencemanager.instance.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+[PersistenceManager](./server.persistencemanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getGlobalData(key)](./server.persistencemanager.getglobaldata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get global data from the data persistence service.
+
+
+</td></tr>
+<tr><td>
+
+[getPlayerData(player)](./server.persistencemanager.getplayerdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get player data from the data persistence service.
+
+
+</td></tr>
+<tr><td>
+
+[setGlobalData(key, data)](./server.persistencemanager.setglobaldata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set global data in the data persistence service. This data is available and shared by all lobbies of your game.
+
+
+</td></tr>
+<tr><td>
+
+[setPlayerData(player, data)](./server.persistencemanager.setplayerdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.persistencemanager.setglobaldata.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [setGlobalData](./server.persistencemanager.setglobaldata.md)
+
+## PersistenceManager.setGlobalData() method
+
+Set global data in the data persistence service. This data is available and shared by all lobbies of your game.
+
+**Signature:**
+
+```typescript
+setGlobalData(key: string, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+key
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The key to set the data to.
+
+
+</td></tr>
+<tr><td>
+
+data
+
+
+</td><td>
+
+Record&lt;string, unknown&gt;
+
+
+</td><td>
+
+The data to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+

package/docs/server.persistencemanager.setplayerdata.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PersistenceManager](./server.persistencemanager.md) &gt; [setPlayerData](./server.persistencemanager.setplayerdata.md)
+
+## PersistenceManager.setPlayerData() method
+
+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.
+
+**Signature:**
+
+```typescript
+setPlayerData(player: Player, data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player to set the data to.
+
+
+</td></tr>
+<tr><td>
+
+data
+
+
+</td><td>
+
+Record&lt;string, unknown&gt;
+
+
+</td><td>
+
+The data to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+

package/docs/server.player.getpersisteddata.md

@@ -0,0 +1,23 @@
+<!-- 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; [getPersistedData](./server.player.getpersisteddata.md)
+
+## Player.getPersistedData() method
+
+Get the persisted data for the player.
+
+**Signature:**
+
+```typescript
+getPersistedData(): Promise<Record<string, unknown> | void>;
+```
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+
+The persisted data for the player.
+
+## Remarks
+
+This method is asynchronous and returns a promise that resolves to the player data.
+

package/docs/server.player.md

@@ -228,6 +228,20 @@ Description
 Disconnects the player from the game server.
 
 
+</td></tr>
+<tr><td>
+
+[getPersistedData()](./server.player.getpersisteddata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the persisted data for the player.
+
+
 </td></tr>
 <tr><td>
 
@@ -256,5 +270,19 @@ Joins a player to a world.
 Removes the player from the current [World](./server.world.md) they are in.
 
 
+</td></tr>
+<tr><td>
+
+[setPersistedData(data)](./server.player.setpersisteddata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set the persisted data for the player. This data can later be retrieved using [Player.getPersistedData()](./server.player.getpersisteddata.md)<!-- -->, even if a player disconnects and rejoin a game in the future, or joins a different HYTOPIA managed lobby of your game.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.player.setpersisteddata.md

@@ -0,0 +1,59 @@
+<!-- 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; [setPersistedData](./server.player.setpersisteddata.md)
+
+## Player.setPersistedData() method
+
+Set the persisted data for the player. This data can later be retrieved using [Player.getPersistedData()](./server.player.getpersisteddata.md)<!-- -->, even if a player disconnects and rejoin a game in the future, or joins a different HYTOPIA managed lobby of your game.
+
+**Signature:**
+
+```typescript
+setPersistedData(data: Record<string, unknown>): Promise<Record<string, unknown> | void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+data
+
+
+</td><td>
+
+Record&lt;string, unknown&gt;
+
+
+</td><td>
+
+The data to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;Record&lt;string, unknown&gt; \| void&gt;
+
+The persisted data for the player.
+
+## Remarks
+
+This method is asynchronous and returns a promise that resolves to the player data.
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {