hytopia 0.1.1 → 0.1.2

package/boilerplate/index.ts

@@ -0,0 +1,103 @@
+/**
+ * HYTOPIA SDK Boilerplate
+ * 
+ * This is a simple boilerplate to get started on your project.
+ * It implements the bare minimum to be able to run and connect
+ * to your game server and run around as the basic player entity.
+ * 
+ * From here you can begin to implement your own game logic
+ * or do whatever you want!
+ * 
+ * You can find documentation here: https://github.com/hytopiagg/sdk/blob/main/docs/server.md
+ * 
+ * For more in-depth examples, check out the examples folder in the SDK, or you
+ * can find it directly on GitHub: https://github.com/hytopiagg/sdk/tree/main/examples/payload-game
+ * 
+ * You can officially report bugs or request features here: https://github.com/hytopiagg/sdk/issues
+ * 
+ * To get help, have found a bug, or want to chat with
+ * other HYTOPIA devs, join our Discord server:
+ * https://discord.gg/DXCXJbHSJX
+ * 
+ * Official SDK Github repo: https://github.com/hytopiagg/sdk
+ * Official SDK NPM Package: https://www.npmjs.com/package/hytopia
+ */
+
+import {
+  startServer,
+  PlayerEntity,
+} from 'hytopia';
+
+import worldMap from './assets/map.json';
+
+/**
+ * startServer is always the entry point for our game.
+ * It accepts a single function where we should do any
+ * setup necessary for our game. The init function is
+ * passed a World instance which is the default
+ * world created by the game server on startup.
+ * 
+ * Documentation: https://github.com/hytopiagg/sdk/blob/main/docs/server.startserver.md
+ */
+
+startServer(world => {
+  /**
+   * Load our map.
+   * You can build your own map using https://build.hytopia.com
+   * After building, hit export and drop the .json file in
+   * the assets folder as map.json.
+   */
+  world.loadMap(worldMap);
+
+  /**
+   * Handle player joining the game. The onPlayerJoin
+   * function is called when a new player connects to
+   * the game. From here, we create a basic player
+   * entity instance which automatically handles mapping
+   * their inputs to control their in-game entity and
+   * internally uses our default character controller.
+   */
+  world.onPlayerJoin = player => {
+    const playerEntity = new PlayerEntity({
+      player,
+      name: 'Player',
+      modelUri: 'models/player.gltf',
+      modelLoopedAnimations: [ 'idle' ],
+      modelScale: 0.5,
+    });
+  
+    playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
+
+    // Send a nice welcome message that only the player who joined will see ;)
+    world.chatManager.sendPlayerMessage(player, 'Welcome to the game!', '00FF00');
+    world.chatManager.sendPlayerMessage(player, 'Use WASD to move around.');
+    world.chatManager.sendPlayerMessage(player, 'Press space to jump.');
+    world.chatManager.sendPlayerMessage(player, 'Hold shift to sprint.');
+    world.chatManager.sendPlayerMessage(player, 'Type /rocket for a little surprise!');
+  };
+
+  /**
+   * Handle player leaving the game. The onPlayerLeave
+   * function is called when a player leaves the game.
+   * Because HYTOPIA is not opinionated on join and
+   * leave game logic, we are responsible for cleaning
+   * up the player and any entities associated with them
+   * after they leave. We can easily do this by 
+   * getting all the known PlayerEntity instances for
+   * the player who left by using our world's EntityManager
+   * instance.
+   */
+  world.onPlayerLeave = player => {
+    world.entityManager.getAllPlayerEntities(player).forEach(entity => entity.despawn());
+  };
+
+  /**
+   * A silly little easter egg command. When a player types
+   * "/rocket" in the game, they'll get launched into the air!
+   */
+  world.chatManager.registerCommand('/rocket', player => {
+    world.entityManager.getAllPlayerEntities(player).forEach(entity => {
+      entity.applyImpulse({ x: 0, y: 20, z: 0 });
+    });
+  });
+});

package/docs/index.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[server](./server.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.audio._constructor_.md

@@ -0,0 +1,47 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Audio](./server.audio.md) &gt; [(constructor)](./server.audio._constructor_.md)
+
+## Audio.(constructor)
+
+Constructs a new instance of the `Audio` class
+
+**Signature:**
+
+```typescript
+constructor(options: AudioOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[AudioOptions](./server.audiooptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

package/docs/server.audio.detune.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; [Audio](./server.audio.md) &gt; [detune](./server.audio.detune.md)
+
+## Audio.detune property
+
+The detune of the audio in cents if explicitly set.
+
+**Signature:**
+
+```typescript
+get detune(): number | undefined;
+```

package/docs/server.audio.distortion.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; [Audio](./server.audio.md) &gt; [distortion](./server.audio.distortion.md)
+
+## Audio.distortion property
+
+The amount of distortion to apply to the audio if explicitly set.
+
+**Signature:**
+
+```typescript
+get distortion(): number | undefined;
+```

package/docs/server.audio.duration.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; [Audio](./server.audio.md) &gt; [duration](./server.audio.duration.md)
+
+## Audio.duration property
+
+The duration of the audio in seconds if explicitly set.
+
+**Signature:**
+
+```typescript
+get duration(): number | undefined;
+```

package/docs/server.audio.id.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; [Audio](./server.audio.md) &gt; [id](./server.audio.id.md)
+
+## Audio.id property
+
+The unique identifier for the audio.
+
+**Signature:**
+
+```typescript
+get id(): number | undefined;
+```

package/docs/server.audio.isloaded.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; [Audio](./server.audio.md) &gt; [isLoaded](./server.audio.isloaded.md)
+
+## Audio.isLoaded property
+
+Whether the audio has loaded into the world. Audio is loaded the first time play() is called.
+
+**Signature:**
+
+```typescript
+get isLoaded(): boolean;
+```

package/docs/server.audio.isplaying.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; [Audio](./server.audio.md) &gt; [isPlaying](./server.audio.isplaying.md)
+
+## Audio.isPlaying property
+
+Whether the audio is currently playing.
+
+**Signature:**
+
+```typescript
+get isPlaying(): boolean;
+```

package/docs/server.audio.ispositional.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; [Audio](./server.audio.md) &gt; [isPositional](./server.audio.ispositional.md)
+
+## Audio.isPositional property
+
+Whether the audio is positional (Entity or position attached).
+
+**Signature:**
+
+```typescript
+get isPositional(): boolean;
+```

package/docs/server.audio.loop.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; [Audio](./server.audio.md) &gt; [loop](./server.audio.loop.md)
+
+## Audio.loop property
+
+Whether the audio is looped.
+
+**Signature:**
+
+```typescript
+get loop(): boolean;
+```