hytopia 0.1.58 → 0.1.60

package/docs/server.audio._constructor_.md

@@ -42,6 +42,8 @@ options
 
 </td><td>
 
+The options for the Audio instance.
+
 
 </td></tr>
 </tbody></table>

package/docs/server.audio.setattachedtoentity.md

@@ -42,7 +42,7 @@ entity
 
 </td><td>
 
-The entity to attach the audio to.
+The entity to attach the Audio to.
 
 
 </td></tr>

package/docs/server.audiomanager.md

@@ -146,5 +146,33 @@ Retrieves all looped audio instances for the world.
 Retrieves all oneshot (non-looped) audio instances for the world.
 
 
+</td></tr>
+<tr><td>
+
+[unregisterAudio(audio)](./server.audiomanager.unregisteraudio.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Unregisters and stops an audio instance from the audio manager.
+
+
+</td></tr>
+<tr><td>
+
+[unregisterEntityAttachedAudios(entity)](./server.audiomanager.unregisterentityattachedaudios.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Unregisters and stops all audio instances attached to a specific entity.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.audiomanager.unregisteraudio.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; [AudioManager](./server.audiomanager.md) &gt; [unregisterAudio](./server.audiomanager.unregisteraudio.md)
+
+## AudioManager.unregisterAudio() method
+
+Unregisters and stops an audio instance from the audio manager.
+
+**Signature:**
+
+```typescript
+unregisterAudio(audio: Audio): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+audio
+
+
+</td><td>
+
+[Audio](./server.audio.md)
+
+
+</td><td>
+
+The audio instance to pause and unregister.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.audiomanager.unregisterentityattachedaudios.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; [AudioManager](./server.audiomanager.md) &gt; [unregisterEntityAttachedAudios](./server.audiomanager.unregisterentityattachedaudios.md)
+
+## AudioManager.unregisterEntityAttachedAudios() method
+
+Unregisters and stops all audio instances attached to a specific entity.
+
+**Signature:**
+
+```typescript
+unregisterEntityAttachedAudios(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 pause and unregister audio instances for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.blocktype.isliquid.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; [BlockType](./server.blocktype.md) &gt; [isLiquid](./server.blocktype.isliquid.md)
+
+## BlockType.isLiquid property
+
+Whether the block type is a liquid.
+
+**Signature:**
+
+```typescript
+get isLiquid(): boolean;
+```

package/docs/server.blocktype.md

@@ -130,6 +130,27 @@ number
 The unique identifier for the block type.
 
 
+</td></tr>
+<tr><td>
+
+[isLiquid](./server.blocktype.isliquid.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the block type is a liquid.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.blocktypeoptions.isliquid.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; [BlockTypeOptions](./server.blocktypeoptions.md) &gt; [isLiquid](./server.blocktypeoptions.isliquid.md)
+
+## BlockTypeOptions.isLiquid property
+
+**Signature:**
+
+```typescript
+isLiquid?: boolean;
+```

package/docs/server.blocktypeoptions.md

@@ -70,6 +70,25 @@ number
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[isLiquid?](./server.blocktypeoptions.isliquid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 <tr><td>
 

package/docs/{server.chunk.getblock.md → server.chunk.getblockid.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [Chunk](./server.chunk.md) &gt; [getBlock](./server.chunk.getblock.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Chunk](./server.chunk.md) &gt; [getBlockId](./server.chunk.getblockid.md)
 
-## Chunk.getBlock() method
+## Chunk.getBlockId() method
 
 Get the block type id at a specific local coordinate.
 
 **Signature:**
 
 ```typescript
-getBlock(localCoordinate: Vector3Like): number;
+getBlockId(localCoordinate: Vector3Like): number;
 ```
 
 ## Parameters

package/docs/server.chunk.md

@@ -247,7 +247,7 @@ Despawn the chunk from the world.
 </td></tr>
 <tr><td>
 
-[getBlock(localCoordinate)](./server.chunk.getblock.md)
+[getBlockId(localCoordinate)](./server.chunk.getblockid.md)
 
 
 </td><td>

package/docs/{server.chunklattice.getblock.md → server.chunklattice.getblockid.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [getBlock](./server.chunklattice.getblock.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLattice](./server.chunklattice.md) &gt; [getBlockId](./server.chunklattice.getblockid.md)
 
-## ChunkLattice.getBlock() method
+## ChunkLattice.getBlockId() method
 
 Get the block type id at a specific global coordinate.
 
 **Signature:**
 
 ```typescript
-getBlock(globalCoordinate: Vector3Like): number;
+getBlockId(globalCoordinate: Vector3Like): number;
 ```
 
 ## Parameters

package/docs/server.chunklattice.getblocktype.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; [ChunkLattice](./server.chunklattice.md) &gt; [getBlockType](./server.chunklattice.getblocktype.md)
+
+## ChunkLattice.getBlockType() method
+
+Get the block type at a specific global coordinate.
+
+**Signature:**
+
+```typescript
+getBlockType(globalCoordinate: Vector3Like): BlockType | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+globalCoordinate
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The global coordinate of the block to get.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[BlockType](./server.blocktype.md) \| null
+
+The block type, null if no block is set.
+

package/docs/server.chunklattice.md

@@ -84,7 +84,7 @@ Get all chunks in the lattice.
 </td></tr>
 <tr><td>
 
-[getBlock(globalCoordinate)](./server.chunklattice.getblock.md)
+[getBlockId(globalCoordinate)](./server.chunklattice.getblockid.md)
 
 
 </td><td>
@@ -95,6 +95,20 @@ Get all chunks in the lattice.
 Get the block type id at a specific global coordinate.
 
 
+</td></tr>
+<tr><td>
+
+[getBlockType(globalCoordinate)](./server.chunklattice.getblocktype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the block type at a specific global coordinate.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.md

@@ -258,6 +258,28 @@ Represents a quaternion.
 Represents a rigid body in a world's physics simulation.
 
 
+</td></tr>
+<tr><td>
+
+[SceneUI](./server.sceneui.md)
+
+
+</td><td>
+
+UI rendered within the 3D space of a world's game scene.
+
+
+</td></tr>
+<tr><td>
+
+[SceneUIManager](./server.sceneuimanager.md)
+
+
+</td><td>
+
+Manages SceneUI instances in a world.
+
+
 </td></tr>
 <tr><td>
 
@@ -670,6 +692,17 @@ A RGB color.
 Options for creating a RigidBody instance.
 
 
+</td></tr>
+<tr><td>
+
+[SceneUIOptions](./server.sceneuioptions.md)
+
+
+</td><td>
+
+Options for creating a SceneUI instance.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.sceneui._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; [SceneUI](./server.sceneui.md) &gt; [(constructor)](./server.sceneui._constructor_.md)
+
+## SceneUI.(constructor)
+
+Constructs a new instance of the `SceneUI` class
+
+**Signature:**
+
+```typescript
+constructor(options: SceneUIOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[SceneUIOptions](./server.sceneuioptions.md)
+
+
+</td><td>
+
+The options for the SceneUI instance.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.sceneui.attachedtoentity.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; [SceneUI](./server.sceneui.md) &gt; [attachedToEntity](./server.sceneui.attachedtoentity.md)
+
+## SceneUI.attachedToEntity property
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.sceneui.id.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; [SceneUI](./server.sceneui.md) &gt; [id](./server.sceneui.id.md)
+
+## SceneUI.id property
+
+**Signature:**
+
+```typescript
+get id(): number | undefined;
+```

package/docs/server.sceneui.isloaded.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; [SceneUI](./server.sceneui.md) &gt; [isLoaded](./server.sceneui.isloaded.md)
+
+## SceneUI.isLoaded property
+
+**Signature:**
+
+```typescript
+get isLoaded(): boolean;
+```

package/docs/server.sceneui.load.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; [SceneUI](./server.sceneui.md) &gt; [load](./server.sceneui.load.md)
+
+## SceneUI.load() method
+
+Loads the SceneUI into the world.
+
+**Signature:**
+
+```typescript
+load(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 load the SceneUI into.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+