hytopia 0.1.0 → 0.1.2

package/docs/server.hytopia.player.disconnect.md

@@ -0,0 +1,17 @@
+<!-- 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; [Player](./server.hytopia.player.md) &gt; [disconnect](./server.hytopia.player.disconnect.md)
+
+## HYTOPIA.Player.disconnect() method
+
+Disconnects the player from the game server.
+
+**Signature:**
+
+```typescript
+disconnect(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.hytopia.player.id.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; [Player](./server.hytopia.player.md) &gt; [id](./server.hytopia.player.id.md)
+
+## HYTOPIA.Player.id property
+
+The unique identifier for the player.
+
+**Signature:**
+
+```typescript
+readonly id: number;
+```

package/docs/server.hytopia.player.inputstate.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; [Player](./server.hytopia.player.md) &gt; [inputState](./server.hytopia.player.inputstate.md)
+
+## HYTOPIA.Player.inputState property
+
+The current [PlayerInputState](./server.playerinputstate.md) of the player.
+
+**Signature:**
+
+```typescript
+get inputState(): Readonly<PlayerInputState>;
+```

package/docs/server.hytopia.player.joinworld.md

@@ -0,0 +1,57 @@
+<!-- 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; [Player](./server.hytopia.player.md) &gt; [joinWorld](./server.hytopia.player.joinworld.md)
+
+## HYTOPIA.Player.joinWorld() method
+
+Joins a player to a world.
+
+**Signature:**
+
+```typescript
+joinWorld(world: World): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world to join the player to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+If the player is already in a [World](./server.world.md)<!-- -->, they will be removed from their current world before joining the new world.
+

package/docs/server.hytopia.player.leaveworld.md

@@ -0,0 +1,17 @@
+<!-- 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; [Player](./server.hytopia.player.md) &gt; [leaveWorld](./server.hytopia.player.leaveworld.md)
+
+## HYTOPIA.Player.leaveWorld() method
+
+Removes the player from the current [World](./server.world.md) they are in.
+
+**Signature:**
+
+```typescript
+leaveWorld(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.hytopia.player.md

@@ -0,0 +1,211 @@
+<!-- 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; [Player](./server.hytopia.player.md)
+
+## HYTOPIA.Player class
+
+A player in the game.
+
+**Signature:**
+
+```typescript
+export default class Player 
+```
+
+## Remarks
+
+Players are automatically created when they connect and authenticate with the game server. This is all handled internally.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Player` class.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[id](./server.hytopia.player.id.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The unique identifier for the player.
+
+
+</td></tr>
+<tr><td>
+
+[inputState](./server.hytopia.player.inputstate.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Readonly&lt;[PlayerInputState](./server.playerinputstate.md)<!-- -->&gt;
+
+
+</td><td>
+
+The current [PlayerInputState](./server.playerinputstate.md) of the player.
+
+
+</td></tr>
+<tr><td>
+
+[orientationState](./server.hytopia.player.orientationstate.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Readonly&lt;[PlayerOrientationState](./server.playerorientationstate.md)<!-- -->&gt;
+
+
+</td><td>
+
+The current [PlayerOrientationState](./server.playerorientationstate.md) of the player.
+
+
+</td></tr>
+<tr><td>
+
+[username](./server.hytopia.player.username.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The username for the player.
+
+
+</td></tr>
+<tr><td>
+
+[world](./server.hytopia.player.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md) \| undefined
+
+
+</td><td>
+
+The current [World](./server.world.md) the player is in.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[disconnect()](./server.hytopia.player.disconnect.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Disconnects the player from the game server.
+
+
+</td></tr>
+<tr><td>
+
+[joinWorld(world)](./server.hytopia.player.joinworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Joins a player to a world.
+
+
+</td></tr>
+<tr><td>
+
+[leaveWorld()](./server.hytopia.player.leaveworld.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes the player from the current [World](./server.world.md) they are in.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.player.orientationstate.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; [Player](./server.hytopia.player.md) &gt; [orientationState](./server.hytopia.player.orientationstate.md)
+
+## HYTOPIA.Player.orientationState property
+
+The current [PlayerOrientationState](./server.playerorientationstate.md) of the player.
+
+**Signature:**
+
+```typescript
+get orientationState(): Readonly<PlayerOrientationState>;
+```

package/docs/server.hytopia.player.username.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; [Player](./server.hytopia.player.md) &gt; [username](./server.hytopia.player.username.md)
+
+## HYTOPIA.Player.username property
+
+The username for the player.
+
+**Signature:**
+
+```typescript
+readonly username: string;
+```

package/docs/server.hytopia.player.world.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; [Player](./server.hytopia.player.md) &gt; [world](./server.hytopia.player.world.md)
+
+## HYTOPIA.Player.world property
+
+The current [World](./server.world.md) the player is in.
+
+**Signature:**
+
+```typescript
+get world(): World | undefined;
+```

package/docs/server.hytopia.playerentity._constructor_.md

@@ -0,0 +1,49 @@
+<!-- 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; [PlayerEntity](./server.hytopia.playerentity.md) &gt; [(constructor)](./server.hytopia.playerentity._constructor_.md)
+
+## HYTOPIA.PlayerEntity.(constructor)
+
+Constructs a new instance of the `PlayerEntity` class
+
+**Signature:**
+
+```typescript
+constructor(options: PlayerEntityOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[PlayerEntityOptions](./server.playerentityoptions.md)
+
+
+</td><td>
+
+The options for the player entity.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playerentity.md

@@ -0,0 +1,115 @@
+<!-- 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; [PlayerEntity](./server.hytopia.playerentity.md)
+
+## HYTOPIA.PlayerEntity class
+
+Represents an entity controlled by a player in a world.
+
+**Signature:**
+
+```typescript
+export default class PlayerEntity extends Entity 
+```
+**Extends:** [Entity](./server.entity.md)
+
+## Remarks
+
+Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated character controller of the entity, calling the character controller's onTickPlayerMovement method when player input has changed.
+
+## Example
+
+
+```typescript
+world.onPlayerJoin = player => {
+  const playerEntity = new PlayerEntity({
+    player,
+    name: 'Player',
+    modelUri: 'models/player-with-gun.gltf',
+    modelLoopedAnimations: [ 'idle' ],
+    modelScale: 0.5,
+  });
+
+  playerEntity.spawn(world, { x: 10, y: 20, z: 15 });
+};
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.hytopia.playerentity._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `PlayerEntity` 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>
+
+[player](./server.hytopia.playerentity.player.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player the player entity is assigned to and controlled by.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playerentity.player.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; [PlayerEntity](./server.hytopia.playerentity.md) &gt; [player](./server.hytopia.playerentity.player.md)
+
+## HYTOPIA.PlayerEntity.player property
+
+The player the player entity is assigned to and controlled by.
+
+**Signature:**
+
+```typescript
+readonly player: Player;
+```

package/docs/server.hytopia.playerentityoptions.md

@@ -0,0 +1,58 @@
+<!-- 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; [PlayerEntityOptions](./server.hytopia.playerentityoptions.md)
+
+## HYTOPIA.PlayerEntityOptions interface
+
+Options for creating a PlayerEntity instance.
+
+**Signature:**
+
+```typescript
+export interface PlayerEntityOptions extends EntityOptions 
+```
+**Extends:** [EntityOptions](./server.entityoptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[player](./server.hytopia.playerentityoptions.player.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player the player entity is assigned to.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playerentityoptions.player.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; [PlayerEntityOptions](./server.hytopia.playerentityoptions.md) &gt; [player](./server.hytopia.playerentityoptions.player.md)
+
+## HYTOPIA.PlayerEntityOptions.player property
+
+The player the player entity is assigned to.
+
+**Signature:**
+
+```typescript
+player: Player;
+```

package/docs/server.hytopia.playereventpayload.chatmessagesend.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; [ChatMessageSend](./server.hytopia.playereventpayload.chatmessagesend.md)
+
+## HYTOPIA.PlayerEventPayload.ChatMessageSend interface
+
+**Signature:**
+
+```typescript
+interface ChatMessageSend 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[message](./server.hytopia.playereventpayload.chatmessagesend.message.md)
+
+
+</td><td>
+
+
+</td><td>
+
+protocol.ChatMessageSchema
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[player](./server.hytopia.playereventpayload.chatmessagesend.player.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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