hytopia 0.1.30 → 0.1.32

package/docs/server.hytopia.playercamera.md

@@ -0,0 +1,506 @@
+<!-- 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; [PlayerCamera](./server.hytopia.playercamera.md)
+
+## HYTOPIA.PlayerCamera class
+
+The camera for a Player.
+
+**Signature:**
+
+```typescript
+export default class PlayerCamera implements protocol.Serializable 
+```
+**Implements:** protocol.Serializable
+
+## Remarks
+
+The camera is used to render the player's view of the world. The player's camera exposes functionality to control the camera of a player. All player objects have a camera, accessible via [Player.camera](./server.player.camera.md)<!-- -->.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerCamera` class.
+
+## Example
+
+
+```typescript
+player.camera.setMode(PlayerCameraMode.FIRST_PERSON);
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attachedToEntity](./server.hytopia.playercamera.attachedtoentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+The entity the camera is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[attachedToPosition](./server.hytopia.playercamera.attachedtoposition.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.md) \| undefined
+
+
+</td><td>
+
+The position the camera is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[filmOffset](./server.hytopia.playercamera.filmoffset.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The film offset of the camera. A positive value shifts the camera right, a negative value shifts it left.
+
+
+</td></tr>
+<tr><td>
+
+[forwardOffset](./server.hytopia.playercamera.forwardoffset.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[fov](./server.hytopia.playercamera.fov.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The field of view of the camera.
+
+
+</td></tr>
+<tr><td>
+
+[hiddenModelNodes](./server.hytopia.playercamera.hiddenmodelnodes.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Set&lt;string&gt;
+
+
+</td><td>
+
+The nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
+
+
+</td></tr>
+<tr><td>
+
+[mode](./server.hytopia.playercamera.mode.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerCameraMode](./server.playercameramode.md)
+
+
+</td><td>
+
+The mode of the camera.
+
+
+</td></tr>
+<tr><td>
+
+[offset](./server.hytopia.playercamera.offset.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The relative offset of the camera from the entity or position it is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[player](./server.hytopia.playercamera.player.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player that the camera belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[trackedEntity](./server.hytopia.playercamera.trackedentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+The entity the camera will constantly look at, even if the camera attached or tracked entity moves.
+
+
+</td></tr>
+<tr><td>
+
+[trackedPosition](./server.hytopia.playercamera.trackedposition.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3](./server.vector3.md) \| undefined
+
+
+</td><td>
+
+The position the camera will constantly look at, even if the camera attached entity moves.
+
+
+</td></tr>
+<tr><td>
+
+[zoom](./server.hytopia.playercamera.zoom.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The zoom of the camera.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[lookAtEntity(entity)](./server.hytopia.playercamera.lookatentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Makes the camera look at an entity. If the camera was previously tracking an entity or position, it will stop tracking.
+
+
+</td></tr>
+<tr><td>
+
+[lookAtPosition(position)](./server.hytopia.playercamera.lookatposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Makes the camera look at a position. If the camera was previously tracking an entity or position, it will stop tracking.
+
+
+</td></tr>
+<tr><td>
+
+[setAttachedToEntity(entity)](./server.hytopia.playercamera.setattachedtoentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the entity the camera is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[setAttachedToPosition(position)](./server.hytopia.playercamera.setattachedtoposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the position the camera is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[setFilmOffset(filmOffset)](./server.hytopia.playercamera.setfilmoffset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the film offset of the camera. A positive value shifts the camera right, a negative value shifts it left.
+
+
+</td></tr>
+<tr><td>
+
+[setForwardOffset(forwardOffset)](./server.hytopia.playercamera.setforwardoffset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Only used in first-person mode. Sets the forward offset of the camera. A positive value shifts the camera forward, a negative value shifts it backward.
+
+
+</td></tr>
+<tr><td>
+
+[setFov(fov)](./server.hytopia.playercamera.setfov.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the field of view of the camera.
+
+
+</td></tr>
+<tr><td>
+
+[setHiddenModelNodes(hiddenModelNodes)](./server.hytopia.playercamera.sethiddenmodelnodes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the nodes of the model the camera is attached to that will not be rendered for the player. Uses case insensitive substring matching.
+
+
+</td></tr>
+<tr><td>
+
+[setMode(mode)](./server.hytopia.playercamera.setmode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the mode of the camera.
+
+
+</td></tr>
+<tr><td>
+
+[setOffset(offset)](./server.hytopia.playercamera.setoffset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the relative offset of the camera from the entity or position it is attached to.
+
+
+</td></tr>
+<tr><td>
+
+[setTrackedEntity(entity)](./server.hytopia.playercamera.settrackedentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the entity the camera will constantly look at, even if the camera attached or tracked entity moves.
+
+
+</td></tr>
+<tr><td>
+
+[setTrackedPosition(position)](./server.hytopia.playercamera.settrackedposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the position the camera will constantly look at, even if the camera attached entity moves.
+
+
+</td></tr>
+<tr><td>
+
+[setZoom(zoom)](./server.hytopia.playercamera.setzoom.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the zoom of the camera.
+
+
+</td></tr>
+</tbody></table>

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

package/docs/server.hytopia.playercamera.offset.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; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [offset](./server.hytopia.playercamera.offset.md)
+
+## HYTOPIA.PlayerCamera.offset property
+
+The relative offset of the camera from the entity or position it is attached to.
+
+**Signature:**
+
+```typescript
+get offset(): Vector3;
+```

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

package/docs/server.hytopia.playercamera.setattachedtoentity.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [setAttachedToEntity](./server.hytopia.playercamera.setattachedtoentity.md)
+
+## HYTOPIA.PlayerCamera.setAttachedToEntity() method
+
+Sets the entity the camera is attached to.
+
+**Signature:**
+
+```typescript
+setAttachedToEntity(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 attach the camera to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setattachedtoposition.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [setAttachedToPosition](./server.hytopia.playercamera.setattachedtoposition.md)
+
+## HYTOPIA.PlayerCamera.setAttachedToPosition() method
+
+Sets the position the camera is attached to.
+
+**Signature:**
+
+```typescript
+setAttachedToPosition(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 attach the camera to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setfilmoffset.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; [HYTOPIA](./server.hytopia.md) &gt; [PlayerCamera](./server.hytopia.playercamera.md) &gt; [setFilmOffset](./server.hytopia.playercamera.setfilmoffset.md)
+
+## HYTOPIA.PlayerCamera.setFilmOffset() method
+
+Sets the film offset of the camera. A positive value shifts the camera right, a negative value shifts it left.
+
+**Signature:**
+
+```typescript
+setFilmOffset(filmOffset: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filmOffset
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The film offset to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+