hytopia 0.1.31 → 0.1.33

package/docs/server.hytopia.playercameraeventtype.md

@@ -0,0 +1,215 @@
+<!-- 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; [PlayerCameraEventType](./server.hytopia.playercameraeventtype.md)
+
+## HYTOPIA.PlayerCameraEventType enum
+
+Event types a PlayerCamera can emit.
+
+**Signature:**
+
+```typescript
+export declare enum PlayerCameraEventType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+LOOK\_AT\_ENTITY
+
+
+</td><td>
+
+`"PLAYER_CAMERA.LOOK_AT_ENTITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOOK\_AT\_POSITION
+
+
+</td><td>
+
+`"PLAYER_CAMERA.LOOK_AT_POSITION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_ATTACHED\_TO\_ENTITY
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_ATTACHED_TO_ENTITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_ATTACHED\_TO\_POSITION
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_ATTACHED_TO_POSITION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_FILM\_OFFSET
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_FILM_OFFSET"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_FORWARD\_OFFSET
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_FORWARD_OFFSET"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_FOV
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_FOV"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_HIDDEN\_MODEL\_NODES
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_HIDDEN_MODEL_NODES"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_MODE
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_MODE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OFFSET
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_OFFSET"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_TRACKED\_ENTITY
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_TRACKED_ENTITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_TRACKED\_POSITION
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_TRACKED_POSITION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_ZOOM
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_ZOOM"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playercameramode.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerCameraMode](./server.hytopia.playercameramode.md)
+
+## HYTOPIA.PlayerCameraMode enum
+
+**Signature:**
+
+```typescript
+export declare enum PlayerCameraMode 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+FIRST\_PERSON
+
+
+</td><td>
+
+`0`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+THIRD\_PERSON
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.supported_input_keys.md

@@ -4,7 +4,7 @@
 
 ## HYTOPIA.SUPPORTED\_INPUT\_KEYS variable
 
-The input keys included in the PlayerInputState.
+The input keys that can be included in the PlayerInputState.
 
 **Signature:**
 

package/docs/server.md

@@ -192,6 +192,17 @@ Manages the game and associated worlds and systems.
 A player in the game.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCamera](./server.playercamera.md)
+
+
+</td><td>
+
+The camera for a Player.
+
+
 </td></tr>
 <tr><td>
 
@@ -409,6 +420,26 @@ Event types an Entity instance can emit.
 Event types a GameServer instance can emit.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCameraEventType](./server.playercameraeventtype.md)
+
+
+</td><td>
+
+Event types a PlayerCamera can emit.
+
+
+</td></tr>
+<tr><td>
+
+[PlayerCameraMode](./server.playercameramode.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -727,6 +758,17 @@ Payloads for events emitted by a GameServer instance.
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[PlayerCameraEventPayload](./server.playercameraeventpayload.md)
+
+
+</td><td>
+
+Payloads for events a PlayerCamera can emit.
+
+
 </td></tr>
 <tr><td>
 
@@ -794,7 +836,7 @@ The port the server will run on. You can override this in your .env by setting P
 
 </td><td>
 
-The input keys included in the PlayerInputState.
+The input keys that can be included in the PlayerInputState.
 
 
 </td></tr>

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

package/docs/server.player.md

@@ -43,6 +43,27 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[camera](./server.player.camera.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerCamera](./server.playercamera.md)
+
+
+</td><td>
+
+The camera for the player.
+
+
+</td></tr>
+<tr><td>
+
 [id](./server.player.id.md)
 
 

package/docs/server.playercamera.attachedtoentity.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; [PlayerCamera](./server.playercamera.md) &gt; [attachedToEntity](./server.playercamera.attachedtoentity.md)
+
+## PlayerCamera.attachedToEntity property
+
+The entity the camera is attached to.
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.playercamera.attachedtoposition.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; [PlayerCamera](./server.playercamera.md) &gt; [attachedToPosition](./server.playercamera.attachedtoposition.md)
+
+## PlayerCamera.attachedToPosition property
+
+The position the camera is attached to.
+
+**Signature:**
+
+```typescript
+get attachedToPosition(): Vector3 | undefined;
+```

package/docs/server.playercamera.filmoffset.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; [PlayerCamera](./server.playercamera.md) &gt; [filmOffset](./server.playercamera.filmoffset.md)
+
+## PlayerCamera.filmOffset property
+
+The film offset of the camera. A positive value shifts the camera right, a negative value shifts it left.
+
+**Signature:**
+
+```typescript
+get filmOffset(): number;
+```

package/docs/server.playercamera.forwardoffset.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; [PlayerCamera](./server.playercamera.md) &gt; [forwardOffset](./server.playercamera.forwardoffset.md)
+
+## PlayerCamera.forwardOffset property
+
+Only used in first-person mode. The forward offset of the camera. A positive number shifts the camera forward, a negative number shifts it backward.
+
+**Signature:**
+
+```typescript
+get forwardOffset(): number;
+```

package/docs/server.playercamera.fov.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; [PlayerCamera](./server.playercamera.md) &gt; [fov](./server.playercamera.fov.md)
+
+## PlayerCamera.fov property
+
+The field of view of the camera.
+
+**Signature:**
+
+```typescript
+get fov(): number;
+```

package/docs/server.playercamera.hiddenmodelnodes.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; [PlayerCamera](./server.playercamera.md) &gt; [hiddenModelNodes](./server.playercamera.hiddenmodelnodes.md)
+
+## PlayerCamera.hiddenModelNodes property
+
+The nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
+
+**Signature:**
+
+```typescript
+get hiddenModelNodes(): Set<string>;
+```

package/docs/server.playercamera.lookatentity.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [lookAtEntity](./server.playercamera.lookatentity.md)
+
+## PlayerCamera.lookAtEntity() method
+
+Makes the camera look at an entity. If the camera was previously tracking an entity or position, it will stop tracking.
+
+**Signature:**
+
+```typescript
+lookAtEntity(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to look at.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playercamera.lookatposition.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [lookAtPosition](./server.playercamera.lookatposition.md)
+
+## PlayerCamera.lookAtPosition() method
+
+Makes the camera look at a position. If the camera was previously tracking an entity or position, it will stop tracking.
+
+**Signature:**
+
+```typescript
+lookAtPosition(position: Vector3): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+position
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The position to look at.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+