hytopia 0.1.25 → 0.1.27

package/README.md

@@ -1,7 +1,7 @@
 # HYTOPIA SDK
 
 ## Quick Links
-[Quickstart](#quickstart) • [API Reference](./docs/server.md) • [Examples](./examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
+[Quickstart](#quickstart) • [Developer Docs](https://dev.hytopia.com/) • [API Reference](./docs/server.md) • [Examples](./examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
 
 ## What is HYTOPIA?
 
@@ -56,6 +56,7 @@ bun --watch index.ts
 **Note: If you'd prefer to use JavaScript instead of TypeScript, simply change the file extension of index.ts to index.js - Your editor will highlight the TypeScript syntax errors, simple delete the type annotations and everything should work the same without any TypeScript usage.**
 
 Once you're up and running, here's some other resources to go further:
+- [Developer Docs](https://dev.hytopia.com/)
 - [Game Examples](./examples)
 - [API Reference](./docs/server.md)
 

package/boilerplate/index.ts

@@ -25,6 +25,7 @@
 
 import {
   startServer,
+  Audio,
   GameServer,
   PlayerEntity,
 } from 'hytopia';
@@ -112,4 +113,15 @@ startServer(world => {
       entity.applyImpulse({ x: 0, y: 20, z: 0 });
     });
   });
+
+  /**
+   * Play some peaceful ambient music to
+   * set the mood!
+   */
+  
+  new Audio({
+    uri: 'audio/music/overworld.mp3',
+    loop: true,
+    volume: 0.1,
+  }).play(world);
 });

package/docs/server.hytopia.md

@@ -420,6 +420,17 @@ Event types a Player can emit.
 The types a RigidBody can be.
 
 
+</td></tr>
+<tr><td>
+
+[WorldLoopEventType](./server.hytopia.worldloopeventtype.md)
+
+
+</td><td>
+
+Event types a WorldLoop instance can emit.
+
+
 </td></tr>
 </tbody></table>
 
@@ -707,6 +718,17 @@ Payloads for events emitted by a GameServer instance.
 Payloads for events a Player can emit.
 
 
+</td></tr>
+<tr><td>
+
+[WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md)
+
+
+</td><td>
+
+Payloads for events emitted by a WorldLoop instance.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/server.hytopia.worldloopeventpayload.md

@@ -0,0 +1,73 @@
+<!-- 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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md)
+
+## HYTOPIA.WorldLoopEventPayload namespace
+
+Payloads for events emitted by a WorldLoop instance.
+
+**Signature:**
+
+```typescript
+export declare namespace WorldLoopEventPayload 
+```
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Start](./server.hytopia.worldloopeventpayload.start.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Stop](./server.hytopia.worldloopeventpayload.stop.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickEnd](./server.hytopia.worldloopeventpayload.tickend.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickError](./server.hytopia.worldloopeventpayload.tickerror.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickStart](./server.hytopia.worldloopeventpayload.tickstart.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.start.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [Start](./server.hytopia.worldloopeventpayload.start.md)
+
+## HYTOPIA.WorldLoopEventPayload.Start interface
+
+**Signature:**
+
+```typescript
+interface Start 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[worldLoop](./server.hytopia.worldloopeventpayload.start.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.start.worldloop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [Start](./server.hytopia.worldloopeventpayload.start.md) &gt; [worldLoop](./server.hytopia.worldloopeventpayload.start.worldloop.md)
+
+## HYTOPIA.WorldLoopEventPayload.Start.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```

package/docs/server.hytopia.worldloopeventpayload.stop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [Stop](./server.hytopia.worldloopeventpayload.stop.md)
+
+## HYTOPIA.WorldLoopEventPayload.Stop interface
+
+**Signature:**
+
+```typescript
+interface Stop 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[worldLoop](./server.hytopia.worldloopeventpayload.stop.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.stop.worldloop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [Stop](./server.hytopia.worldloopeventpayload.stop.md) &gt; [worldLoop](./server.hytopia.worldloopeventpayload.stop.worldloop.md)
+
+## HYTOPIA.WorldLoopEventPayload.Stop.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```

package/docs/server.hytopia.worldloopeventpayload.tickend.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickEnd](./server.hytopia.worldloopeventpayload.tickend.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickEnd interface
+
+**Signature:**
+
+```typescript
+interface TickEnd 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[tickDurationMs](./server.hytopia.worldloopeventpayload.tickend.tickdurationms.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[worldLoop](./server.hytopia.worldloopeventpayload.tickend.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.tickend.tickdurationms.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickEnd](./server.hytopia.worldloopeventpayload.tickend.md) &gt; [tickDurationMs](./server.hytopia.worldloopeventpayload.tickend.tickdurationms.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickEnd.tickDurationMs property
+
+**Signature:**
+
+```typescript
+tickDurationMs: number;
+```

package/docs/server.hytopia.worldloopeventpayload.tickend.worldloop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickEnd](./server.hytopia.worldloopeventpayload.tickend.md) &gt; [worldLoop](./server.hytopia.worldloopeventpayload.tickend.worldloop.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickEnd.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```

package/docs/server.hytopia.worldloopeventpayload.tickerror.error.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickError](./server.hytopia.worldloopeventpayload.tickerror.md) &gt; [error](./server.hytopia.worldloopeventpayload.tickerror.error.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickError.error property
+
+**Signature:**
+
+```typescript
+error: Error;
+```

package/docs/server.hytopia.worldloopeventpayload.tickerror.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickError](./server.hytopia.worldloopeventpayload.tickerror.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickError interface
+
+**Signature:**
+
+```typescript
+interface TickError 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[error](./server.hytopia.worldloopeventpayload.tickerror.error.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Error
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[worldLoop](./server.hytopia.worldloopeventpayload.tickerror.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.tickerror.worldloop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickError](./server.hytopia.worldloopeventpayload.tickerror.md) &gt; [worldLoop](./server.hytopia.worldloopeventpayload.tickerror.worldloop.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickError.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```

package/docs/server.hytopia.worldloopeventpayload.tickstart.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickStart](./server.hytopia.worldloopeventpayload.tickstart.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickStart interface
+
+**Signature:**
+
+```typescript
+interface TickStart 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[tickDeltaMs](./server.hytopia.worldloopeventpayload.tickstart.tickdeltams.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[worldLoop](./server.hytopia.worldloopeventpayload.tickstart.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.worldloopeventpayload.tickstart.tickdeltams.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickStart](./server.hytopia.worldloopeventpayload.tickstart.md) &gt; [tickDeltaMs](./server.hytopia.worldloopeventpayload.tickstart.tickdeltams.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickStart.tickDeltaMs property
+
+**Signature:**
+
+```typescript
+tickDeltaMs: number;
+```

package/docs/server.hytopia.worldloopeventpayload.tickstart.worldloop.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; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickStart](./server.hytopia.worldloopeventpayload.tickstart.md) &gt; [worldLoop](./server.hytopia.worldloopeventpayload.tickstart.worldloop.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickStart.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```

package/docs/server.hytopia.worldloopeventtype.md

@@ -0,0 +1,103 @@
+<!-- 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; [WorldLoopEventType](./server.hytopia.worldloopeventtype.md)
+
+## HYTOPIA.WorldLoopEventType enum
+
+Event types a WorldLoop instance can emit.
+
+**Signature:**
+
+```typescript
+export declare enum WorldLoopEventType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+START
+
+
+</td><td>
+
+`"WORLD_LOOP.START"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+STOP
+
+
+</td><td>
+
+`"WORLD_LOOP.STOP"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_END
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_END"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_ERROR
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_ERROR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_START
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_START"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>