hytopia 0.1.31 → 0.1.33

package/docs/server.hytopia.playercamera.setforwardoffset.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; [setForwardOffset](./server.hytopia.playercamera.setforwardoffset.md)
+
+## HYTOPIA.PlayerCamera.setForwardOffset() method
+
+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.
+
+**Signature:**
+
+```typescript
+setForwardOffset(forwardOffset: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+forwardOffset
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The forward offset to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setfov.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; [setFov](./server.hytopia.playercamera.setfov.md)
+
+## HYTOPIA.PlayerCamera.setFov() method
+
+Sets the field of view of the camera.
+
+**Signature:**
+
+```typescript
+setFov(fov: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fov
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The field of view to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.sethiddenmodelnodes.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; [setHiddenModelNodes](./server.hytopia.playercamera.sethiddenmodelnodes.md)
+
+## HYTOPIA.PlayerCamera.setHiddenModelNodes() method
+
+Sets 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
+setHiddenModelNodes(hiddenModelNodes: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+hiddenModelNodes
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+Determines nodes to hide that match these case insensitive substrings.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setmode.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; [setMode](./server.hytopia.playercamera.setmode.md)
+
+## HYTOPIA.PlayerCamera.setMode() method
+
+Sets the mode of the camera.
+
+**Signature:**
+
+```typescript
+setMode(mode: PlayerCameraMode): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+mode
+
+
+</td><td>
+
+[PlayerCameraMode](./server.playercameramode.md)
+
+
+</td><td>
+
+The mode to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setoffset.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; [setOffset](./server.hytopia.playercamera.setoffset.md)
+
+## HYTOPIA.PlayerCamera.setOffset() method
+
+Sets the relative offset of the camera from the entity or position it is attached to.
+
+**Signature:**
+
+```typescript
+setOffset(offset: Vector3): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+offset
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The offset to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.settrackedentity.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; [setTrackedEntity](./server.hytopia.playercamera.settrackedentity.md)
+
+## HYTOPIA.PlayerCamera.setTrackedEntity() method
+
+Sets the entity the camera will constantly look at, even if the camera attached or tracked entity moves.
+
+**Signature:**
+
+```typescript
+setTrackedEntity(entity: Entity | undefined): 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) \| undefined
+
+
+</td><td>
+
+The entity to track or undefined to stop tracking.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.settrackedposition.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; [setTrackedPosition](./server.hytopia.playercamera.settrackedposition.md)
+
+## HYTOPIA.PlayerCamera.setTrackedPosition() method
+
+Sets the position the camera will constantly look at, even if the camera attached entity moves.
+
+**Signature:**
+
+```typescript
+setTrackedPosition(position: Vector3 | undefined): 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) \| undefined
+
+
+</td><td>
+
+The position to track or undefined to stop tracking.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.setzoom.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; [setZoom](./server.hytopia.playercamera.setzoom.md)
+
+## HYTOPIA.PlayerCamera.setZoom() method
+
+Sets the zoom of the camera.
+
+**Signature:**
+
+```typescript
+setZoom(zoom: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+zoom
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The zoom to set, 0 to infinity.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.playercamera.trackedentity.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; [trackedEntity](./server.hytopia.playercamera.trackedentity.md)
+
+## HYTOPIA.PlayerCamera.trackedEntity property
+
+The entity the camera will constantly look at, even if the camera attached or tracked entity moves.
+
+**Signature:**
+
+```typescript
+get trackedEntity(): Entity | undefined;
+```

package/docs/server.hytopia.playercamera.trackedposition.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; [trackedPosition](./server.hytopia.playercamera.trackedposition.md)
+
+## HYTOPIA.PlayerCamera.trackedPosition property
+
+The position the camera will constantly look at, even if the camera attached entity moves.
+
+**Signature:**
+
+```typescript
+get trackedPosition(): Vector3 | undefined;
+```

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

package/docs/server.hytopia.playercameraeventpayload.lookatentity.entity.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtEntity](./server.hytopia.playercameraeventpayload.lookatentity.md) &gt; [entity](./server.hytopia.playercameraeventpayload.lookatentity.entity.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtEntity.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```

package/docs/server.hytopia.playercameraeventpayload.lookatentity.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtEntity](./server.hytopia.playercameraeventpayload.lookatentity.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtEntity interface
+
+**Signature:**
+
+```typescript
+interface LookAtEntity 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[entity](./server.hytopia.playercameraeventpayload.lookatentity.entity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[playerCamera](./server.hytopia.playercameraeventpayload.lookatentity.playercamera.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerCamera](./server.playercamera.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playercameraeventpayload.lookatentity.playercamera.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtEntity](./server.hytopia.playercameraeventpayload.lookatentity.md) &gt; [playerCamera](./server.hytopia.playercameraeventpayload.lookatentity.playercamera.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtEntity.playerCamera property
+
+**Signature:**
+
+```typescript
+playerCamera: PlayerCamera;
+```

package/docs/server.hytopia.playercameraeventpayload.lookatposition.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtPosition](./server.hytopia.playercameraeventpayload.lookatposition.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtPosition interface
+
+**Signature:**
+
+```typescript
+interface LookAtPosition 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[playerCamera](./server.hytopia.playercameraeventpayload.lookatposition.playercamera.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerCamera](./server.playercamera.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[position](./server.hytopia.playercameraeventpayload.lookatposition.position.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.playercameraeventpayload.lookatposition.playercamera.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtPosition](./server.hytopia.playercameraeventpayload.lookatposition.md) &gt; [playerCamera](./server.hytopia.playercameraeventpayload.lookatposition.playercamera.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtPosition.playerCamera property
+
+**Signature:**
+
+```typescript
+playerCamera: PlayerCamera;
+```

package/docs/server.hytopia.playercameraeventpayload.lookatposition.position.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; [PlayerCameraEventPayload](./server.hytopia.playercameraeventpayload.md) &gt; [LookAtPosition](./server.hytopia.playercameraeventpayload.lookatposition.md) &gt; [position](./server.hytopia.playercameraeventpayload.lookatposition.position.md)
+
+## HYTOPIA.PlayerCameraEventPayload.LookAtPosition.position property
+
+**Signature:**
+
+```typescript
+position: Vector3;
+```