hytopia 0.1.67 → 0.1.69

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.
@@ -217,6 +217,25 @@ string
217
217
  </td><td>
218
218
 
219
219
 
220
+ </td></tr>
221
+ <tr><td>
222
+
223
+ [viewDistance](./server.sceneui.viewdistance.md)
224
+
225
+
226
+ </td><td>
227
+
228
+ `readonly`
229
+
230
+
231
+ </td><td>
232
+
233
+ number \| undefined
234
+
235
+
236
+ </td><td>
237
+
238
+
220
239
  </td></tr>
221
240
  <tr><td>
222
241
 
@@ -326,6 +345,20 @@ Sets the position of the SceneUI. Will detach from entity if attached.
326
345
  Sets the state of the SceneUI by performing a shallow merge with existing state.
327
346
 
328
347
 
348
+ </td></tr>
349
+ <tr><td>
350
+
351
+ [setViewDistance(viewDistance)](./server.sceneui.setviewdistance.md)
352
+
353
+
354
+ </td><td>
355
+
356
+
357
+ </td><td>
358
+
359
+ Sets the view distance of the SceneUI.
360
+
361
+
329
362
  </td></tr>
330
363
  <tr><td>
331
364
 
@@ -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; [SceneUI](./server.sceneui.md) &gt; [setViewDistance](./server.sceneui.setviewdistance.md)
4
+
5
+ ## SceneUI.setViewDistance() method
6
+
7
+ Sets the view distance of the SceneUI.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setViewDistance(viewDistance: number): 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
+ viewDistance
36
+
37
+
38
+ </td><td>
39
+
40
+ number
41
+
42
+
43
+ </td><td>
44
+
45
+ The view distance in the world.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [viewDistance](./server.sceneui.viewdistance.md)
4
+
5
+ ## SceneUI.viewDistance property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ get viewDistance(): number | undefined;
11
+ ```
@@ -129,5 +129,24 @@ string
129
129
  The template ID to use for this SceneUI
130
130
 
131
131
 
132
+ </td></tr>
133
+ <tr><td>
134
+
135
+ [viewDistance?](./server.sceneuioptions.viewdistance.md)
136
+
137
+
138
+ </td><td>
139
+
140
+
141
+ </td><td>
142
+
143
+ number
144
+
145
+
146
+ </td><td>
147
+
148
+ _(Optional)_ The maximum view distance the SceneUI will be visible to the player
149
+
150
+
132
151
  </td></tr>
133
152
  </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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [viewDistance](./server.sceneuioptions.viewdistance.md)
4
+
5
+ ## SceneUIOptions.viewDistance property
6
+
7
+ The maximum view distance the SceneUI will be visible to the player
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ viewDistance?: number;
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; [World](./server.world.md) &gt; [ambientLightColor](./server.world.ambientlightcolor.md)
4
+
5
+ ## World.ambientLightColor property
6
+
7
+ The color of the ambient light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get ambientLightColor(): RgbColor;
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; [World](./server.world.md) &gt; [ambientLightIntensity](./server.world.ambientlightintensity.md)
4
+
5
+ ## World.ambientLightIntensity property
6
+
7
+ The intensity of the ambient light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get ambientLightIntensity(): number;
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; [World](./server.world.md) &gt; [directionalLightColor](./server.world.directionallightcolor.md)
4
+
5
+ ## World.directionalLightColor property
6
+
7
+ The color of the directional light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get directionalLightColor(): RgbColor;
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; [World](./server.world.md) &gt; [directionalLightIntensity](./server.world.directionallightintensity.md)
4
+
5
+ ## World.directionalLightIntensity property
6
+
7
+ The intensity of the directional light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get directionalLightIntensity(): number;
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; [World](./server.world.md) &gt; [directionalLightPosition](./server.world.directionallightposition.md)
4
+
5
+ ## World.directionalLightPosition property
6
+
7
+ The position the directional light originates from.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ get directionalLightPosition(): Vector3Like;
13
+ ```
@@ -87,6 +87,48 @@ Description
87
87
  </th></tr></thead>
88
88
  <tbody><tr><td>
89
89
 
90
+ [ambientLightColor](./server.world.ambientlightcolor.md)
91
+
92
+
93
+ </td><td>
94
+
95
+ `readonly`
96
+
97
+
98
+ </td><td>
99
+
100
+ [RgbColor](./server.rgbcolor.md)
101
+
102
+
103
+ </td><td>
104
+
105
+ The color of the ambient light.
106
+
107
+
108
+ </td></tr>
109
+ <tr><td>
110
+
111
+ [ambientLightIntensity](./server.world.ambientlightintensity.md)
112
+
113
+
114
+ </td><td>
115
+
116
+ `readonly`
117
+
118
+
119
+ </td><td>
120
+
121
+ number
122
+
123
+
124
+ </td><td>
125
+
126
+ The intensity of the ambient light.
127
+
128
+
129
+ </td></tr>
130
+ <tr><td>
131
+
90
132
  [audioManager](./server.world.audiomanager.md)
91
133
 
92
134
 
@@ -168,6 +210,69 @@ The chat manager for the world.
168
210
  The chunk lattice for the world.
169
211
 
170
212
 
213
+ </td></tr>
214
+ <tr><td>
215
+
216
+ [directionalLightColor](./server.world.directionallightcolor.md)
217
+
218
+
219
+ </td><td>
220
+
221
+ `readonly`
222
+
223
+
224
+ </td><td>
225
+
226
+ [RgbColor](./server.rgbcolor.md)
227
+
228
+
229
+ </td><td>
230
+
231
+ The color of the directional light.
232
+
233
+
234
+ </td></tr>
235
+ <tr><td>
236
+
237
+ [directionalLightIntensity](./server.world.directionallightintensity.md)
238
+
239
+
240
+ </td><td>
241
+
242
+ `readonly`
243
+
244
+
245
+ </td><td>
246
+
247
+ number
248
+
249
+
250
+ </td><td>
251
+
252
+ The intensity of the directional light.
253
+
254
+
255
+ </td></tr>
256
+ <tr><td>
257
+
258
+ [directionalLightPosition](./server.world.directionallightposition.md)
259
+
260
+
261
+ </td><td>
262
+
263
+ `readonly`
264
+
265
+
266
+ </td><td>
267
+
268
+ [Vector3Like](./server.vector3like.md)
269
+
270
+
271
+ </td><td>
272
+
273
+ The position the directional light originates from.
274
+
275
+
171
276
  </td></tr>
172
277
  <tr><td>
173
278
 
@@ -408,6 +513,76 @@ Description
408
513
  Loads a map into the world.
409
514
 
410
515
 
516
+ </td></tr>
517
+ <tr><td>
518
+
519
+ [setAmbientLightColor(color)](./server.world.setambientlightcolor.md)
520
+
521
+
522
+ </td><td>
523
+
524
+
525
+ </td><td>
526
+
527
+ Sets the color of the ambient light.
528
+
529
+
530
+ </td></tr>
531
+ <tr><td>
532
+
533
+ [setAmbientLightIntensity(intensity)](./server.world.setambientlightintensity.md)
534
+
535
+
536
+ </td><td>
537
+
538
+
539
+ </td><td>
540
+
541
+ Sets the intensity of the ambient light.
542
+
543
+
544
+ </td></tr>
545
+ <tr><td>
546
+
547
+ [setDirectionalLightColor(color)](./server.world.setdirectionallightcolor.md)
548
+
549
+
550
+ </td><td>
551
+
552
+
553
+ </td><td>
554
+
555
+ Sets the color of the directional light.
556
+
557
+
558
+ </td></tr>
559
+ <tr><td>
560
+
561
+ [setDirectionalLightIntensity(intensity)](./server.world.setdirectionallightintensity.md)
562
+
563
+
564
+ </td><td>
565
+
566
+
567
+ </td><td>
568
+
569
+ Sets the intensity of the directional light.
570
+
571
+
572
+ </td></tr>
573
+ <tr><td>
574
+
575
+ [setDirectionalLightPosition(position)](./server.world.setdirectionallightposition.md)
576
+
577
+
578
+ </td><td>
579
+
580
+
581
+ </td><td>
582
+
583
+ Sets the position the directional light originates from.
584
+
585
+
411
586
  </td></tr>
412
587
  <tr><td>
413
588
 
@@ -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; [World](./server.world.md) &gt; [setAmbientLightColor](./server.world.setambientlightcolor.md)
4
+
5
+ ## World.setAmbientLightColor() method
6
+
7
+ Sets the color of the ambient light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setAmbientLightColor(color: RgbColor): 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
+ color
36
+
37
+
38
+ </td><td>
39
+
40
+ [RgbColor](./server.rgbcolor.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The color of the light.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -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; [World](./server.world.md) &gt; [setAmbientLightIntensity](./server.world.setambientlightintensity.md)
4
+
5
+ ## World.setAmbientLightIntensity() method
6
+
7
+ Sets the intensity of the ambient light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setAmbientLightIntensity(intensity: number): 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
+ intensity
36
+
37
+
38
+ </td><td>
39
+
40
+ number
41
+
42
+
43
+ </td><td>
44
+
45
+ The intensity.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -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; [World](./server.world.md) &gt; [setDirectionalLightColor](./server.world.setdirectionallightcolor.md)
4
+
5
+ ## World.setDirectionalLightColor() method
6
+
7
+ Sets the color of the directional light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setDirectionalLightColor(color: RgbColor): 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
+ color
36
+
37
+
38
+ </td><td>
39
+
40
+ [RgbColor](./server.rgbcolor.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The color of the light.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -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; [World](./server.world.md) &gt; [setDirectionalLightIntensity](./server.world.setdirectionallightintensity.md)
4
+
5
+ ## World.setDirectionalLightIntensity() method
6
+
7
+ Sets the intensity of the directional light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setDirectionalLightIntensity(intensity: number): 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
+ intensity
36
+
37
+
38
+ </td><td>
39
+
40
+ number
41
+
42
+
43
+ </td><td>
44
+
45
+ The intensity.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+ **Returns:**
51
+
52
+ void
53
+
@@ -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; [World](./server.world.md) &gt; [setDirectionalLightPosition](./server.world.setdirectionallightposition.md)
4
+
5
+ ## World.setDirectionalLightPosition() method
6
+
7
+ Sets the position the directional light originates from.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setDirectionalLightPosition(position: Vector3Like): 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
+ position
36
+
37
+
38
+ </td><td>
39
+
40
+ [Vector3Like](./server.vector3like.md)
41
+
42
+
43
+ </td><td>
44
+
45
+ The position in the world.
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; [WorldOptions](./server.worldoptions.md) &gt; [ambientLightColor](./server.worldoptions.ambientlightcolor.md)
4
+
5
+ ## WorldOptions.ambientLightColor property
6
+
7
+ The color of the ambient light.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ ambientLightColor?: RgbColor;
13
+ ```