hytopia 0.1.25 → 0.1.27

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. package/README.md +2 -1
  2. package/boilerplate/index.ts +12 -0
  3. package/docs/server.hytopia.md +22 -0
  4. package/docs/server.hytopia.worldloopeventpayload.md +73 -0
  5. package/docs/server.hytopia.worldloopeventpayload.start.md +53 -0
  6. package/docs/server.hytopia.worldloopeventpayload.start.worldloop.md +11 -0
  7. package/docs/server.hytopia.worldloopeventpayload.stop.md +53 -0
  8. package/docs/server.hytopia.worldloopeventpayload.stop.worldloop.md +11 -0
  9. package/docs/server.hytopia.worldloopeventpayload.tickend.md +70 -0
  10. package/docs/server.hytopia.worldloopeventpayload.tickend.tickdurationms.md +11 -0
  11. package/docs/server.hytopia.worldloopeventpayload.tickend.worldloop.md +11 -0
  12. package/docs/server.hytopia.worldloopeventpayload.tickerror.error.md +11 -0
  13. package/docs/server.hytopia.worldloopeventpayload.tickerror.md +70 -0
  14. package/docs/server.hytopia.worldloopeventpayload.tickerror.worldloop.md +11 -0
  15. package/docs/server.hytopia.worldloopeventpayload.tickstart.md +70 -0
  16. package/docs/server.hytopia.worldloopeventpayload.tickstart.tickdeltams.md +11 -0
  17. package/docs/server.hytopia.worldloopeventpayload.tickstart.worldloop.md +11 -0
  18. package/docs/server.hytopia.worldloopeventtype.md +103 -0
  19. package/docs/server.md +22 -0
  20. package/docs/server.worldloopeventpayload.md +73 -0
  21. package/docs/server.worldloopeventpayload.start.md +53 -0
  22. package/docs/server.worldloopeventpayload.start.worldloop.md +11 -0
  23. package/docs/server.worldloopeventpayload.stop.md +53 -0
  24. package/docs/server.worldloopeventpayload.stop.worldloop.md +11 -0
  25. package/docs/server.worldloopeventpayload.tickend.md +70 -0
  26. package/docs/server.worldloopeventpayload.tickend.tickdurationms.md +11 -0
  27. package/docs/server.worldloopeventpayload.tickend.worldloop.md +11 -0
  28. package/docs/server.worldloopeventpayload.tickerror.error.md +11 -0
  29. package/docs/server.worldloopeventpayload.tickerror.md +70 -0
  30. package/docs/server.worldloopeventpayload.tickerror.worldloop.md +11 -0
  31. package/docs/server.worldloopeventpayload.tickstart.md +70 -0
  32. package/docs/server.worldloopeventpayload.tickstart.tickdeltams.md +11 -0
  33. package/docs/server.worldloopeventpayload.tickstart.worldloop.md +11 -0
  34. package/docs/server.worldloopeventtype.md +103 -0
  35. package/examples/character-controller/index.ts +1 -2
  36. package/examples/entity-spawn/index.ts +1 -2
  37. package/package.json +1 -1
  38. package/server.api.json +1082 -190
  39. package/server.d.ts +34 -1
  40. package/server.js +60 -60
package/docs/server.md CHANGED
@@ -420,6 +420,17 @@ Event types a Player can emit.
420
420
  The types a RigidBody can be.
421
421
 
422
422
 
423
+ </td></tr>
424
+ <tr><td>
425
+
426
+ [WorldLoopEventType](./server.worldloopeventtype.md)
427
+
428
+
429
+ </td><td>
430
+
431
+ Event types a WorldLoop instance can emit.
432
+
433
+
423
434
  </td></tr>
424
435
  </tbody></table>
425
436
 
@@ -716,6 +727,17 @@ Payloads for events emitted by a GameServer instance.
716
727
  Payloads for events a Player can emit.
717
728
 
718
729
 
730
+ </td></tr>
731
+ <tr><td>
732
+
733
+ [WorldLoopEventPayload](./server.worldloopeventpayload.md)
734
+
735
+
736
+ </td><td>
737
+
738
+ Payloads for events emitted by a WorldLoop instance.
739
+
740
+
719
741
  </td></tr>
720
742
  </tbody></table>
721
743
 
@@ -0,0 +1,73 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md)
4
+
5
+ ## WorldLoopEventPayload namespace
6
+
7
+ Payloads for events emitted by a WorldLoop instance.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare namespace WorldLoopEventPayload
13
+ ```
14
+
15
+ ## Interfaces
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Interface
20
+
21
+
22
+ </th><th>
23
+
24
+ Description
25
+
26
+
27
+ </th></tr></thead>
28
+ <tbody><tr><td>
29
+
30
+ [Start](./server.worldloopeventpayload.start.md)
31
+
32
+
33
+ </td><td>
34
+
35
+
36
+ </td></tr>
37
+ <tr><td>
38
+
39
+ [Stop](./server.worldloopeventpayload.stop.md)
40
+
41
+
42
+ </td><td>
43
+
44
+
45
+ </td></tr>
46
+ <tr><td>
47
+
48
+ [TickEnd](./server.worldloopeventpayload.tickend.md)
49
+
50
+
51
+ </td><td>
52
+
53
+
54
+ </td></tr>
55
+ <tr><td>
56
+
57
+ [TickError](./server.worldloopeventpayload.tickerror.md)
58
+
59
+
60
+ </td><td>
61
+
62
+
63
+ </td></tr>
64
+ <tr><td>
65
+
66
+ [TickStart](./server.worldloopeventpayload.tickstart.md)
67
+
68
+
69
+ </td><td>
70
+
71
+
72
+ </td></tr>
73
+ </tbody></table>
@@ -0,0 +1,53 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Start](./server.worldloopeventpayload.start.md)
4
+
5
+ ## WorldLoopEventPayload.Start interface
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ interface Start
11
+ ```
12
+
13
+ ## Properties
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Property
18
+
19
+
20
+ </th><th>
21
+
22
+ Modifiers
23
+
24
+
25
+ </th><th>
26
+
27
+ Type
28
+
29
+
30
+ </th><th>
31
+
32
+ Description
33
+
34
+
35
+ </th></tr></thead>
36
+ <tbody><tr><td>
37
+
38
+ [worldLoop](./server.worldloopeventpayload.start.worldloop.md)
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td><td>
45
+
46
+ [WorldLoop](./server.worldloop.md)
47
+
48
+
49
+ </td><td>
50
+
51
+
52
+ </td></tr>
53
+ </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Start](./server.worldloopeventpayload.start.md) &gt; [worldLoop](./server.worldloopeventpayload.start.worldloop.md)
4
+
5
+ ## WorldLoopEventPayload.Start.worldLoop property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ worldLoop: WorldLoop;
11
+ ```
@@ -0,0 +1,53 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Stop](./server.worldloopeventpayload.stop.md)
4
+
5
+ ## WorldLoopEventPayload.Stop interface
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ interface Stop
11
+ ```
12
+
13
+ ## Properties
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Property
18
+
19
+
20
+ </th><th>
21
+
22
+ Modifiers
23
+
24
+
25
+ </th><th>
26
+
27
+ Type
28
+
29
+
30
+ </th><th>
31
+
32
+ Description
33
+
34
+
35
+ </th></tr></thead>
36
+ <tbody><tr><td>
37
+
38
+ [worldLoop](./server.worldloopeventpayload.stop.worldloop.md)
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td><td>
45
+
46
+ [WorldLoop](./server.worldloop.md)
47
+
48
+
49
+ </td><td>
50
+
51
+
52
+ </td></tr>
53
+ </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Stop](./server.worldloopeventpayload.stop.md) &gt; [worldLoop](./server.worldloopeventpayload.stop.worldloop.md)
4
+
5
+ ## WorldLoopEventPayload.Stop.worldLoop property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ worldLoop: WorldLoop;
11
+ ```
@@ -0,0 +1,70 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickEnd](./server.worldloopeventpayload.tickend.md)
4
+
5
+ ## WorldLoopEventPayload.TickEnd interface
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ interface TickEnd
11
+ ```
12
+
13
+ ## Properties
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Property
18
+
19
+
20
+ </th><th>
21
+
22
+ Modifiers
23
+
24
+
25
+ </th><th>
26
+
27
+ Type
28
+
29
+
30
+ </th><th>
31
+
32
+ Description
33
+
34
+
35
+ </th></tr></thead>
36
+ <tbody><tr><td>
37
+
38
+ [tickDurationMs](./server.worldloopeventpayload.tickend.tickdurationms.md)
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td><td>
45
+
46
+ number
47
+
48
+
49
+ </td><td>
50
+
51
+
52
+ </td></tr>
53
+ <tr><td>
54
+
55
+ [worldLoop](./server.worldloopeventpayload.tickend.worldloop.md)
56
+
57
+
58
+ </td><td>
59
+
60
+
61
+ </td><td>
62
+
63
+ [WorldLoop](./server.worldloop.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td></tr>
70
+ </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickEnd](./server.worldloopeventpayload.tickend.md) &gt; [tickDurationMs](./server.worldloopeventpayload.tickend.tickdurationms.md)
4
+
5
+ ## WorldLoopEventPayload.TickEnd.tickDurationMs property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ tickDurationMs: number;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickEnd](./server.worldloopeventpayload.tickend.md) &gt; [worldLoop](./server.worldloopeventpayload.tickend.worldloop.md)
4
+
5
+ ## WorldLoopEventPayload.TickEnd.worldLoop property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ worldLoop: WorldLoop;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickError](./server.worldloopeventpayload.tickerror.md) &gt; [error](./server.worldloopeventpayload.tickerror.error.md)
4
+
5
+ ## WorldLoopEventPayload.TickError.error property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ error: Error;
11
+ ```
@@ -0,0 +1,70 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickError](./server.worldloopeventpayload.tickerror.md)
4
+
5
+ ## WorldLoopEventPayload.TickError interface
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ interface TickError
11
+ ```
12
+
13
+ ## Properties
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Property
18
+
19
+
20
+ </th><th>
21
+
22
+ Modifiers
23
+
24
+
25
+ </th><th>
26
+
27
+ Type
28
+
29
+
30
+ </th><th>
31
+
32
+ Description
33
+
34
+
35
+ </th></tr></thead>
36
+ <tbody><tr><td>
37
+
38
+ [error](./server.worldloopeventpayload.tickerror.error.md)
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td><td>
45
+
46
+ Error
47
+
48
+
49
+ </td><td>
50
+
51
+
52
+ </td></tr>
53
+ <tr><td>
54
+
55
+ [worldLoop](./server.worldloopeventpayload.tickerror.worldloop.md)
56
+
57
+
58
+ </td><td>
59
+
60
+
61
+ </td><td>
62
+
63
+ [WorldLoop](./server.worldloop.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td></tr>
70
+ </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickError](./server.worldloopeventpayload.tickerror.md) &gt; [worldLoop](./server.worldloopeventpayload.tickerror.worldloop.md)
4
+
5
+ ## WorldLoopEventPayload.TickError.worldLoop property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ worldLoop: WorldLoop;
11
+ ```
@@ -0,0 +1,70 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickStart](./server.worldloopeventpayload.tickstart.md)
4
+
5
+ ## WorldLoopEventPayload.TickStart interface
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ interface TickStart
11
+ ```
12
+
13
+ ## Properties
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Property
18
+
19
+
20
+ </th><th>
21
+
22
+ Modifiers
23
+
24
+
25
+ </th><th>
26
+
27
+ Type
28
+
29
+
30
+ </th><th>
31
+
32
+ Description
33
+
34
+
35
+ </th></tr></thead>
36
+ <tbody><tr><td>
37
+
38
+ [tickDeltaMs](./server.worldloopeventpayload.tickstart.tickdeltams.md)
39
+
40
+
41
+ </td><td>
42
+
43
+
44
+ </td><td>
45
+
46
+ number
47
+
48
+
49
+ </td><td>
50
+
51
+
52
+ </td></tr>
53
+ <tr><td>
54
+
55
+ [worldLoop](./server.worldloopeventpayload.tickstart.worldloop.md)
56
+
57
+
58
+ </td><td>
59
+
60
+
61
+ </td><td>
62
+
63
+ [WorldLoop](./server.worldloop.md)
64
+
65
+
66
+ </td><td>
67
+
68
+
69
+ </td></tr>
70
+ </tbody></table>
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickStart](./server.worldloopeventpayload.tickstart.md) &gt; [tickDeltaMs](./server.worldloopeventpayload.tickstart.tickdeltams.md)
4
+
5
+ ## WorldLoopEventPayload.TickStart.tickDeltaMs property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ tickDeltaMs: number;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [TickStart](./server.worldloopeventpayload.tickstart.md) &gt; [worldLoop](./server.worldloopeventpayload.tickstart.worldloop.md)
4
+
5
+ ## WorldLoopEventPayload.TickStart.worldLoop property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ worldLoop: WorldLoop;
11
+ ```
@@ -0,0 +1,103 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventType](./server.worldloopeventtype.md)
4
+
5
+ ## WorldLoopEventType enum
6
+
7
+ Event types a WorldLoop instance can emit.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare enum WorldLoopEventType
13
+ ```
14
+
15
+ ## Enumeration Members
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Member
20
+
21
+
22
+ </th><th>
23
+
24
+ Value
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ START
36
+
37
+
38
+ </td><td>
39
+
40
+ `"WORLD_LOOP.START"`
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td></tr>
47
+ <tr><td>
48
+
49
+ STOP
50
+
51
+
52
+ </td><td>
53
+
54
+ `"WORLD_LOOP.STOP"`
55
+
56
+
57
+ </td><td>
58
+
59
+
60
+ </td></tr>
61
+ <tr><td>
62
+
63
+ TICK\_END
64
+
65
+
66
+ </td><td>
67
+
68
+ `"WORLD_LOOP.TICK_END"`
69
+
70
+
71
+ </td><td>
72
+
73
+
74
+ </td></tr>
75
+ <tr><td>
76
+
77
+ TICK\_ERROR
78
+
79
+
80
+ </td><td>
81
+
82
+ `"WORLD_LOOP.TICK_ERROR"`
83
+
84
+
85
+ </td><td>
86
+
87
+
88
+ </td></tr>
89
+ <tr><td>
90
+
91
+ TICK\_START
92
+
93
+
94
+ </td><td>
95
+
96
+ `"WORLD_LOOP.TICK_START"`
97
+
98
+
99
+ </td><td>
100
+
101
+
102
+ </td></tr>
103
+ </tbody></table>
@@ -1,6 +1,5 @@
1
1
  import {
2
2
  startServer,
3
- GameServer,
4
3
  PlayerEntity,
5
4
  } from 'hytopia';
6
5
 
@@ -29,7 +28,7 @@ startServer(world => {
29
28
  console.log('Creating custom player entity character controller...');
30
29
 
31
30
  return new MyCharacterController(playerEntity);
32
- }
31
+ };
33
32
 
34
33
  playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
35
34
  console.log('Spawned player entity!');
@@ -2,7 +2,6 @@ import {
2
2
  startServer,
3
3
  ColliderShape,
4
4
  Entity,
5
- GameServer,
6
5
  PlayerEntity,
7
6
  RigidBodyType,
8
7
  World,
@@ -50,7 +49,7 @@ startServer(world => {
50
49
  onCollision: (otherEntity, started) => {
51
50
  console.log('spider aggro-sensor colliding with', otherEntity.name, started);
52
51
  },
53
- }
52
+ },
54
53
  ],
55
54
  rotation: { x: 0, y: 0.4, z: 0, w: 0.6 }, // rotations are provided as a quaternion
56
55
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hytopia",
3
- "version": "0.1.25",
3
+ "version": "0.1.27",
4
4
  "description": "The HYTOPIA SDK makes it easy for developers to create multiplayer games on the HYTOPIA platform using JavaScript or TypeScript.",
5
5
  "main": "server.js",
6
6
  "bin": {