hytopia 0.4.3 → 0.5.0-dev
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/server.chunklattice.clear.md +17 -0
- package/docs/server.chunklattice.md +14 -0
- package/docs/server.collider.md +1 -1
- package/docs/server.collider.optionsfrommodeluri.md +18 -2
- package/docs/server.collideroptions.md +2 -2
- package/docs/server.collidershape.md +14 -0
- package/docs/server.defaultplayerentity._constructor_.md +47 -0
- package/docs/server.defaultplayerentity.md +61 -0
- package/docs/server.defaultplayerentitycontroller._constructor_.md +49 -0
- package/docs/{server.playerentitycontroller.attach.md → server.defaultplayerentitycontroller.attach.md} +2 -2
- package/docs/server.defaultplayerentitycontroller.autocancelmouseleftclick.md +13 -0
- package/docs/server.defaultplayerentitycontroller.canjump.md +13 -0
- package/docs/server.defaultplayerentitycontroller.canrun.md +13 -0
- package/docs/server.defaultplayerentitycontroller.canwalk.md +13 -0
- package/docs/server.defaultplayerentitycontroller.idleloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.interactoneshotanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.isgrounded.md +13 -0
- package/docs/server.defaultplayerentitycontroller.isonplatform.md +13 -0
- package/docs/server.defaultplayerentitycontroller.isswimming.md +13 -0
- package/docs/server.defaultplayerentitycontroller.jumponeshotanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.jumpvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.md +599 -0
- package/docs/server.defaultplayerentitycontroller.platform.md +13 -0
- package/docs/server.defaultplayerentitycontroller.runloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.runvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.spawn.md +53 -0
- package/docs/server.defaultplayerentitycontroller.stickstoplatforms.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimfastvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimgravity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimmaxgravityvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimslowvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontroller.swimupwardvelocity.md +13 -0
- package/docs/{server.playerentitycontroller.tickwithplayerinput.md → server.defaultplayerentitycontroller.tickwithplayerinput.md} +2 -2
- package/docs/server.defaultplayerentitycontroller.walkloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontroller.walkvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.canjump.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.canrun.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.canwalk.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.idleloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.interactoneshotanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.jumponeshotanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.jumpvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.md +399 -0
- package/docs/server.defaultplayerentitycontrolleroptions.runloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.runvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.stickstoplatforms.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimfastvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimgravity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimslowvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.walkloopedanimations.md +13 -0
- package/docs/server.defaultplayerentitycontrolleroptions.walkvelocity.md +13 -0
- package/docs/server.defaultplayerentityoptions.md +15 -0
- package/docs/server.entity.md +21 -0
- package/docs/server.entity.modelpreferredshape.md +13 -0
- package/docs/server.md +77 -22
- package/docs/server.modelboundingbox.md +18 -0
- package/docs/server.modelentityoptions.md +19 -0
- package/docs/server.modelentityoptions.modelpreferredshape.md +13 -0
- package/docs/server.modelregistry.getboundingbox.md +1 -1
- package/docs/server.modelregistry.gettrimesh.md +71 -0
- package/docs/server.modelregistry.md +14 -0
- package/docs/server.modeltrimesh.md +16 -0
- package/docs/server.playerentity.md +1 -1
- package/docs/server.wedgecollideroptions.extents.md +13 -0
- package/docs/server.wedgecollideroptions.md +75 -0
- package/docs/server.wedgecollideroptions.shape.md +11 -0
- package/docs/server.world.loadmap.md +1 -1
- package/docs/server.world.md +1 -1
- package/examples/ai-agents/index.ts +2 -6
- package/examples/big-world/index.ts +2 -5
- package/examples/block-entity/index.ts +2 -5
- package/examples/child-entity/index.ts +2 -5
- package/examples/custom-ui/index.ts +3 -6
- package/examples/entity-controller/index.ts +2 -5
- package/examples/entity-spawn/index.ts +2 -5
- package/examples/hole-in-wall-game/index.ts +8 -9
- package/examples/hygrounds/classes/GameManager.ts +1 -0
- package/examples/hygrounds/classes/GamePlayerEntity.ts +5 -6
- package/examples/lighting/index.ts +3 -6
- package/examples/mobile-controls/index.ts +2 -5
- package/examples/pathfinding/index.ts +2 -5
- package/examples/payload-game/index.ts +15 -17
- package/examples/player-persistence/index.ts +2 -5
- package/examples/wall-dodge-game/index.ts +8 -11
- package/examples/zombies-fps/classes/GamePlayerEntity.ts +5 -8
- package/package.json +1 -1
- package/server.api.json +10086 -9232
- package/server.d.ts +241 -147
- package/server.js +143 -129
- package/docs/server.playerentitycontroller._constructor_.md +0 -49
- package/docs/server.playerentitycontroller.autocancelmouseleftclick.md +0 -13
- package/docs/server.playerentitycontroller.canjump.md +0 -13
- package/docs/server.playerentitycontroller.canrun.md +0 -13
- package/docs/server.playerentitycontroller.canwalk.md +0 -13
- package/docs/server.playerentitycontroller.idleloopedanimations.md +0 -13
- package/docs/server.playerentitycontroller.interactoneshotanimations.md +0 -13
- package/docs/server.playerentitycontroller.isgrounded.md +0 -13
- package/docs/server.playerentitycontroller.isonplatform.md +0 -13
- package/docs/server.playerentitycontroller.jumponeshotanimations.md +0 -13
- package/docs/server.playerentitycontroller.jumpvelocity.md +0 -13
- package/docs/server.playerentitycontroller.md +0 -464
- package/docs/server.playerentitycontroller.platform.md +0 -13
- package/docs/server.playerentitycontroller.runloopedanimations.md +0 -13
- package/docs/server.playerentitycontroller.runvelocity.md +0 -13
- package/docs/server.playerentitycontroller.spawn.md +0 -53
- package/docs/server.playerentitycontroller.stickstoplatforms.md +0 -13
- package/docs/server.playerentitycontroller.walkloopedanimations.md +0 -13
- package/docs/server.playerentitycontroller.walkvelocity.md +0 -13
- package/docs/server.playerentitycontrolleroptions.autocancelmouseleftclick.md +0 -13
- package/docs/server.playerentitycontrolleroptions.canjump.md +0 -13
- package/docs/server.playerentitycontrolleroptions.canrun.md +0 -13
- package/docs/server.playerentitycontrolleroptions.canwalk.md +0 -13
- package/docs/server.playerentitycontrolleroptions.idleloopedanimations.md +0 -13
- package/docs/server.playerentitycontrolleroptions.interactoneshotanimations.md +0 -13
- package/docs/server.playerentitycontrolleroptions.jumponeshotanimations.md +0 -13
- package/docs/server.playerentitycontrolleroptions.jumpvelocity.md +0 -13
- package/docs/server.playerentitycontrolleroptions.md +0 -285
- package/docs/server.playerentitycontrolleroptions.runloopedanimations.md +0 -13
- package/docs/server.playerentitycontrolleroptions.runvelocity.md +0 -13
- package/docs/server.playerentitycontrolleroptions.stickstoplatforms.md +0 -13
- package/docs/server.playerentitycontrolleroptions.walkloopedanimations.md +0 -13
- package/docs/server.playerentitycontrolleroptions.walkvelocity.md +0 -13
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimGravity](./server.defaultplayerentitycontrolleroptions.swimgravity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.swimGravity property
|
6
|
+
|
7
|
+
The gravity modifier applied to the entity when swimming.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimGravity?: number;
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimLoopedAnimations](./server.defaultplayerentitycontrolleroptions.swimloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.swimLoopedAnimations property
|
6
|
+
|
7
|
+
The looped animation(s) that will play when the entity is swimming.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimLoopedAnimations?: string[];
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimMaxGravityVelocity](./server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.swimMaxGravityVelocity property
|
6
|
+
|
7
|
+
The maximum downward velocity that the entity can reach when affected by gravity while swimming.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimMaxGravityVelocity?: number;
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimSlowVelocity](./server.defaultplayerentitycontrolleroptions.swimslowvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.swimSlowVelocity property
|
6
|
+
|
7
|
+
The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimSlowVelocity?: number;
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimUpwardVelocity](./server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.swimUpwardVelocity property
|
6
|
+
|
7
|
+
The upward velocity applied to the entity when swimming.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimUpwardVelocity?: number;
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [walkLoopedAnimations](./server.defaultplayerentitycontrolleroptions.walkloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.walkLoopedAnimations property
|
6
|
+
|
7
|
+
Overrides the animation(s) that will play when the entity is walking.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
walkLoopedAnimations?: string[];
|
13
|
+
```
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [walkVelocity](./server.defaultplayerentitycontrolleroptions.walkvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.walkVelocity property
|
6
|
+
|
7
|
+
The normalized horizontal velocity applied to the entity when it walks.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
walkVelocity?: number;
|
13
|
+
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityOptions](./server.defaultplayerentityoptions.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityOptions type
|
6
|
+
|
7
|
+
Options for creating a DefaultPlayerEntity instance.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
export type DefaultPlayerEntityOptions = {} & PlayerEntityOptions;
|
13
|
+
```
|
14
|
+
**References:** [PlayerEntityOptions](./server.playerentityoptions.md)
|
15
|
+
|
package/docs/server.entity.md
CHANGED
@@ -336,6 +336,27 @@ ReadonlySet<string>
|
|
336
336
|
The looped animations to start when the entity is spawned.
|
337
337
|
|
338
338
|
|
339
|
+
</td></tr>
|
340
|
+
<tr><td>
|
341
|
+
|
342
|
+
[modelPreferredShape](./server.entity.modelpreferredshape.md)
|
343
|
+
|
344
|
+
|
345
|
+
</td><td>
|
346
|
+
|
347
|
+
`readonly`
|
348
|
+
|
349
|
+
|
350
|
+
</td><td>
|
351
|
+
|
352
|
+
[ColliderShape](./server.collidershape.md) \| undefined
|
353
|
+
|
354
|
+
|
355
|
+
</td><td>
|
356
|
+
|
357
|
+
The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
|
358
|
+
|
359
|
+
|
339
360
|
</td></tr>
|
340
361
|
<tr><td>
|
341
362
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [Entity](./server.entity.md) > [modelPreferredShape](./server.entity.modelpreferredshape.md)
|
4
|
+
|
5
|
+
## Entity.modelPreferredShape property
|
6
|
+
|
7
|
+
The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
get modelPreferredShape(): ColliderShape | undefined;
|
13
|
+
```
|
package/docs/server.md
CHANGED
@@ -126,6 +126,28 @@ Represents a collider in a world's physics simulation.
|
|
126
126
|
A helper class for building and decoding collision groups.
|
127
127
|
|
128
128
|
|
129
|
+
</td></tr>
|
130
|
+
<tr><td>
|
131
|
+
|
132
|
+
[DefaultPlayerEntity](./server.defaultplayerentity.md)
|
133
|
+
|
134
|
+
|
135
|
+
</td><td>
|
136
|
+
|
137
|
+
Represents the default player model entity.
|
138
|
+
|
139
|
+
|
140
|
+
</td></tr>
|
141
|
+
<tr><td>
|
142
|
+
|
143
|
+
[DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)
|
144
|
+
|
145
|
+
|
146
|
+
</td><td>
|
147
|
+
|
148
|
+
The player entity controller implementation.
|
149
|
+
|
150
|
+
|
129
151
|
</td></tr>
|
130
152
|
<tr><td>
|
131
153
|
|
@@ -302,17 +324,6 @@ The camera for a Player.
|
|
302
324
|
Represents an entity controlled by a player in a world.
|
303
325
|
|
304
326
|
|
305
|
-
</td></tr>
|
306
|
-
<tr><td>
|
307
|
-
|
308
|
-
[PlayerEntityController](./server.playerentitycontroller.md)
|
309
|
-
|
310
|
-
|
311
|
-
</td><td>
|
312
|
-
|
313
|
-
The player entity controller implementation.
|
314
|
-
|
315
|
-
|
316
327
|
</td></tr>
|
317
328
|
<tr><td>
|
318
329
|
|
@@ -956,6 +967,17 @@ The options for a cone collider.
|
|
956
967
|
The options for a cylinder collider.
|
957
968
|
|
958
969
|
|
970
|
+
</td></tr>
|
971
|
+
<tr><td>
|
972
|
+
|
973
|
+
[DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md)
|
974
|
+
|
975
|
+
|
976
|
+
</td><td>
|
977
|
+
|
978
|
+
Options for creating a DefaultPlayerEntityController instance.
|
979
|
+
|
980
|
+
|
959
981
|
</td></tr>
|
960
982
|
<tr><td>
|
961
983
|
|
@@ -1088,17 +1110,6 @@ The options for an error type "none" collider.
|
|
1088
1110
|
Event payloads for PlayerCamera emitted events.
|
1089
1111
|
|
1090
1112
|
|
1091
|
-
</td></tr>
|
1092
|
-
<tr><td>
|
1093
|
-
|
1094
|
-
[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
|
1095
|
-
|
1096
|
-
|
1097
|
-
</td><td>
|
1098
|
-
|
1099
|
-
Options for creating a PlayerEntityController instance.
|
1100
|
-
|
1101
|
-
|
1102
1113
|
</td></tr>
|
1103
1114
|
<tr><td>
|
1104
1115
|
|
@@ -1264,6 +1275,17 @@ A 3-dimensional vector of boolean values.
|
|
1264
1275
|
A 3-dimensional vector.
|
1265
1276
|
|
1266
1277
|
|
1278
|
+
</td></tr>
|
1279
|
+
<tr><td>
|
1280
|
+
|
1281
|
+
[WedgeColliderOptions](./server.wedgecollideroptions.md)
|
1282
|
+
|
1283
|
+
|
1284
|
+
</td><td>
|
1285
|
+
|
1286
|
+
The options for a wedge collider.
|
1287
|
+
|
1288
|
+
|
1267
1289
|
</td></tr>
|
1268
1290
|
<tr><td>
|
1269
1291
|
|
@@ -1448,6 +1470,17 @@ A contact manifold.
|
|
1448
1470
|
A decoded set of collision groups represented as their string equivalents.
|
1449
1471
|
|
1450
1472
|
|
1473
|
+
</td></tr>
|
1474
|
+
<tr><td>
|
1475
|
+
|
1476
|
+
[DefaultPlayerEntityOptions](./server.defaultplayerentityoptions.md)
|
1477
|
+
|
1478
|
+
|
1479
|
+
</td><td>
|
1480
|
+
|
1481
|
+
Options for creating a DefaultPlayerEntity instance.
|
1482
|
+
|
1483
|
+
|
1451
1484
|
</td></tr>
|
1452
1485
|
<tr><td>
|
1453
1486
|
|
@@ -1492,6 +1525,28 @@ A callback function called when the entity associated with the SimpleEntityContr
|
|
1492
1525
|
Options for the [SimpleEntityController.face()](./server.simpleentitycontroller.face.md) method.
|
1493
1526
|
|
1494
1527
|
|
1528
|
+
</td></tr>
|
1529
|
+
<tr><td>
|
1530
|
+
|
1531
|
+
[ModelBoundingBox](./server.modelboundingbox.md)
|
1532
|
+
|
1533
|
+
|
1534
|
+
</td><td>
|
1535
|
+
|
1536
|
+
A bounding box for a model.
|
1537
|
+
|
1538
|
+
|
1539
|
+
</td></tr>
|
1540
|
+
<tr><td>
|
1541
|
+
|
1542
|
+
[ModelTrimesh](./server.modeltrimesh.md)
|
1543
|
+
|
1544
|
+
|
1545
|
+
</td><td>
|
1546
|
+
|
1547
|
+
A trimesh for a model.
|
1548
|
+
|
1549
|
+
|
1495
1550
|
</td></tr>
|
1496
1551
|
<tr><td>
|
1497
1552
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [ModelBoundingBox](./server.modelboundingbox.md)
|
4
|
+
|
5
|
+
## ModelBoundingBox type
|
6
|
+
|
7
|
+
A bounding box for a model.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
export type ModelBoundingBox = {
|
13
|
+
min: Vector3Like;
|
14
|
+
max: Vector3Like;
|
15
|
+
};
|
16
|
+
```
|
17
|
+
**References:** [Vector3Like](./server.vector3like.md)
|
18
|
+
|
@@ -92,6 +92,25 @@ string\[\]
|
|
92
92
|
_(Optional)_ The looped animations to start when the entity is spawned.
|
93
93
|
|
94
94
|
|
95
|
+
</td></tr>
|
96
|
+
<tr><td>
|
97
|
+
|
98
|
+
[modelPreferredShape?](./server.modelentityoptions.modelpreferredshape.md)
|
99
|
+
|
100
|
+
|
101
|
+
</td><td>
|
102
|
+
|
103
|
+
|
104
|
+
</td><td>
|
105
|
+
|
106
|
+
[ColliderShape](./server.collidershape.md)
|
107
|
+
|
108
|
+
|
109
|
+
</td><td>
|
110
|
+
|
111
|
+
_(Optional)_ The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
|
112
|
+
|
113
|
+
|
95
114
|
</td></tr>
|
96
115
|
<tr><td>
|
97
116
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [ModelEntityOptions](./server.modelentityoptions.md) > [modelPreferredShape](./server.modelentityoptions.modelpreferredshape.md)
|
4
|
+
|
5
|
+
## ModelEntityOptions.modelPreferredShape property
|
6
|
+
|
7
|
+
The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
modelPreferredShape?: ColliderShape;
|
13
|
+
```
|
@@ -0,0 +1,71 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [ModelRegistry](./server.modelregistry.md) > [getTrimesh](./server.modelregistry.gettrimesh.md)
|
4
|
+
|
5
|
+
## ModelRegistry.getTrimesh() method
|
6
|
+
|
7
|
+
Retrieves the trimesh of a model.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
getTrimesh(modelUri: string, scale?: number): ModelTrimesh | undefined;
|
13
|
+
```
|
14
|
+
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
<table><thead><tr><th>
|
18
|
+
|
19
|
+
Parameter
|
20
|
+
|
21
|
+
|
22
|
+
</th><th>
|
23
|
+
|
24
|
+
Type
|
25
|
+
|
26
|
+
|
27
|
+
</th><th>
|
28
|
+
|
29
|
+
Description
|
30
|
+
|
31
|
+
|
32
|
+
</th></tr></thead>
|
33
|
+
<tbody><tr><td>
|
34
|
+
|
35
|
+
modelUri
|
36
|
+
|
37
|
+
|
38
|
+
</td><td>
|
39
|
+
|
40
|
+
string
|
41
|
+
|
42
|
+
|
43
|
+
</td><td>
|
44
|
+
|
45
|
+
The URI of the model to retrieve the trimesh for.
|
46
|
+
|
47
|
+
|
48
|
+
</td></tr>
|
49
|
+
<tr><td>
|
50
|
+
|
51
|
+
scale
|
52
|
+
|
53
|
+
|
54
|
+
</td><td>
|
55
|
+
|
56
|
+
number
|
57
|
+
|
58
|
+
|
59
|
+
</td><td>
|
60
|
+
|
61
|
+
_(Optional)_ Optional uniform scaling to apply to the trimesh. Defaults to 1, which is no scaling.
|
62
|
+
|
63
|
+
|
64
|
+
</td></tr>
|
65
|
+
</tbody></table>
|
66
|
+
**Returns:**
|
67
|
+
|
68
|
+
[ModelTrimesh](./server.modeltrimesh.md) \| undefined
|
69
|
+
|
70
|
+
The trimesh of the model.
|
71
|
+
|
@@ -173,6 +173,20 @@ Retrieves the Y-axis height of a model for a scale of 1.
|
|
173
173
|
Retrieves the names of all nodes in a model.
|
174
174
|
|
175
175
|
|
176
|
+
</td></tr>
|
177
|
+
<tr><td>
|
178
|
+
|
179
|
+
[getTrimesh(modelUri, scale)](./server.modelregistry.gettrimesh.md)
|
180
|
+
|
181
|
+
|
182
|
+
</td><td>
|
183
|
+
|
184
|
+
|
185
|
+
</td><td>
|
186
|
+
|
187
|
+
Retrieves the trimesh of a model.
|
188
|
+
|
189
|
+
|
176
190
|
</td></tr>
|
177
191
|
<tr><td>
|
178
192
|
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [ModelTrimesh](./server.modeltrimesh.md)
|
4
|
+
|
5
|
+
## ModelTrimesh type
|
6
|
+
|
7
|
+
A trimesh for a model.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
export type ModelTrimesh = {
|
13
|
+
vertices: Float32Array;
|
14
|
+
indices: Uint32Array;
|
15
|
+
};
|
16
|
+
```
|
@@ -15,7 +15,7 @@ export default class PlayerEntity extends Entity
|
|
15
15
|
|
16
16
|
## Remarks
|
17
17
|
|
18
|
-
Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player when a player joins a world. PlayerEntity
|
18
|
+
Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player at anytime during gameplay, but most commonly when a player joins a world. PlayerEntity expects a controller to be set prior to spawning. Without setting a controller, the player entity will not respond to player inputs and throw an error.
|
19
19
|
|
20
20
|
## Example
|
21
21
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [WedgeColliderOptions](./server.wedgecollideroptions.md) > [extents](./server.wedgecollideroptions.extents.md)
|
4
|
+
|
5
|
+
## WedgeColliderOptions.extents property
|
6
|
+
|
7
|
+
The extents of the wedge collider, defining full width (x), height (y), and length (z).
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
extents?: Vector3Like;
|
13
|
+
```
|
@@ -0,0 +1,75 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [WedgeColliderOptions](./server.wedgecollideroptions.md)
|
4
|
+
|
5
|
+
## WedgeColliderOptions interface
|
6
|
+
|
7
|
+
The options for a wedge collider.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
export interface WedgeColliderOptions extends BaseColliderOptions
|
13
|
+
```
|
14
|
+
**Extends:** [BaseColliderOptions](./server.basecollideroptions.md)
|
15
|
+
|
16
|
+
## Properties
|
17
|
+
|
18
|
+
<table><thead><tr><th>
|
19
|
+
|
20
|
+
Property
|
21
|
+
|
22
|
+
|
23
|
+
</th><th>
|
24
|
+
|
25
|
+
Modifiers
|
26
|
+
|
27
|
+
|
28
|
+
</th><th>
|
29
|
+
|
30
|
+
Type
|
31
|
+
|
32
|
+
|
33
|
+
</th><th>
|
34
|
+
|
35
|
+
Description
|
36
|
+
|
37
|
+
|
38
|
+
</th></tr></thead>
|
39
|
+
<tbody><tr><td>
|
40
|
+
|
41
|
+
[extents?](./server.wedgecollideroptions.extents.md)
|
42
|
+
|
43
|
+
|
44
|
+
</td><td>
|
45
|
+
|
46
|
+
|
47
|
+
</td><td>
|
48
|
+
|
49
|
+
[Vector3Like](./server.vector3like.md)
|
50
|
+
|
51
|
+
|
52
|
+
</td><td>
|
53
|
+
|
54
|
+
_(Optional)_ The extents of the wedge collider, defining full width (x), height (y), and length (z).
|
55
|
+
|
56
|
+
|
57
|
+
</td></tr>
|
58
|
+
<tr><td>
|
59
|
+
|
60
|
+
[shape](./server.wedgecollideroptions.shape.md)
|
61
|
+
|
62
|
+
|
63
|
+
</td><td>
|
64
|
+
|
65
|
+
|
66
|
+
</td><td>
|
67
|
+
|
68
|
+
[ColliderShape.WEDGE](./server.collidershape.md)
|
69
|
+
|
70
|
+
|
71
|
+
</td><td>
|
72
|
+
|
73
|
+
|
74
|
+
</td></tr>
|
75
|
+
</tbody></table>
|
@@ -0,0 +1,11 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [server](./server.md) > [WedgeColliderOptions](./server.wedgecollideroptions.md) > [shape](./server.wedgecollideroptions.shape.md)
|
4
|
+
|
5
|
+
## WedgeColliderOptions.shape property
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
shape: ColliderShape.WEDGE;
|
11
|
+
```
|
package/docs/server.world.md
CHANGED
@@ -27,8 +27,7 @@ import {
|
|
27
27
|
startServer,
|
28
28
|
Audio,
|
29
29
|
ChatEvent,
|
30
|
-
|
31
|
-
PlayerEntity,
|
30
|
+
DefaultPlayerEntity,
|
32
31
|
PlayerEvent,
|
33
32
|
Vector3,
|
34
33
|
} from "hytopia";
|
@@ -94,12 +93,9 @@ startServer((world) => {
|
|
94
93
|
* internally uses our player entity controller.
|
95
94
|
*/
|
96
95
|
world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
|
97
|
-
const playerEntity = new
|
96
|
+
const playerEntity = new DefaultPlayerEntity({
|
98
97
|
player,
|
99
98
|
name: "Player",
|
100
|
-
modelUri: "models/players/player.gltf",
|
101
|
-
modelLoopedAnimations: ["idle"],
|
102
|
-
modelScale: 0.5,
|
103
99
|
});
|
104
100
|
|
105
101
|
playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import {
|
2
2
|
startServer,
|
3
|
-
|
3
|
+
DefaultPlayerEntity,
|
4
4
|
PlayerEvent,
|
5
5
|
} from 'hytopia';
|
6
6
|
|
@@ -24,12 +24,9 @@ startServer(world => {
|
|
24
24
|
|
25
25
|
// Spawn a player entity when a player joins the game.
|
26
26
|
world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
|
27
|
-
const playerEntity = new
|
27
|
+
const playerEntity = new DefaultPlayerEntity({
|
28
28
|
player,
|
29
29
|
name: 'Player',
|
30
|
-
modelUri: 'models/players/player.gltf',
|
31
|
-
modelLoopedAnimations: [ 'idle' ],
|
32
|
-
modelScale: 0.5,
|
33
30
|
});
|
34
31
|
|
35
32
|
playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
|