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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [swimGravity](./server.defaultplayerentitycontroller.swimgravity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [swimLoopedAnimations](./server.defaultplayerentitycontroller.swimloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [swimMaxGravityVelocity](./server.defaultplayerentitycontroller.swimmaxgravityvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [swimSlowVelocity](./server.defaultplayerentitycontroller.swimslowvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [swimUpwardVelocity](./server.defaultplayerentitycontroller.swimupwardvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.swimUpwardVelocity property
|
6
|
+
|
7
|
+
The upward velocity applied to the entity when swimming.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
swimUpwardVelocity: number;
|
13
|
+
```
|
@@ -1,8 +1,8 @@
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
2
|
|
3
|
-
[Home](./index.md) > [server](./server.md) > [
|
3
|
+
[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [tickWithPlayerInput](./server.defaultplayerentitycontroller.tickwithplayerinput.md)
|
4
4
|
|
5
|
-
##
|
5
|
+
## DefaultPlayerEntityController.tickWithPlayerInput() method
|
6
6
|
|
7
7
|
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.
|
8
8
|
|
@@ -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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [walkLoopedAnimations](./server.defaultplayerentitycontroller.walkloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.walkLoopedAnimations property
|
6
|
+
|
7
|
+
The looped 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) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) > [walkVelocity](./server.defaultplayerentitycontroller.walkvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityController.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,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) > [autoCancelMouseLeftClick](./server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.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
|
+
```
|
@@ -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) > [canJump](./server.defaultplayerentitycontrolleroptions.canjump.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.canJump property
|
6
|
+
|
7
|
+
A function allowing custom logic to determine if the entity can jump.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
canJump?: () => boolean;
|
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) > [canRun](./server.defaultplayerentitycontrolleroptions.canrun.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.canRun property
|
6
|
+
|
7
|
+
A function allowing custom logic to determine if the entity can run.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
canRun?: () => boolean;
|
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) > [canWalk](./server.defaultplayerentitycontrolleroptions.canwalk.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.canWalk property
|
6
|
+
|
7
|
+
A function allowing custom logic to determine if the entity can walk.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
canWalk?: () => boolean;
|
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) > [idleLoopedAnimations](./server.defaultplayerentitycontrolleroptions.idleloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.idleLoopedAnimations property
|
6
|
+
|
7
|
+
Overrides the animation(s) that will play when the entity is idle.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
idleLoopedAnimations?: 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) > [interactOneshotAnimations](./server.defaultplayerentitycontrolleroptions.interactoneshotanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.interactOneshotAnimations property
|
6
|
+
|
7
|
+
Overrides the animation(s) that will play when the entity interacts (left click)
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
interactOneshotAnimations?: 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) > [jumpOneshotAnimations](./server.defaultplayerentitycontrolleroptions.jumponeshotanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.jumpOneshotAnimations property
|
6
|
+
|
7
|
+
Overrides the animation(s) that will play when the entity is jumping.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
jumpOneshotAnimations?: 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) > [jumpVelocity](./server.defaultplayerentitycontrolleroptions.jumpvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.jumpVelocity property
|
6
|
+
|
7
|
+
The upward velocity applied to the entity when it jumps.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
jumpVelocity?: number;
|
13
|
+
```
|
@@ -0,0 +1,399 @@
|
|
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)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions interface
|
6
|
+
|
7
|
+
Options for creating a DefaultPlayerEntityController instance.
|
8
|
+
|
9
|
+
**Signature:**
|
10
|
+
|
11
|
+
```typescript
|
12
|
+
export interface DefaultPlayerEntityControllerOptions
|
13
|
+
```
|
14
|
+
|
15
|
+
## Properties
|
16
|
+
|
17
|
+
<table><thead><tr><th>
|
18
|
+
|
19
|
+
Property
|
20
|
+
|
21
|
+
|
22
|
+
</th><th>
|
23
|
+
|
24
|
+
Modifiers
|
25
|
+
|
26
|
+
|
27
|
+
</th><th>
|
28
|
+
|
29
|
+
Type
|
30
|
+
|
31
|
+
|
32
|
+
</th><th>
|
33
|
+
|
34
|
+
Description
|
35
|
+
|
36
|
+
|
37
|
+
</th></tr></thead>
|
38
|
+
<tbody><tr><td>
|
39
|
+
|
40
|
+
[autoCancelMouseLeftClick?](./server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md)
|
41
|
+
|
42
|
+
|
43
|
+
</td><td>
|
44
|
+
|
45
|
+
|
46
|
+
</td><td>
|
47
|
+
|
48
|
+
boolean
|
49
|
+
|
50
|
+
|
51
|
+
</td><td>
|
52
|
+
|
53
|
+
_(Optional)_ Whether to automatically cancel left click input after first processed tick, defaults to true.
|
54
|
+
|
55
|
+
|
56
|
+
</td></tr>
|
57
|
+
<tr><td>
|
58
|
+
|
59
|
+
[canJump?](./server.defaultplayerentitycontrolleroptions.canjump.md)
|
60
|
+
|
61
|
+
|
62
|
+
</td><td>
|
63
|
+
|
64
|
+
|
65
|
+
</td><td>
|
66
|
+
|
67
|
+
() => boolean
|
68
|
+
|
69
|
+
|
70
|
+
</td><td>
|
71
|
+
|
72
|
+
_(Optional)_ A function allowing custom logic to determine if the entity can jump.
|
73
|
+
|
74
|
+
|
75
|
+
</td></tr>
|
76
|
+
<tr><td>
|
77
|
+
|
78
|
+
[canRun?](./server.defaultplayerentitycontrolleroptions.canrun.md)
|
79
|
+
|
80
|
+
|
81
|
+
</td><td>
|
82
|
+
|
83
|
+
|
84
|
+
</td><td>
|
85
|
+
|
86
|
+
() => boolean
|
87
|
+
|
88
|
+
|
89
|
+
</td><td>
|
90
|
+
|
91
|
+
_(Optional)_ A function allowing custom logic to determine if the entity can run.
|
92
|
+
|
93
|
+
|
94
|
+
</td></tr>
|
95
|
+
<tr><td>
|
96
|
+
|
97
|
+
[canWalk?](./server.defaultplayerentitycontrolleroptions.canwalk.md)
|
98
|
+
|
99
|
+
|
100
|
+
</td><td>
|
101
|
+
|
102
|
+
|
103
|
+
</td><td>
|
104
|
+
|
105
|
+
() => boolean
|
106
|
+
|
107
|
+
|
108
|
+
</td><td>
|
109
|
+
|
110
|
+
_(Optional)_ A function allowing custom logic to determine if the entity can walk.
|
111
|
+
|
112
|
+
|
113
|
+
</td></tr>
|
114
|
+
<tr><td>
|
115
|
+
|
116
|
+
[idleLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.idleloopedanimations.md)
|
117
|
+
|
118
|
+
|
119
|
+
</td><td>
|
120
|
+
|
121
|
+
|
122
|
+
</td><td>
|
123
|
+
|
124
|
+
string\[\]
|
125
|
+
|
126
|
+
|
127
|
+
</td><td>
|
128
|
+
|
129
|
+
_(Optional)_ Overrides the animation(s) that will play when the entity is idle.
|
130
|
+
|
131
|
+
|
132
|
+
</td></tr>
|
133
|
+
<tr><td>
|
134
|
+
|
135
|
+
[interactOneshotAnimations?](./server.defaultplayerentitycontrolleroptions.interactoneshotanimations.md)
|
136
|
+
|
137
|
+
|
138
|
+
</td><td>
|
139
|
+
|
140
|
+
|
141
|
+
</td><td>
|
142
|
+
|
143
|
+
string\[\]
|
144
|
+
|
145
|
+
|
146
|
+
</td><td>
|
147
|
+
|
148
|
+
_(Optional)_ Overrides the animation(s) that will play when the entity interacts (left click)
|
149
|
+
|
150
|
+
|
151
|
+
</td></tr>
|
152
|
+
<tr><td>
|
153
|
+
|
154
|
+
[jumpOneshotAnimations?](./server.defaultplayerentitycontrolleroptions.jumponeshotanimations.md)
|
155
|
+
|
156
|
+
|
157
|
+
</td><td>
|
158
|
+
|
159
|
+
|
160
|
+
</td><td>
|
161
|
+
|
162
|
+
string\[\]
|
163
|
+
|
164
|
+
|
165
|
+
</td><td>
|
166
|
+
|
167
|
+
_(Optional)_ Overrides the animation(s) that will play when the entity is jumping.
|
168
|
+
|
169
|
+
|
170
|
+
</td></tr>
|
171
|
+
<tr><td>
|
172
|
+
|
173
|
+
[jumpVelocity?](./server.defaultplayerentitycontrolleroptions.jumpvelocity.md)
|
174
|
+
|
175
|
+
|
176
|
+
</td><td>
|
177
|
+
|
178
|
+
|
179
|
+
</td><td>
|
180
|
+
|
181
|
+
number
|
182
|
+
|
183
|
+
|
184
|
+
</td><td>
|
185
|
+
|
186
|
+
_(Optional)_ The upward velocity applied to the entity when it jumps.
|
187
|
+
|
188
|
+
|
189
|
+
</td></tr>
|
190
|
+
<tr><td>
|
191
|
+
|
192
|
+
[runLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.runloopedanimations.md)
|
193
|
+
|
194
|
+
|
195
|
+
</td><td>
|
196
|
+
|
197
|
+
|
198
|
+
</td><td>
|
199
|
+
|
200
|
+
string\[\]
|
201
|
+
|
202
|
+
|
203
|
+
</td><td>
|
204
|
+
|
205
|
+
_(Optional)_ Overrides the animation(s) that will play when the entity is running.
|
206
|
+
|
207
|
+
|
208
|
+
</td></tr>
|
209
|
+
<tr><td>
|
210
|
+
|
211
|
+
[runVelocity?](./server.defaultplayerentitycontrolleroptions.runvelocity.md)
|
212
|
+
|
213
|
+
|
214
|
+
</td><td>
|
215
|
+
|
216
|
+
|
217
|
+
</td><td>
|
218
|
+
|
219
|
+
number
|
220
|
+
|
221
|
+
|
222
|
+
</td><td>
|
223
|
+
|
224
|
+
_(Optional)_ The normalized horizontal velocity applied to the entity when it runs.
|
225
|
+
|
226
|
+
|
227
|
+
</td></tr>
|
228
|
+
<tr><td>
|
229
|
+
|
230
|
+
[sticksToPlatforms?](./server.defaultplayerentitycontrolleroptions.stickstoplatforms.md)
|
231
|
+
|
232
|
+
|
233
|
+
</td><td>
|
234
|
+
|
235
|
+
|
236
|
+
</td><td>
|
237
|
+
|
238
|
+
boolean
|
239
|
+
|
240
|
+
|
241
|
+
</td><td>
|
242
|
+
|
243
|
+
_(Optional)_ Whether the entity sticks to platforms, defaults to true.
|
244
|
+
|
245
|
+
|
246
|
+
</td></tr>
|
247
|
+
<tr><td>
|
248
|
+
|
249
|
+
[swimFastVelocity?](./server.defaultplayerentitycontrolleroptions.swimfastvelocity.md)
|
250
|
+
|
251
|
+
|
252
|
+
</td><td>
|
253
|
+
|
254
|
+
|
255
|
+
</td><td>
|
256
|
+
|
257
|
+
number
|
258
|
+
|
259
|
+
|
260
|
+
</td><td>
|
261
|
+
|
262
|
+
_(Optional)_ The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
|
263
|
+
|
264
|
+
|
265
|
+
</td></tr>
|
266
|
+
<tr><td>
|
267
|
+
|
268
|
+
[swimGravity?](./server.defaultplayerentitycontrolleroptions.swimgravity.md)
|
269
|
+
|
270
|
+
|
271
|
+
</td><td>
|
272
|
+
|
273
|
+
|
274
|
+
</td><td>
|
275
|
+
|
276
|
+
number
|
277
|
+
|
278
|
+
|
279
|
+
</td><td>
|
280
|
+
|
281
|
+
_(Optional)_ The gravity modifier applied to the entity when swimming.
|
282
|
+
|
283
|
+
|
284
|
+
</td></tr>
|
285
|
+
<tr><td>
|
286
|
+
|
287
|
+
[swimLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.swimloopedanimations.md)
|
288
|
+
|
289
|
+
|
290
|
+
</td><td>
|
291
|
+
|
292
|
+
|
293
|
+
</td><td>
|
294
|
+
|
295
|
+
string\[\]
|
296
|
+
|
297
|
+
|
298
|
+
</td><td>
|
299
|
+
|
300
|
+
_(Optional)_ The looped animation(s) that will play when the entity is swimming.
|
301
|
+
|
302
|
+
|
303
|
+
</td></tr>
|
304
|
+
<tr><td>
|
305
|
+
|
306
|
+
[swimMaxGravityVelocity?](./server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md)
|
307
|
+
|
308
|
+
|
309
|
+
</td><td>
|
310
|
+
|
311
|
+
|
312
|
+
</td><td>
|
313
|
+
|
314
|
+
number
|
315
|
+
|
316
|
+
|
317
|
+
</td><td>
|
318
|
+
|
319
|
+
_(Optional)_ The maximum downward velocity that the entity can reach when affected by gravity while swimming.
|
320
|
+
|
321
|
+
|
322
|
+
</td></tr>
|
323
|
+
<tr><td>
|
324
|
+
|
325
|
+
[swimSlowVelocity?](./server.defaultplayerentitycontrolleroptions.swimslowvelocity.md)
|
326
|
+
|
327
|
+
|
328
|
+
</td><td>
|
329
|
+
|
330
|
+
|
331
|
+
</td><td>
|
332
|
+
|
333
|
+
number
|
334
|
+
|
335
|
+
|
336
|
+
</td><td>
|
337
|
+
|
338
|
+
_(Optional)_ The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
|
339
|
+
|
340
|
+
|
341
|
+
</td></tr>
|
342
|
+
<tr><td>
|
343
|
+
|
344
|
+
[swimUpwardVelocity?](./server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md)
|
345
|
+
|
346
|
+
|
347
|
+
</td><td>
|
348
|
+
|
349
|
+
|
350
|
+
</td><td>
|
351
|
+
|
352
|
+
number
|
353
|
+
|
354
|
+
|
355
|
+
</td><td>
|
356
|
+
|
357
|
+
_(Optional)_ The upward velocity applied to the entity when swimming.
|
358
|
+
|
359
|
+
|
360
|
+
</td></tr>
|
361
|
+
<tr><td>
|
362
|
+
|
363
|
+
[walkLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.walkloopedanimations.md)
|
364
|
+
|
365
|
+
|
366
|
+
</td><td>
|
367
|
+
|
368
|
+
|
369
|
+
</td><td>
|
370
|
+
|
371
|
+
string\[\]
|
372
|
+
|
373
|
+
|
374
|
+
</td><td>
|
375
|
+
|
376
|
+
_(Optional)_ Overrides the animation(s) that will play when the entity is walking.
|
377
|
+
|
378
|
+
|
379
|
+
</td></tr>
|
380
|
+
<tr><td>
|
381
|
+
|
382
|
+
[walkVelocity?](./server.defaultplayerentitycontrolleroptions.walkvelocity.md)
|
383
|
+
|
384
|
+
|
385
|
+
</td><td>
|
386
|
+
|
387
|
+
|
388
|
+
</td><td>
|
389
|
+
|
390
|
+
number
|
391
|
+
|
392
|
+
|
393
|
+
</td><td>
|
394
|
+
|
395
|
+
_(Optional)_ The normalized horizontal velocity applied to the entity when it walks.
|
396
|
+
|
397
|
+
|
398
|
+
</td></tr>
|
399
|
+
</tbody></table>
|
@@ -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) > [runLoopedAnimations](./server.defaultplayerentitycontrolleroptions.runloopedanimations.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.runLoopedAnimations property
|
6
|
+
|
7
|
+
Overrides the 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) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [runVelocity](./server.defaultplayerentitycontrolleroptions.runvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.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,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) > [sticksToPlatforms](./server.defaultplayerentitycontrolleroptions.stickstoplatforms.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.sticksToPlatforms property
|
6
|
+
|
7
|
+
Whether the entity sticks to platforms, defaults to true.
|
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) > [server](./server.md) > [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) > [swimFastVelocity](./server.defaultplayerentitycontrolleroptions.swimfastvelocity.md)
|
4
|
+
|
5
|
+
## DefaultPlayerEntityControllerOptions.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
|
+
```
|