hytopia 0.1.1 → 0.1.3

package/docs/server.hytopia.playereventpayload.chatmessagesend.player.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [ChatMessageSend](./server.hytopia.playereventpayload.chatmessagesend.md) &gt; [player](./server.hytopia.playereventpayload.chatmessagesend.player.md)
+
+## HYTOPIA.PlayerEventPayload.ChatMessageSend.player property
+
+**Signature:**
+
+```typescript
+player: Player;
+```

package/docs/server.hytopia.playereventpayload.joinedworld.md

@@ -0,0 +1,70 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [JoinedWorld](./server.hytopia.playereventpayload.joinedworld.md)
+
+## HYTOPIA.PlayerEventPayload.JoinedWorld interface
+
+**Signature:**
+
+```typescript
+interface JoinedWorld 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[player](./server.hytopia.playereventpayload.joinedworld.player.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[world](./server.hytopia.playereventpayload.joinedworld.world.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playereventpayload.joinedworld.player.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [JoinedWorld](./server.hytopia.playereventpayload.joinedworld.md) &gt; [player](./server.hytopia.playereventpayload.joinedworld.player.md)
+
+## HYTOPIA.PlayerEventPayload.JoinedWorld.player property
+
+**Signature:**
+
+```typescript
+player: Player;
+```

package/docs/server.hytopia.playereventpayload.joinedworld.world.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [JoinedWorld](./server.hytopia.playereventpayload.joinedworld.md) &gt; [world](./server.hytopia.playereventpayload.joinedworld.world.md)
+
+## HYTOPIA.PlayerEventPayload.JoinedWorld.world property
+
+**Signature:**
+
+```typescript
+world: World;
+```

package/docs/server.hytopia.playereventpayload.leftworld.md

@@ -0,0 +1,70 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [LeftWorld](./server.hytopia.playereventpayload.leftworld.md)
+
+## HYTOPIA.PlayerEventPayload.LeftWorld interface
+
+**Signature:**
+
+```typescript
+interface LeftWorld 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[player](./server.hytopia.playereventpayload.leftworld.player.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[world](./server.hytopia.playereventpayload.leftworld.world.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playereventpayload.leftworld.player.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [LeftWorld](./server.hytopia.playereventpayload.leftworld.md) &gt; [player](./server.hytopia.playereventpayload.leftworld.player.md)
+
+## HYTOPIA.PlayerEventPayload.LeftWorld.player property
+
+**Signature:**
+
+```typescript
+player: Player;
+```

package/docs/server.hytopia.playereventpayload.leftworld.world.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [LeftWorld](./server.hytopia.playereventpayload.leftworld.md) &gt; [world](./server.hytopia.playereventpayload.leftworld.world.md)
+
+## HYTOPIA.PlayerEventPayload.LeftWorld.world property
+
+**Signature:**
+
+```typescript
+world: World;
+```

package/docs/server.hytopia.playereventpayload.md

@@ -0,0 +1,64 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md)
+
+## HYTOPIA.PlayerEventPayload namespace
+
+Payloads for events a Player can emit.
+
+**Signature:**
+
+```typescript
+export declare namespace PlayerEventPayload 
+```
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[ChatMessageSend](./server.hytopia.playereventpayload.chatmessagesend.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[JoinedWorld](./server.hytopia.playereventpayload.joinedworld.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[LeftWorld](./server.hytopia.playereventpayload.leftworld.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[RequestSync](./server.hytopia.playereventpayload.requestsync.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playereventpayload.requestsync.md

@@ -0,0 +1,87 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [RequestSync](./server.hytopia.playereventpayload.requestsync.md)
+
+## HYTOPIA.PlayerEventPayload.RequestSync interface
+
+**Signature:**
+
+```typescript
+interface RequestSync 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[player](./server.hytopia.playereventpayload.requestsync.player.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[receivedAt](./server.hytopia.playereventpayload.requestsync.receivedat.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[receivedAtMs](./server.hytopia.playereventpayload.requestsync.receivedatms.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playereventpayload.requestsync.player.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [RequestSync](./server.hytopia.playereventpayload.requestsync.md) &gt; [player](./server.hytopia.playereventpayload.requestsync.player.md)
+
+## HYTOPIA.PlayerEventPayload.RequestSync.player property
+
+**Signature:**
+
+```typescript
+player: Player;
+```

package/docs/server.hytopia.playereventpayload.requestsync.receivedat.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [RequestSync](./server.hytopia.playereventpayload.requestsync.md) &gt; [receivedAt](./server.hytopia.playereventpayload.requestsync.receivedat.md)
+
+## HYTOPIA.PlayerEventPayload.RequestSync.receivedAt property
+
+**Signature:**
+
+```typescript
+receivedAt: number;
+```

package/docs/server.hytopia.playereventpayload.requestsync.receivedatms.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventPayload](./server.hytopia.playereventpayload.md) &gt; [RequestSync](./server.hytopia.playereventpayload.requestsync.md) &gt; [receivedAtMs](./server.hytopia.playereventpayload.requestsync.receivedatms.md)
+
+## HYTOPIA.PlayerEventPayload.RequestSync.receivedAtMs property
+
+**Signature:**
+
+```typescript
+receivedAtMs: number;
+```

package/docs/server.hytopia.playereventtype.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerEventType](./server.hytopia.playereventtype.md)
+
+## HYTOPIA.PlayerEventType enum
+
+Event types a Player can emit.
+
+**Signature:**
+
+```typescript
+export declare enum PlayerEventType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+CHAT\_MESSAGE\_SEND
+
+
+</td><td>
+
+`"PLAYER.CHAT_MESSAGE_SEND"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+JOINED\_WORLD
+
+
+</td><td>
+
+`"PLAYER.JOINED_WORLD"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LEFT\_WORLD
+
+
+</td><td>
+
+`"PLAYER.LEFT_WORLD"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+REQUEST\_SYNC
+
+
+</td><td>
+
+`"PLAYER.REQUEST_SYNC"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playerinputstate.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerInputState](./server.hytopia.playerinputstate.md)
+
+## HYTOPIA.PlayerInputState type
+
+The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
+
+**Signature:**
+
+```typescript
+export type PlayerInputState = Partial<Record<keyof InputSchema, boolean>>;
+```

package/docs/server.hytopia.playermanager.getconnectedplayerbyusername.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerManager](./server.hytopia.playermanager.md) &gt; [getConnectedPlayerByUsername](./server.hytopia.playermanager.getconnectedplayerbyusername.md)
+
+## HYTOPIA.PlayerManager.getConnectedPlayerByUsername() method
+
+Get a connected player by their username (case insensitive).
+
+**Signature:**
+
+```typescript
+getConnectedPlayerByUsername(username: string): Player | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+username
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The username of the player to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Player](./server.player.md) \| undefined
+
+The connected player with the given username or undefined if not found.
+

package/docs/server.hytopia.playermanager.getconnectedplayers.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [PlayerManager](./server.hytopia.playermanager.md) &gt; [getConnectedPlayers](./server.hytopia.playermanager.getconnectedplayers.md)
+
+## HYTOPIA.PlayerManager.getConnectedPlayers() method
+
+Get all connected players.
+
+**Signature:**
+
+```typescript
+getConnectedPlayers(): Player[];
+```
+**Returns:**
+
+[Player](./server.player.md)<!-- -->\[\]
+
+An array of all connected players.
+

package/docs/server.hytopia.playermanager.instance.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerManager](./server.hytopia.playermanager.md) &gt; [instance](./server.hytopia.playermanager.instance.md)
+
+## HYTOPIA.PlayerManager.instance property
+
+The global PlayerManager instance as a singleton.
+
+**Signature:**
+
+```typescript
+static readonly instance: PlayerManager;
+```