hytopia 0.4.4 → 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.
Files changed (123) hide show
  1. package/docs/server.collider.md +1 -1
  2. package/docs/server.collider.optionsfrommodeluri.md +18 -2
  3. package/docs/server.collideroptions.md +2 -2
  4. package/docs/server.collidershape.md +14 -0
  5. package/docs/server.defaultplayerentity._constructor_.md +47 -0
  6. package/docs/server.defaultplayerentity.md +61 -0
  7. package/docs/server.defaultplayerentitycontroller._constructor_.md +49 -0
  8. package/docs/{server.playerentitycontroller.attach.md → server.defaultplayerentitycontroller.attach.md} +2 -2
  9. package/docs/server.defaultplayerentitycontroller.autocancelmouseleftclick.md +13 -0
  10. package/docs/server.defaultplayerentitycontroller.canjump.md +13 -0
  11. package/docs/server.defaultplayerentitycontroller.canrun.md +13 -0
  12. package/docs/server.defaultplayerentitycontroller.canwalk.md +13 -0
  13. package/docs/server.defaultplayerentitycontroller.idleloopedanimations.md +13 -0
  14. package/docs/server.defaultplayerentitycontroller.interactoneshotanimations.md +13 -0
  15. package/docs/server.defaultplayerentitycontroller.isgrounded.md +13 -0
  16. package/docs/server.defaultplayerentitycontroller.isonplatform.md +13 -0
  17. package/docs/server.defaultplayerentitycontroller.isswimming.md +13 -0
  18. package/docs/server.defaultplayerentitycontroller.jumponeshotanimations.md +13 -0
  19. package/docs/server.defaultplayerentitycontroller.jumpvelocity.md +13 -0
  20. package/docs/server.defaultplayerentitycontroller.md +599 -0
  21. package/docs/server.defaultplayerentitycontroller.platform.md +13 -0
  22. package/docs/server.defaultplayerentitycontroller.runloopedanimations.md +13 -0
  23. package/docs/server.defaultplayerentitycontroller.runvelocity.md +13 -0
  24. package/docs/server.defaultplayerentitycontroller.spawn.md +53 -0
  25. package/docs/server.defaultplayerentitycontroller.stickstoplatforms.md +13 -0
  26. package/docs/server.defaultplayerentitycontroller.swimfastvelocity.md +13 -0
  27. package/docs/server.defaultplayerentitycontroller.swimgravity.md +13 -0
  28. package/docs/server.defaultplayerentitycontroller.swimloopedanimations.md +13 -0
  29. package/docs/server.defaultplayerentitycontroller.swimmaxgravityvelocity.md +13 -0
  30. package/docs/server.defaultplayerentitycontroller.swimslowvelocity.md +13 -0
  31. package/docs/server.defaultplayerentitycontroller.swimupwardvelocity.md +13 -0
  32. package/docs/{server.playerentitycontroller.tickwithplayerinput.md → server.defaultplayerentitycontroller.tickwithplayerinput.md} +2 -2
  33. package/docs/server.defaultplayerentitycontroller.walkloopedanimations.md +13 -0
  34. package/docs/server.defaultplayerentitycontroller.walkvelocity.md +13 -0
  35. package/docs/server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md +13 -0
  36. package/docs/server.defaultplayerentitycontrolleroptions.canjump.md +13 -0
  37. package/docs/server.defaultplayerentitycontrolleroptions.canrun.md +13 -0
  38. package/docs/server.defaultplayerentitycontrolleroptions.canwalk.md +13 -0
  39. package/docs/server.defaultplayerentitycontrolleroptions.idleloopedanimations.md +13 -0
  40. package/docs/server.defaultplayerentitycontrolleroptions.interactoneshotanimations.md +13 -0
  41. package/docs/server.defaultplayerentitycontrolleroptions.jumponeshotanimations.md +13 -0
  42. package/docs/server.defaultplayerentitycontrolleroptions.jumpvelocity.md +13 -0
  43. package/docs/server.defaultplayerentitycontrolleroptions.md +399 -0
  44. package/docs/server.defaultplayerentitycontrolleroptions.runloopedanimations.md +13 -0
  45. package/docs/server.defaultplayerentitycontrolleroptions.runvelocity.md +13 -0
  46. package/docs/server.defaultplayerentitycontrolleroptions.stickstoplatforms.md +13 -0
  47. package/docs/server.defaultplayerentitycontrolleroptions.swimfastvelocity.md +13 -0
  48. package/docs/server.defaultplayerentitycontrolleroptions.swimgravity.md +13 -0
  49. package/docs/server.defaultplayerentitycontrolleroptions.swimloopedanimations.md +13 -0
  50. package/docs/server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md +13 -0
  51. package/docs/server.defaultplayerentitycontrolleroptions.swimslowvelocity.md +13 -0
  52. package/docs/server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md +13 -0
  53. package/docs/server.defaultplayerentitycontrolleroptions.walkloopedanimations.md +13 -0
  54. package/docs/server.defaultplayerentitycontrolleroptions.walkvelocity.md +13 -0
  55. package/docs/server.defaultplayerentityoptions.md +15 -0
  56. package/docs/server.entity.md +21 -0
  57. package/docs/server.entity.modelpreferredshape.md +13 -0
  58. package/docs/server.md +77 -22
  59. package/docs/server.modelboundingbox.md +18 -0
  60. package/docs/server.modelentityoptions.md +19 -0
  61. package/docs/server.modelentityoptions.modelpreferredshape.md +13 -0
  62. package/docs/server.modelregistry.getboundingbox.md +1 -1
  63. package/docs/server.modelregistry.gettrimesh.md +71 -0
  64. package/docs/server.modelregistry.md +14 -0
  65. package/docs/server.modeltrimesh.md +16 -0
  66. package/docs/server.playerentity.md +1 -1
  67. package/docs/server.wedgecollideroptions.extents.md +13 -0
  68. package/docs/server.wedgecollideroptions.md +75 -0
  69. package/docs/server.wedgecollideroptions.shape.md +11 -0
  70. package/examples/ai-agents/index.ts +2 -6
  71. package/examples/big-world/index.ts +2 -5
  72. package/examples/block-entity/index.ts +2 -5
  73. package/examples/child-entity/index.ts +2 -5
  74. package/examples/custom-ui/index.ts +3 -6
  75. package/examples/entity-controller/index.ts +2 -5
  76. package/examples/entity-spawn/index.ts +2 -5
  77. package/examples/hole-in-wall-game/index.ts +8 -9
  78. package/examples/hygrounds/classes/GameManager.ts +1 -0
  79. package/examples/hygrounds/classes/GamePlayerEntity.ts +5 -6
  80. package/examples/lighting/index.ts +3 -6
  81. package/examples/mobile-controls/index.ts +2 -5
  82. package/examples/pathfinding/index.ts +2 -5
  83. package/examples/payload-game/index.ts +15 -17
  84. package/examples/player-persistence/index.ts +2 -5
  85. package/examples/wall-dodge-game/index.ts +8 -11
  86. package/examples/zombies-fps/classes/GamePlayerEntity.ts +5 -8
  87. package/package.json +1 -1
  88. package/server.api.json +10133 -9310
  89. package/server.d.ts +236 -146
  90. package/server.js +143 -129
  91. package/docs/server.playerentitycontroller._constructor_.md +0 -49
  92. package/docs/server.playerentitycontroller.autocancelmouseleftclick.md +0 -13
  93. package/docs/server.playerentitycontroller.canjump.md +0 -13
  94. package/docs/server.playerentitycontroller.canrun.md +0 -13
  95. package/docs/server.playerentitycontroller.canwalk.md +0 -13
  96. package/docs/server.playerentitycontroller.idleloopedanimations.md +0 -13
  97. package/docs/server.playerentitycontroller.interactoneshotanimations.md +0 -13
  98. package/docs/server.playerentitycontroller.isgrounded.md +0 -13
  99. package/docs/server.playerentitycontroller.isonplatform.md +0 -13
  100. package/docs/server.playerentitycontroller.jumponeshotanimations.md +0 -13
  101. package/docs/server.playerentitycontroller.jumpvelocity.md +0 -13
  102. package/docs/server.playerentitycontroller.md +0 -464
  103. package/docs/server.playerentitycontroller.platform.md +0 -13
  104. package/docs/server.playerentitycontroller.runloopedanimations.md +0 -13
  105. package/docs/server.playerentitycontroller.runvelocity.md +0 -13
  106. package/docs/server.playerentitycontroller.spawn.md +0 -53
  107. package/docs/server.playerentitycontroller.stickstoplatforms.md +0 -13
  108. package/docs/server.playerentitycontroller.walkloopedanimations.md +0 -13
  109. package/docs/server.playerentitycontroller.walkvelocity.md +0 -13
  110. package/docs/server.playerentitycontrolleroptions.autocancelmouseleftclick.md +0 -13
  111. package/docs/server.playerentitycontrolleroptions.canjump.md +0 -13
  112. package/docs/server.playerentitycontrolleroptions.canrun.md +0 -13
  113. package/docs/server.playerentitycontrolleroptions.canwalk.md +0 -13
  114. package/docs/server.playerentitycontrolleroptions.idleloopedanimations.md +0 -13
  115. package/docs/server.playerentitycontrolleroptions.interactoneshotanimations.md +0 -13
  116. package/docs/server.playerentitycontrolleroptions.jumponeshotanimations.md +0 -13
  117. package/docs/server.playerentitycontrolleroptions.jumpvelocity.md +0 -13
  118. package/docs/server.playerentitycontrolleroptions.md +0 -285
  119. package/docs/server.playerentitycontrolleroptions.runloopedanimations.md +0 -13
  120. package/docs/server.playerentitycontrolleroptions.runvelocity.md +0 -13
  121. package/docs/server.playerentitycontrolleroptions.stickstoplatforms.md +0 -13
  122. package/docs/server.playerentitycontrolleroptions.walkloopedanimations.md +0 -13
  123. package/docs/server.playerentitycontrolleroptions.walkvelocity.md +0 -13
@@ -0,0 +1,599 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)
4
+
5
+ ## DefaultPlayerEntityController class
6
+
7
+ The player entity controller implementation.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export default class DefaultPlayerEntityController extends BaseEntityController
13
+ ```
14
+ **Extends:** [BaseEntityController](./server.baseentitycontroller.md)
15
+
16
+ ## Remarks
17
+
18
+ This class extends [BaseEntityController](./server.baseentitycontroller.md) and implements the default movement, platforming, jump, swimming, and other basic logic for the default player entity. We recommend you extend this class if you'd like to implement additional logic on top of the DefaultPlayerEntityController implementation.
19
+
20
+ ## Example
21
+
22
+
23
+ ```typescript
24
+ // Create a custom entity controller for myEntity, prior to spawning it.
25
+ myEntity.setController(new DefaultPlayerEntityController({
26
+ jumpVelocity: 10,
27
+ runVelocity: 8,
28
+ walkVelocity: 4,
29
+ }));
30
+
31
+ // Spawn the entity in the world.
32
+ myEntity.spawn(world, { x: 53, y: 10, z: 23 });
33
+ ```
34
+
35
+ ## Constructors
36
+
37
+ <table><thead><tr><th>
38
+
39
+ Constructor
40
+
41
+
42
+ </th><th>
43
+
44
+ Modifiers
45
+
46
+
47
+ </th><th>
48
+
49
+ Description
50
+
51
+
52
+ </th></tr></thead>
53
+ <tbody><tr><td>
54
+
55
+ [(constructor)(options)](./server.defaultplayerentitycontroller._constructor_.md)
56
+
57
+
58
+ </td><td>
59
+
60
+
61
+ </td><td>
62
+
63
+ Constructs a new instance of the `DefaultPlayerEntityController` class
64
+
65
+
66
+ </td></tr>
67
+ </tbody></table>
68
+
69
+ ## Properties
70
+
71
+ <table><thead><tr><th>
72
+
73
+ Property
74
+
75
+
76
+ </th><th>
77
+
78
+ Modifiers
79
+
80
+
81
+ </th><th>
82
+
83
+ Type
84
+
85
+
86
+ </th><th>
87
+
88
+ Description
89
+
90
+
91
+ </th></tr></thead>
92
+ <tbody><tr><td>
93
+
94
+ [autoCancelMouseLeftClick](./server.defaultplayerentitycontroller.autocancelmouseleftclick.md)
95
+
96
+
97
+ </td><td>
98
+
99
+
100
+ </td><td>
101
+
102
+ boolean
103
+
104
+
105
+ </td><td>
106
+
107
+ Whether to automatically cancel left click input after first processed tick, defaults to true.
108
+
109
+
110
+ </td></tr>
111
+ <tr><td>
112
+
113
+ [canJump](./server.defaultplayerentitycontroller.canjump.md)
114
+
115
+
116
+ </td><td>
117
+
118
+
119
+ </td><td>
120
+
121
+ (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)<!-- -->) =&gt; boolean
122
+
123
+
124
+ </td><td>
125
+
126
+ A function allowing custom logic to determine if the entity can jump.
127
+
128
+
129
+ </td></tr>
130
+ <tr><td>
131
+
132
+ [canRun](./server.defaultplayerentitycontroller.canrun.md)
133
+
134
+
135
+ </td><td>
136
+
137
+
138
+ </td><td>
139
+
140
+ (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)<!-- -->) =&gt; boolean
141
+
142
+
143
+ </td><td>
144
+
145
+ A function allowing custom logic to determine if the entity can run.
146
+
147
+
148
+ </td></tr>
149
+ <tr><td>
150
+
151
+ [canWalk](./server.defaultplayerentitycontroller.canwalk.md)
152
+
153
+
154
+ </td><td>
155
+
156
+
157
+ </td><td>
158
+
159
+ (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)<!-- -->) =&gt; boolean
160
+
161
+
162
+ </td><td>
163
+
164
+ A function allowing custom logic to determine if the entity can walk.
165
+
166
+
167
+ </td></tr>
168
+ <tr><td>
169
+
170
+ [idleLoopedAnimations](./server.defaultplayerentitycontroller.idleloopedanimations.md)
171
+
172
+
173
+ </td><td>
174
+
175
+
176
+ </td><td>
177
+
178
+ string\[\]
179
+
180
+
181
+ </td><td>
182
+
183
+ The looped animation(s) that will play when the entity is idle.
184
+
185
+
186
+ </td></tr>
187
+ <tr><td>
188
+
189
+ [interactOneshotAnimations](./server.defaultplayerentitycontroller.interactoneshotanimations.md)
190
+
191
+
192
+ </td><td>
193
+
194
+
195
+ </td><td>
196
+
197
+ string\[\]
198
+
199
+
200
+ </td><td>
201
+
202
+ The oneshot animation(s) that will play when the entity interacts (left click)
203
+
204
+
205
+ </td></tr>
206
+ <tr><td>
207
+
208
+ [isGrounded](./server.defaultplayerentitycontroller.isgrounded.md)
209
+
210
+
211
+ </td><td>
212
+
213
+ `readonly`
214
+
215
+
216
+ </td><td>
217
+
218
+ boolean
219
+
220
+
221
+ </td><td>
222
+
223
+ Whether the entity is grounded.
224
+
225
+
226
+ </td></tr>
227
+ <tr><td>
228
+
229
+ [isOnPlatform](./server.defaultplayerentitycontroller.isonplatform.md)
230
+
231
+
232
+ </td><td>
233
+
234
+ `readonly`
235
+
236
+
237
+ </td><td>
238
+
239
+ boolean
240
+
241
+
242
+ </td><td>
243
+
244
+ Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
245
+
246
+
247
+ </td></tr>
248
+ <tr><td>
249
+
250
+ [isSwimming](./server.defaultplayerentitycontroller.isswimming.md)
251
+
252
+
253
+ </td><td>
254
+
255
+ `readonly`
256
+
257
+
258
+ </td><td>
259
+
260
+ boolean
261
+
262
+
263
+ </td><td>
264
+
265
+ Whether the entity is swimming, this is determined by if the entity is in a liquid block.
266
+
267
+
268
+ </td></tr>
269
+ <tr><td>
270
+
271
+ [jumpOneshotAnimations](./server.defaultplayerentitycontroller.jumponeshotanimations.md)
272
+
273
+
274
+ </td><td>
275
+
276
+
277
+ </td><td>
278
+
279
+ string\[\]
280
+
281
+
282
+ </td><td>
283
+
284
+ The oneshot animation(s) that will play when the entity is jumping.
285
+
286
+
287
+ </td></tr>
288
+ <tr><td>
289
+
290
+ [jumpVelocity](./server.defaultplayerentitycontroller.jumpvelocity.md)
291
+
292
+
293
+ </td><td>
294
+
295
+
296
+ </td><td>
297
+
298
+ number
299
+
300
+
301
+ </td><td>
302
+
303
+ The upward velocity applied to the entity when it jumps.
304
+
305
+
306
+ </td></tr>
307
+ <tr><td>
308
+
309
+ [platform](./server.defaultplayerentitycontroller.platform.md)
310
+
311
+
312
+ </td><td>
313
+
314
+ `readonly`
315
+
316
+
317
+ </td><td>
318
+
319
+ [Entity](./server.entity.md) \| undefined
320
+
321
+
322
+ </td><td>
323
+
324
+ The platform the entity is on, if any.
325
+
326
+
327
+ </td></tr>
328
+ <tr><td>
329
+
330
+ [runLoopedAnimations](./server.defaultplayerentitycontroller.runloopedanimations.md)
331
+
332
+
333
+ </td><td>
334
+
335
+
336
+ </td><td>
337
+
338
+ string\[\]
339
+
340
+
341
+ </td><td>
342
+
343
+ The looped animation(s) that will play when the entity is running.
344
+
345
+
346
+ </td></tr>
347
+ <tr><td>
348
+
349
+ [runVelocity](./server.defaultplayerentitycontroller.runvelocity.md)
350
+
351
+
352
+ </td><td>
353
+
354
+
355
+ </td><td>
356
+
357
+ number
358
+
359
+
360
+ </td><td>
361
+
362
+ The normalized horizontal velocity applied to the entity when it runs.
363
+
364
+
365
+ </td></tr>
366
+ <tr><td>
367
+
368
+ [sticksToPlatforms](./server.defaultplayerentitycontroller.stickstoplatforms.md)
369
+
370
+
371
+ </td><td>
372
+
373
+
374
+ </td><td>
375
+
376
+ boolean
377
+
378
+
379
+ </td><td>
380
+
381
+ Whether the entity sticks to platforms.
382
+
383
+
384
+ </td></tr>
385
+ <tr><td>
386
+
387
+ [swimFastVelocity](./server.defaultplayerentitycontroller.swimfastvelocity.md)
388
+
389
+
390
+ </td><td>
391
+
392
+
393
+ </td><td>
394
+
395
+ number
396
+
397
+
398
+ </td><td>
399
+
400
+ The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
401
+
402
+
403
+ </td></tr>
404
+ <tr><td>
405
+
406
+ [swimGravity](./server.defaultplayerentitycontroller.swimgravity.md)
407
+
408
+
409
+ </td><td>
410
+
411
+
412
+ </td><td>
413
+
414
+ number
415
+
416
+
417
+ </td><td>
418
+
419
+ The gravity modifier applied to the entity when swimming.
420
+
421
+
422
+ </td></tr>
423
+ <tr><td>
424
+
425
+ [swimLoopedAnimations](./server.defaultplayerentitycontroller.swimloopedanimations.md)
426
+
427
+
428
+ </td><td>
429
+
430
+
431
+ </td><td>
432
+
433
+ string\[\]
434
+
435
+
436
+ </td><td>
437
+
438
+ The looped animation(s) that will play when the entity is swimming.
439
+
440
+
441
+ </td></tr>
442
+ <tr><td>
443
+
444
+ [swimMaxGravityVelocity](./server.defaultplayerentitycontroller.swimmaxgravityvelocity.md)
445
+
446
+
447
+ </td><td>
448
+
449
+
450
+ </td><td>
451
+
452
+ number
453
+
454
+
455
+ </td><td>
456
+
457
+ The maximum downward velocity that the entity can reach when affected by gravity while swimming.
458
+
459
+
460
+ </td></tr>
461
+ <tr><td>
462
+
463
+ [swimSlowVelocity](./server.defaultplayerentitycontroller.swimslowvelocity.md)
464
+
465
+
466
+ </td><td>
467
+
468
+
469
+ </td><td>
470
+
471
+ number
472
+
473
+
474
+ </td><td>
475
+
476
+ The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
477
+
478
+
479
+ </td></tr>
480
+ <tr><td>
481
+
482
+ [swimUpwardVelocity](./server.defaultplayerentitycontroller.swimupwardvelocity.md)
483
+
484
+
485
+ </td><td>
486
+
487
+
488
+ </td><td>
489
+
490
+ number
491
+
492
+
493
+ </td><td>
494
+
495
+ The upward velocity applied to the entity when swimming.
496
+
497
+
498
+ </td></tr>
499
+ <tr><td>
500
+
501
+ [walkLoopedAnimations](./server.defaultplayerentitycontroller.walkloopedanimations.md)
502
+
503
+
504
+ </td><td>
505
+
506
+
507
+ </td><td>
508
+
509
+ string\[\]
510
+
511
+
512
+ </td><td>
513
+
514
+ The looped animation(s) that will play when the entity is walking.
515
+
516
+
517
+ </td></tr>
518
+ <tr><td>
519
+
520
+ [walkVelocity](./server.defaultplayerentitycontroller.walkvelocity.md)
521
+
522
+
523
+ </td><td>
524
+
525
+
526
+ </td><td>
527
+
528
+ number
529
+
530
+
531
+ </td><td>
532
+
533
+ The normalized horizontal velocity applied to the entity when it walks.
534
+
535
+
536
+ </td></tr>
537
+ </tbody></table>
538
+
539
+ ## Methods
540
+
541
+ <table><thead><tr><th>
542
+
543
+ Method
544
+
545
+
546
+ </th><th>
547
+
548
+ Modifiers
549
+
550
+
551
+ </th><th>
552
+
553
+ Description
554
+
555
+
556
+ </th></tr></thead>
557
+ <tbody><tr><td>
558
+
559
+ [attach(entity)](./server.defaultplayerentitycontroller.attach.md)
560
+
561
+
562
+ </td><td>
563
+
564
+
565
+ </td><td>
566
+
567
+ Called when the controller is attached to an entity.
568
+
569
+
570
+ </td></tr>
571
+ <tr><td>
572
+
573
+ [spawn(entity)](./server.defaultplayerentitycontroller.spawn.md)
574
+
575
+
576
+ </td><td>
577
+
578
+
579
+ </td><td>
580
+
581
+ Called when the controlled entity is spawned. In DefaultPlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
582
+
583
+
584
+ </td></tr>
585
+ <tr><td>
586
+
587
+ [tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.defaultplayerentitycontroller.tickwithplayerinput.md)
588
+
589
+
590
+ </td><td>
591
+
592
+
593
+ </td><td>
594
+
595
+ Ticks the player movement for the entity controller, overriding the default implementation. If the entity to tick is a child entity, only the event will be emitted but the default movement logic will not be applied.
596
+
597
+
598
+ </td></tr>
599
+ </tbody></table>
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [platform](./server.defaultplayerentitycontroller.platform.md)
4
+
5
+ ## DefaultPlayerEntityController.platform property
6
+
7
+ The platform the entity is on, if any.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get platform(): Entity | undefined;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [runLoopedAnimations](./server.defaultplayerentitycontroller.runloopedanimations.md)
4
+
5
+ ## DefaultPlayerEntityController.runLoopedAnimations property
6
+
7
+ The looped animation(s) that will play when the entity is running.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ runLoopedAnimations: string[];
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [runVelocity](./server.defaultplayerentitycontroller.runvelocity.md)
4
+
5
+ ## DefaultPlayerEntityController.runVelocity property
6
+
7
+ The normalized horizontal velocity applied to the entity when it runs.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ runVelocity: number;
13
+ ```
@@ -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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [spawn](./server.defaultplayerentitycontroller.spawn.md)
4
+
5
+ ## DefaultPlayerEntityController.spawn() method
6
+
7
+ Called when the controlled entity is spawned. In DefaultPlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ spawn(entity: Entity): void;
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
+ entity
36
+
37
+
38
+ </td><td>
39
+
40
+ [Entity](./server.entity.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The entity that is spawned.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [sticksToPlatforms](./server.defaultplayerentitycontroller.stickstoplatforms.md)
4
+
5
+ ## DefaultPlayerEntityController.sticksToPlatforms property
6
+
7
+ Whether the entity sticks to platforms.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ sticksToPlatforms: boolean;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimFastVelocity](./server.defaultplayerentitycontroller.swimfastvelocity.md)
4
+
5
+ ## DefaultPlayerEntityController.swimFastVelocity property
6
+
7
+ The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ swimFastVelocity: number;
13
+ ```