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
@@ -1,49 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [(constructor)](./server.playerentitycontroller._constructor_.md)
4
-
5
- ## PlayerEntityController.(constructor)
6
-
7
- Constructs a new instance of the `PlayerEntityController` class
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- constructor(options?: PlayerEntityControllerOptions);
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
- options
36
-
37
-
38
- </td><td>
39
-
40
- [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
41
-
42
-
43
- </td><td>
44
-
45
- _(Optional)_ Options for the controller.
46
-
47
-
48
- </td></tr>
49
- </tbody></table>
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [autoCancelMouseLeftClick](./server.playerentitycontroller.autocancelmouseleftclick.md)
4
-
5
- ## PlayerEntityController.autoCancelMouseLeftClick property
6
-
7
- Whether to automatically cancel left click input after first processed tick, defaults to true.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- autoCancelMouseLeftClick: boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [canJump](./server.playerentitycontroller.canjump.md)
4
-
5
- ## PlayerEntityController.canJump property
6
-
7
- A function allowing custom logic to determine if the entity can jump.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- canJump: (playerEntityController: PlayerEntityController) => boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [canRun](./server.playerentitycontroller.canrun.md)
4
-
5
- ## PlayerEntityController.canRun property
6
-
7
- A function allowing custom logic to determine if the entity can run.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- canRun: (playerEntityController: PlayerEntityController) => boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [canWalk](./server.playerentitycontroller.canwalk.md)
4
-
5
- ## PlayerEntityController.canWalk property
6
-
7
- A function allowing custom logic to determine if the entity can walk.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- canWalk: (playerEntityController: PlayerEntityController) => boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [idleLoopedAnimations](./server.playerentitycontroller.idleloopedanimations.md)
4
-
5
- ## PlayerEntityController.idleLoopedAnimations property
6
-
7
- The looped animation(s) that will play when the entity is idle.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- idleLoopedAnimations: string[];
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [interactOneshotAnimations](./server.playerentitycontroller.interactoneshotanimations.md)
4
-
5
- ## PlayerEntityController.interactOneshotAnimations property
6
-
7
- The oneshot animation(s) that will play when the entity interacts (left click)
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- interactOneshotAnimations: string[];
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [isGrounded](./server.playerentitycontroller.isgrounded.md)
4
-
5
- ## PlayerEntityController.isGrounded property
6
-
7
- Whether the entity is grounded.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- get isGrounded(): boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [isOnPlatform](./server.playerentitycontroller.isonplatform.md)
4
-
5
- ## PlayerEntityController.isOnPlatform property
6
-
7
- Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- get isOnPlatform(): boolean;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [jumpOneshotAnimations](./server.playerentitycontroller.jumponeshotanimations.md)
4
-
5
- ## PlayerEntityController.jumpOneshotAnimations property
6
-
7
- The oneshot animation(s) that will play when the entity is jumping.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- jumpOneshotAnimations: string[];
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [jumpVelocity](./server.playerentitycontroller.jumpvelocity.md)
4
-
5
- ## PlayerEntityController.jumpVelocity property
6
-
7
- The upward velocity applied to the entity when it jumps.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- jumpVelocity: number;
13
- ```
@@ -1,464 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md)
4
-
5
- ## PlayerEntityController class
6
-
7
- The player entity controller implementation.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export default class PlayerEntityController 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 logic for a entity. This is used as the default for players when they join your game. This class may be extended if you'd like to implement additional logic on top of the PlayerEntityController implementation.
19
-
20
- ## Example
21
-
22
-
23
- ```typescript
24
- // Create a custom entity controller for myEntity, prior to spawning it.
25
- myEntity.setController(new PlayerEntityController(myEntity, {
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.playerentitycontroller._constructor_.md)
56
-
57
-
58
- </td><td>
59
-
60
-
61
- </td><td>
62
-
63
- Constructs a new instance of the `PlayerEntityController` 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.playerentitycontroller.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.playerentitycontroller.canjump.md)
114
-
115
-
116
- </td><td>
117
-
118
-
119
- </td><td>
120
-
121
- (playerEntityController: [PlayerEntityController](./server.playerentitycontroller.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.playerentitycontroller.canrun.md)
133
-
134
-
135
- </td><td>
136
-
137
-
138
- </td><td>
139
-
140
- (playerEntityController: [PlayerEntityController](./server.playerentitycontroller.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.playerentitycontroller.canwalk.md)
152
-
153
-
154
- </td><td>
155
-
156
-
157
- </td><td>
158
-
159
- (playerEntityController: [PlayerEntityController](./server.playerentitycontroller.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.playerentitycontroller.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.playerentitycontroller.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.playerentitycontroller.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.playerentitycontroller.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
- [jumpOneshotAnimations](./server.playerentitycontroller.jumponeshotanimations.md)
251
-
252
-
253
- </td><td>
254
-
255
-
256
- </td><td>
257
-
258
- string\[\]
259
-
260
-
261
- </td><td>
262
-
263
- The oneshot animation(s) that will play when the entity is jumping.
264
-
265
-
266
- </td></tr>
267
- <tr><td>
268
-
269
- [jumpVelocity](./server.playerentitycontroller.jumpvelocity.md)
270
-
271
-
272
- </td><td>
273
-
274
-
275
- </td><td>
276
-
277
- number
278
-
279
-
280
- </td><td>
281
-
282
- The upward velocity applied to the entity when it jumps.
283
-
284
-
285
- </td></tr>
286
- <tr><td>
287
-
288
- [platform](./server.playerentitycontroller.platform.md)
289
-
290
-
291
- </td><td>
292
-
293
- `readonly`
294
-
295
-
296
- </td><td>
297
-
298
- [Entity](./server.entity.md) \| undefined
299
-
300
-
301
- </td><td>
302
-
303
- The platform the entity is on, if any.
304
-
305
-
306
- </td></tr>
307
- <tr><td>
308
-
309
- [runLoopedAnimations](./server.playerentitycontroller.runloopedanimations.md)
310
-
311
-
312
- </td><td>
313
-
314
-
315
- </td><td>
316
-
317
- string\[\]
318
-
319
-
320
- </td><td>
321
-
322
- The looped animation(s) that will play when the entity is running.
323
-
324
-
325
- </td></tr>
326
- <tr><td>
327
-
328
- [runVelocity](./server.playerentitycontroller.runvelocity.md)
329
-
330
-
331
- </td><td>
332
-
333
-
334
- </td><td>
335
-
336
- number
337
-
338
-
339
- </td><td>
340
-
341
- The normalized horizontal velocity applied to the entity when it runs.
342
-
343
-
344
- </td></tr>
345
- <tr><td>
346
-
347
- [sticksToPlatforms](./server.playerentitycontroller.stickstoplatforms.md)
348
-
349
-
350
- </td><td>
351
-
352
-
353
- </td><td>
354
-
355
- boolean
356
-
357
-
358
- </td><td>
359
-
360
- Whether the entity sticks to platforms.
361
-
362
-
363
- </td></tr>
364
- <tr><td>
365
-
366
- [walkLoopedAnimations](./server.playerentitycontroller.walkloopedanimations.md)
367
-
368
-
369
- </td><td>
370
-
371
-
372
- </td><td>
373
-
374
- string\[\]
375
-
376
-
377
- </td><td>
378
-
379
- The looped animation(s) that will play when the entity is walking.
380
-
381
-
382
- </td></tr>
383
- <tr><td>
384
-
385
- [walkVelocity](./server.playerentitycontroller.walkvelocity.md)
386
-
387
-
388
- </td><td>
389
-
390
-
391
- </td><td>
392
-
393
- number
394
-
395
-
396
- </td><td>
397
-
398
- The normalized horizontal velocity applied to the entity when it walks.
399
-
400
-
401
- </td></tr>
402
- </tbody></table>
403
-
404
- ## Methods
405
-
406
- <table><thead><tr><th>
407
-
408
- Method
409
-
410
-
411
- </th><th>
412
-
413
- Modifiers
414
-
415
-
416
- </th><th>
417
-
418
- Description
419
-
420
-
421
- </th></tr></thead>
422
- <tbody><tr><td>
423
-
424
- [attach(entity)](./server.playerentitycontroller.attach.md)
425
-
426
-
427
- </td><td>
428
-
429
-
430
- </td><td>
431
-
432
- Called when the controller is attached to an entity.
433
-
434
-
435
- </td></tr>
436
- <tr><td>
437
-
438
- [spawn(entity)](./server.playerentitycontroller.spawn.md)
439
-
440
-
441
- </td><td>
442
-
443
-
444
- </td><td>
445
-
446
- Called when the controlled entity is spawned. In PlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
447
-
448
-
449
- </td></tr>
450
- <tr><td>
451
-
452
- [tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.playerentitycontroller.tickwithplayerinput.md)
453
-
454
-
455
- </td><td>
456
-
457
-
458
- </td><td>
459
-
460
- 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.
461
-
462
-
463
- </td></tr>
464
- </tbody></table>
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [platform](./server.playerentitycontroller.platform.md)
4
-
5
- ## PlayerEntityController.platform property
6
-
7
- The platform the entity is on, if any.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- get platform(): Entity | undefined;
13
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [runLoopedAnimations](./server.playerentitycontroller.runloopedanimations.md)
4
-
5
- ## PlayerEntityController.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
- ```
@@ -1,13 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [runVelocity](./server.playerentitycontroller.runvelocity.md)
4
-
5
- ## PlayerEntityController.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
- ```