@minecraft/server-graphics 1.0.0-beta.1.26.30-preview.27 → 1.0.0-beta.1.26.30-preview.28
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/index.d.ts +1295 -0
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -332,6 +332,1222 @@ export class BiomeAtmospherics {
|
|
|
332
332
|
setSunMieStrength(sunMieStrength: number | Record<number, number>): void;
|
|
333
333
|
}
|
|
334
334
|
|
|
335
|
+
/**
|
|
336
|
+
* Used to affect color grading for Vibrant Visuals
|
|
337
|
+
*/
|
|
338
|
+
export class BiomeColorGrading {
|
|
339
|
+
private constructor();
|
|
340
|
+
/**
|
|
341
|
+
* @remarks
|
|
342
|
+
* Resets the contrast of highlights to the value set by
|
|
343
|
+
* resource packs
|
|
344
|
+
*
|
|
345
|
+
* This function can't be called in restricted-execution mode.
|
|
346
|
+
*
|
|
347
|
+
* @throws This function can throw errors.
|
|
348
|
+
*
|
|
349
|
+
* {@link minecraftcommon.EngineError}
|
|
350
|
+
*/
|
|
351
|
+
resetHighlightsContrast(): void;
|
|
352
|
+
/**
|
|
353
|
+
* @remarks
|
|
354
|
+
* Resets the gain of highlights to the value set by resource
|
|
355
|
+
* packs
|
|
356
|
+
*
|
|
357
|
+
* This function can't be called in restricted-execution mode.
|
|
358
|
+
*
|
|
359
|
+
* @throws This function can throw errors.
|
|
360
|
+
*
|
|
361
|
+
* {@link minecraftcommon.EngineError}
|
|
362
|
+
*/
|
|
363
|
+
resetHighlightsGain(): void;
|
|
364
|
+
/**
|
|
365
|
+
* @remarks
|
|
366
|
+
* Resets the gamma of highlights to the value set by resource
|
|
367
|
+
* packs
|
|
368
|
+
*
|
|
369
|
+
* This function can't be called in restricted-execution mode.
|
|
370
|
+
*
|
|
371
|
+
* @throws This function can throw errors.
|
|
372
|
+
*
|
|
373
|
+
* {@link minecraftcommon.EngineError}
|
|
374
|
+
*/
|
|
375
|
+
resetHighlightsGamma(): void;
|
|
376
|
+
/**
|
|
377
|
+
* @remarks
|
|
378
|
+
* Resets the highlights min to the value set by resource packs
|
|
379
|
+
*
|
|
380
|
+
* This function can't be called in restricted-execution mode.
|
|
381
|
+
*
|
|
382
|
+
* @throws This function can throw errors.
|
|
383
|
+
*
|
|
384
|
+
* {@link minecraftcommon.EngineError}
|
|
385
|
+
*/
|
|
386
|
+
resetHighlightsMin(): void;
|
|
387
|
+
/**
|
|
388
|
+
* @remarks
|
|
389
|
+
* Resets the offset of highlights to the value set by resource
|
|
390
|
+
* packs
|
|
391
|
+
*
|
|
392
|
+
* This function can't be called in restricted-execution mode.
|
|
393
|
+
*
|
|
394
|
+
* @throws This function can throw errors.
|
|
395
|
+
*
|
|
396
|
+
* {@link minecraftcommon.EngineError}
|
|
397
|
+
*/
|
|
398
|
+
resetHighlightsOffset(): void;
|
|
399
|
+
/**
|
|
400
|
+
* @remarks
|
|
401
|
+
* Resets the saturation of highlights to the value set by
|
|
402
|
+
* resource packs
|
|
403
|
+
*
|
|
404
|
+
* This function can't be called in restricted-execution mode.
|
|
405
|
+
*
|
|
406
|
+
* @throws This function can throw errors.
|
|
407
|
+
*
|
|
408
|
+
* {@link minecraftcommon.EngineError}
|
|
409
|
+
*/
|
|
410
|
+
resetHighlightsSaturation(): void;
|
|
411
|
+
/**
|
|
412
|
+
* @remarks
|
|
413
|
+
* Resets the contrast of midtones to the value set by resource
|
|
414
|
+
* packs
|
|
415
|
+
*
|
|
416
|
+
* This function can't be called in restricted-execution mode.
|
|
417
|
+
*
|
|
418
|
+
* @throws This function can throw errors.
|
|
419
|
+
*
|
|
420
|
+
* {@link minecraftcommon.EngineError}
|
|
421
|
+
*/
|
|
422
|
+
resetMidtonesContrast(): void;
|
|
423
|
+
/**
|
|
424
|
+
* @remarks
|
|
425
|
+
* Resets the gain of midtones to the value set by resource
|
|
426
|
+
* packs
|
|
427
|
+
*
|
|
428
|
+
* This function can't be called in restricted-execution mode.
|
|
429
|
+
*
|
|
430
|
+
* @throws This function can throw errors.
|
|
431
|
+
*
|
|
432
|
+
* {@link minecraftcommon.EngineError}
|
|
433
|
+
*/
|
|
434
|
+
resetMidtonesGain(): void;
|
|
435
|
+
/**
|
|
436
|
+
* @remarks
|
|
437
|
+
* Resets the gamma of midtones to the value set by resource
|
|
438
|
+
* packs
|
|
439
|
+
*
|
|
440
|
+
* This function can't be called in restricted-execution mode.
|
|
441
|
+
*
|
|
442
|
+
* @throws This function can throw errors.
|
|
443
|
+
*
|
|
444
|
+
* {@link minecraftcommon.EngineError}
|
|
445
|
+
*/
|
|
446
|
+
resetMidtonesGamma(): void;
|
|
447
|
+
/**
|
|
448
|
+
* @remarks
|
|
449
|
+
* Resets the offset of midtones to the value set by resource
|
|
450
|
+
* packs
|
|
451
|
+
*
|
|
452
|
+
* This function can't be called in restricted-execution mode.
|
|
453
|
+
*
|
|
454
|
+
* @throws This function can throw errors.
|
|
455
|
+
*
|
|
456
|
+
* {@link minecraftcommon.EngineError}
|
|
457
|
+
*/
|
|
458
|
+
resetMidtonesOffset(): void;
|
|
459
|
+
/**
|
|
460
|
+
* @remarks
|
|
461
|
+
* Resets the saturation of midtones to the value set by
|
|
462
|
+
* resource packs
|
|
463
|
+
*
|
|
464
|
+
* This function can't be called in restricted-execution mode.
|
|
465
|
+
*
|
|
466
|
+
* @throws This function can throw errors.
|
|
467
|
+
*
|
|
468
|
+
* {@link minecraftcommon.EngineError}
|
|
469
|
+
*/
|
|
470
|
+
resetMidtonesSaturation(): void;
|
|
471
|
+
/**
|
|
472
|
+
* @remarks
|
|
473
|
+
* Resets the contrast of shadows to the value set by resource
|
|
474
|
+
* packs
|
|
475
|
+
*
|
|
476
|
+
* This function can't be called in restricted-execution mode.
|
|
477
|
+
*
|
|
478
|
+
* @throws This function can throw errors.
|
|
479
|
+
*
|
|
480
|
+
* {@link minecraftcommon.EngineError}
|
|
481
|
+
*/
|
|
482
|
+
resetShadowsContrast(): void;
|
|
483
|
+
/**
|
|
484
|
+
* @remarks
|
|
485
|
+
* Resets the gain of shadows to the value set by resource
|
|
486
|
+
* packs
|
|
487
|
+
*
|
|
488
|
+
* This function can't be called in restricted-execution mode.
|
|
489
|
+
*
|
|
490
|
+
* @throws This function can throw errors.
|
|
491
|
+
*
|
|
492
|
+
* {@link minecraftcommon.EngineError}
|
|
493
|
+
*/
|
|
494
|
+
resetShadowsGain(): void;
|
|
495
|
+
/**
|
|
496
|
+
* @remarks
|
|
497
|
+
* Resets the gamma of shadows to the value set by resource
|
|
498
|
+
* packs
|
|
499
|
+
*
|
|
500
|
+
* This function can't be called in restricted-execution mode.
|
|
501
|
+
*
|
|
502
|
+
* @throws This function can throw errors.
|
|
503
|
+
*
|
|
504
|
+
* {@link minecraftcommon.EngineError}
|
|
505
|
+
*/
|
|
506
|
+
resetShadowsGamma(): void;
|
|
507
|
+
/**
|
|
508
|
+
* @remarks
|
|
509
|
+
* Resets the shadows max to the value set by resource packs
|
|
510
|
+
*
|
|
511
|
+
* This function can't be called in restricted-execution mode.
|
|
512
|
+
*
|
|
513
|
+
* @throws This function can throw errors.
|
|
514
|
+
*
|
|
515
|
+
* {@link minecraftcommon.EngineError}
|
|
516
|
+
*/
|
|
517
|
+
resetShadowsMax(): void;
|
|
518
|
+
/**
|
|
519
|
+
* @remarks
|
|
520
|
+
* Resets the offset of shadows to the value set by resource
|
|
521
|
+
* packs
|
|
522
|
+
*
|
|
523
|
+
* This function can't be called in restricted-execution mode.
|
|
524
|
+
*
|
|
525
|
+
* @throws This function can throw errors.
|
|
526
|
+
*
|
|
527
|
+
* {@link minecraftcommon.EngineError}
|
|
528
|
+
*/
|
|
529
|
+
resetShadowsOffset(): void;
|
|
530
|
+
/**
|
|
531
|
+
* @remarks
|
|
532
|
+
* Resets the saturation of shadows to the value set by
|
|
533
|
+
* resource packs
|
|
534
|
+
*
|
|
535
|
+
* This function can't be called in restricted-execution mode.
|
|
536
|
+
*
|
|
537
|
+
* @throws This function can throw errors.
|
|
538
|
+
*
|
|
539
|
+
* {@link minecraftcommon.EngineError}
|
|
540
|
+
*/
|
|
541
|
+
resetShadowsSaturation(): void;
|
|
542
|
+
/**
|
|
543
|
+
* @remarks
|
|
544
|
+
* Resets the temperature to the value set by resource packs
|
|
545
|
+
*
|
|
546
|
+
* This function can't be called in restricted-execution mode.
|
|
547
|
+
*
|
|
548
|
+
* @throws This function can throw errors.
|
|
549
|
+
*
|
|
550
|
+
* {@link minecraftcommon.EngineError}
|
|
551
|
+
*/
|
|
552
|
+
resetTemperature(): void;
|
|
553
|
+
/**
|
|
554
|
+
* @remarks
|
|
555
|
+
* Sets the contrast of highlights for color grading in Vibrant
|
|
556
|
+
* Visuals
|
|
557
|
+
*
|
|
558
|
+
* This function can't be called in restricted-execution mode.
|
|
559
|
+
*
|
|
560
|
+
* @param highlightsContrast
|
|
561
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of
|
|
562
|
+
* highlights. Describes the tonal range, the difference in
|
|
563
|
+
* luminance between the bright and dark pixels in an image. An
|
|
564
|
+
* image with high contrast will have pixels with a wide range
|
|
565
|
+
* of luminance values, whereas an image with low contrast will
|
|
566
|
+
* have pixels of a relatively small luminance range. A value
|
|
567
|
+
* of 1.0 results in no change in contrast to the original
|
|
568
|
+
* image. A value of 0.0 results in a completely washed-out,
|
|
569
|
+
* gray image. Values > 1.0 increase the brightness of
|
|
570
|
+
* highlights while darkening the shadows in the final image.
|
|
571
|
+
* @throws This function can throw errors.
|
|
572
|
+
*
|
|
573
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
574
|
+
*/
|
|
575
|
+
setHighlightsContrast(highlightsContrast: minecraftserver.Vector3): void;
|
|
576
|
+
/**
|
|
577
|
+
* @remarks
|
|
578
|
+
* Sets the gain of highlights for color grading in Vibrant
|
|
579
|
+
* Visuals
|
|
580
|
+
*
|
|
581
|
+
* This function can't be called in restricted-execution mode.
|
|
582
|
+
*
|
|
583
|
+
* @param highlightsGain
|
|
584
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the gain of
|
|
585
|
+
* highlights. A multiplication factor applied to each color
|
|
586
|
+
* channel to adjust the overall luminance intensity of the
|
|
587
|
+
* highlight range. A value of 1.0 results in no change to the
|
|
588
|
+
* original image. Values < 1.0 darken the image while values >
|
|
589
|
+
* 1.0 brighten it. A value of 0.0 cancels out the color
|
|
590
|
+
* channel completely. Gain is multiplicative and therefore has
|
|
591
|
+
* a stronger effect on brighter pixels than darker pixels.
|
|
592
|
+
* @throws This function can throw errors.
|
|
593
|
+
*
|
|
594
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
595
|
+
*/
|
|
596
|
+
setHighlightsGain(highlightsGain: minecraftserver.Vector3): void;
|
|
597
|
+
/**
|
|
598
|
+
* @remarks
|
|
599
|
+
* Sets the gamma of highlights for color grading in Vibrant
|
|
600
|
+
* Visuals
|
|
601
|
+
*
|
|
602
|
+
* This function can't be called in restricted-execution mode.
|
|
603
|
+
*
|
|
604
|
+
* @param highlightsGamma
|
|
605
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of
|
|
606
|
+
* highlights. An exponential factor applied to the final color
|
|
607
|
+
* after both color grading and tone mapping to adjust the
|
|
608
|
+
* overall luminance intensity of the image. The standard value
|
|
609
|
+
* for gamma is 2.2. Lower values darken the final image,
|
|
610
|
+
* whereas higher values brighten it. Too high a gamma will
|
|
611
|
+
* cause the final image to appear washed-out.
|
|
612
|
+
* @throws This function can throw errors.
|
|
613
|
+
*
|
|
614
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
615
|
+
*/
|
|
616
|
+
setHighlightsGamma(highlightsGamma: minecraftserver.Vector3): void;
|
|
617
|
+
/**
|
|
618
|
+
* @remarks
|
|
619
|
+
* Sets the highlights min for color grading in Vibrant Visuals
|
|
620
|
+
*
|
|
621
|
+
* This function can't be called in restricted-execution mode.
|
|
622
|
+
*
|
|
623
|
+
* @param highlightsMin
|
|
624
|
+
* A number (range [1.0f, 20.0f]). Used to set the highlights
|
|
625
|
+
* min. A factor multiplied by the average luminance of the
|
|
626
|
+
* scene to determine which pixels are considered highlights.
|
|
627
|
+
* Pixels with luminance greater than HighlightsMin *
|
|
628
|
+
* AverageLuminance will have the highlights set of color
|
|
629
|
+
* grading values applied. A value of 1.0 indicates highlights
|
|
630
|
+
* occupy the entire range of values including and above the
|
|
631
|
+
* average luminance. Higher values will cause the minimum
|
|
632
|
+
* required luminance value for a pixel to be considered a
|
|
633
|
+
* highlight to rise. This value should not be equal to
|
|
634
|
+
* ShadowsMax.
|
|
635
|
+
* @throws This function can throw errors.
|
|
636
|
+
*
|
|
637
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
638
|
+
*/
|
|
639
|
+
setHighlightsMin(highlightsMin: number): void;
|
|
640
|
+
/**
|
|
641
|
+
* @remarks
|
|
642
|
+
* Sets the offset of highlights for color grading in Vibrant
|
|
643
|
+
* Visuals
|
|
644
|
+
*
|
|
645
|
+
* This function can't be called in restricted-execution mode.
|
|
646
|
+
*
|
|
647
|
+
* @param highlightsOffset
|
|
648
|
+
* A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of
|
|
649
|
+
* highlights. An additive factor that is multiplied by the
|
|
650
|
+
* average luminance of the scene and then added to a given
|
|
651
|
+
* color channel to adjust the overall luminance intensity of
|
|
652
|
+
* the image. A value of 0.0 results in no change. Values > 0.0
|
|
653
|
+
* brighten the image, values < 0.0 darken it. Offset is
|
|
654
|
+
* additive and therefore has a stronger effect on darker
|
|
655
|
+
* pixels than brighter pixels.
|
|
656
|
+
* @throws This function can throw errors.
|
|
657
|
+
*
|
|
658
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
659
|
+
*/
|
|
660
|
+
setHighlightsOffset(highlightsOffset: minecraftserver.Vector3): void;
|
|
661
|
+
/**
|
|
662
|
+
* @remarks
|
|
663
|
+
* Sets the saturation of highlights for color grading in
|
|
664
|
+
* Vibrant Visuals
|
|
665
|
+
*
|
|
666
|
+
* This function can't be called in restricted-execution mode.
|
|
667
|
+
*
|
|
668
|
+
* @param highlightsSaturation
|
|
669
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the saturation
|
|
670
|
+
* of highlights. Determines the hue intensity of colors. A
|
|
671
|
+
* value of 1.0 results in no change in saturation to the
|
|
672
|
+
* original image. A value of 0.0 results in a grayscale image.
|
|
673
|
+
* Values > 1.0 increase the intensity of colors.
|
|
674
|
+
* @throws This function can throw errors.
|
|
675
|
+
*
|
|
676
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
677
|
+
*/
|
|
678
|
+
setHighlightsSaturation(highlightsSaturation: minecraftserver.Vector3): void;
|
|
679
|
+
/**
|
|
680
|
+
* @remarks
|
|
681
|
+
* Sets the contrast of midtones for color grading in Vibrant
|
|
682
|
+
* Visuals
|
|
683
|
+
*
|
|
684
|
+
* This function can't be called in restricted-execution mode.
|
|
685
|
+
*
|
|
686
|
+
* @param midtonesContrast
|
|
687
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of
|
|
688
|
+
* midtones. Describes the tonal range, the difference in
|
|
689
|
+
* luminance between the bright and dark pixels in an image. An
|
|
690
|
+
* image with high contrast will have pixels with a wide range
|
|
691
|
+
* of luminance values, whereas an image with low contrast will
|
|
692
|
+
* have pixels of a relatively small luminance range. A value
|
|
693
|
+
* of 1.0 results in no change in contrast to the original
|
|
694
|
+
* image. A value of 0.0 results in a completely washed-out,
|
|
695
|
+
* gray image. Values > 1.0 increase the brightness of
|
|
696
|
+
* highlights while darkening the shadows in the final image.
|
|
697
|
+
* @throws This function can throw errors.
|
|
698
|
+
*
|
|
699
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
700
|
+
*/
|
|
701
|
+
setMidtonesContrast(midtonesContrast: minecraftserver.Vector3): void;
|
|
702
|
+
/**
|
|
703
|
+
* @remarks
|
|
704
|
+
* Sets the gain of midtones for color grading in Vibrant
|
|
705
|
+
* Visuals
|
|
706
|
+
*
|
|
707
|
+
* This function can't be called in restricted-execution mode.
|
|
708
|
+
*
|
|
709
|
+
* @param midtonesGain
|
|
710
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the gain of
|
|
711
|
+
* midtones. A multiplication factor applied to each color
|
|
712
|
+
* channel to adjust the overall luminance intensity of the
|
|
713
|
+
* midtone range. A value of 1.0 results in no change to the
|
|
714
|
+
* original image. Values < 1.0 darken the image while values >
|
|
715
|
+
* 1.0 brighten it. A value of 0.0 cancels out the color
|
|
716
|
+
* channel completely. Gain is multiplicative and therefore has
|
|
717
|
+
* a stronger effect on brighter pixels than darker pixels.
|
|
718
|
+
* @throws This function can throw errors.
|
|
719
|
+
*
|
|
720
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
721
|
+
*/
|
|
722
|
+
setMidtonesGain(midtonesGain: minecraftserver.Vector3): void;
|
|
723
|
+
/**
|
|
724
|
+
* @remarks
|
|
725
|
+
* Sets the gamma of midtones for color grading in Vibrant
|
|
726
|
+
* Visuals
|
|
727
|
+
*
|
|
728
|
+
* This function can't be called in restricted-execution mode.
|
|
729
|
+
*
|
|
730
|
+
* @param midtonesGamma
|
|
731
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of
|
|
732
|
+
* midtones. An exponential factor applied to the final color
|
|
733
|
+
* after both color grading and tone mapping to adjust the
|
|
734
|
+
* overall luminance intensity of the image. The standard value
|
|
735
|
+
* for gamma is 2.2. Lower values darken the final image,
|
|
736
|
+
* whereas higher values brighten it. Too high a gamma will
|
|
737
|
+
* cause the final image to appear washed-out.
|
|
738
|
+
* @throws This function can throw errors.
|
|
739
|
+
*
|
|
740
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
741
|
+
*/
|
|
742
|
+
setMidtonesGamma(midtonesGamma: minecraftserver.Vector3): void;
|
|
743
|
+
/**
|
|
744
|
+
* @remarks
|
|
745
|
+
* Sets the offset of midtones for color grading in Vibrant
|
|
746
|
+
* Visuals
|
|
747
|
+
*
|
|
748
|
+
* This function can't be called in restricted-execution mode.
|
|
749
|
+
*
|
|
750
|
+
* @param midtonesOffset
|
|
751
|
+
* A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of
|
|
752
|
+
* midtones. An additive factor that is multiplied by the
|
|
753
|
+
* average luminance of the scene and then added to a given
|
|
754
|
+
* color channel to adjust the overall luminance intensity of
|
|
755
|
+
* the image. A value of 0.0 results in no change. Values > 0.0
|
|
756
|
+
* brighten the image, values < 0.0 darken it. Offset is
|
|
757
|
+
* additive and therefore has a stronger effect on darker
|
|
758
|
+
* pixels than brighter pixels.
|
|
759
|
+
* @throws This function can throw errors.
|
|
760
|
+
*
|
|
761
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
762
|
+
*/
|
|
763
|
+
setMidtonesOffset(midtonesOffset: minecraftserver.Vector3): void;
|
|
764
|
+
/**
|
|
765
|
+
* @remarks
|
|
766
|
+
* Sets the saturation of midtones for color grading in Vibrant
|
|
767
|
+
* Visuals
|
|
768
|
+
*
|
|
769
|
+
* This function can't be called in restricted-execution mode.
|
|
770
|
+
*
|
|
771
|
+
* @param midtonesSaturation
|
|
772
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the saturation
|
|
773
|
+
* of midtones. Determines the hue intensity of colors. A value
|
|
774
|
+
* of 1.0 results in no change in saturation to the original
|
|
775
|
+
* image. A value of 0.0 results in a grayscale image. Values >
|
|
776
|
+
* 1.0 increase the intensity of colors.
|
|
777
|
+
* @throws This function can throw errors.
|
|
778
|
+
*
|
|
779
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
780
|
+
*/
|
|
781
|
+
setMidtonesSaturation(midtonesSaturation: minecraftserver.Vector3): void;
|
|
782
|
+
/**
|
|
783
|
+
* @remarks
|
|
784
|
+
* Sets the contrast of shadows for color grading in Vibrant
|
|
785
|
+
* Visuals
|
|
786
|
+
*
|
|
787
|
+
* This function can't be called in restricted-execution mode.
|
|
788
|
+
*
|
|
789
|
+
* @param shadowsContrast
|
|
790
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the contrast of
|
|
791
|
+
* shadows. Describes the tonal range, the difference in
|
|
792
|
+
* luminance between the bright and dark pixels in an image. An
|
|
793
|
+
* image with high contrast will have pixels with a wide range
|
|
794
|
+
* of luminance values, whereas an image with low contrast will
|
|
795
|
+
* have pixels of a relatively small luminance range. A value
|
|
796
|
+
* of 1.0 results in no change in contrast to the original
|
|
797
|
+
* image. A value of 0.0 results in a completely washed-out,
|
|
798
|
+
* gray image. Values > 1.0 increase the brightness of
|
|
799
|
+
* highlights while darkening the shadows in the final image.
|
|
800
|
+
* @throws This function can throw errors.
|
|
801
|
+
*
|
|
802
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
803
|
+
*/
|
|
804
|
+
setShadowsContrast(shadowsContrast: minecraftserver.Vector3): void;
|
|
805
|
+
/**
|
|
806
|
+
* @remarks
|
|
807
|
+
* Sets the gain of shadows for color grading in Vibrant
|
|
808
|
+
* Visuals
|
|
809
|
+
*
|
|
810
|
+
* This function can't be called in restricted-execution mode.
|
|
811
|
+
*
|
|
812
|
+
* @param shadowsGain
|
|
813
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the gain of
|
|
814
|
+
* shadows. A multiplication factor applied to each color
|
|
815
|
+
* channel to adjust the overall luminance intensity of the
|
|
816
|
+
* shadow range. A value of 1.0 results in no change to the
|
|
817
|
+
* original image. Values < 1.0 darken the image while values >
|
|
818
|
+
* 1.0 brighten it. A value of 0.0 cancels out the color
|
|
819
|
+
* channel completely. Gain is multiplicative and therefore has
|
|
820
|
+
* a stronger effect on brighter pixels than darker pixels.
|
|
821
|
+
* @throws This function can throw errors.
|
|
822
|
+
*
|
|
823
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
824
|
+
*/
|
|
825
|
+
setShadowsGain(shadowsGain: minecraftserver.Vector3): void;
|
|
826
|
+
/**
|
|
827
|
+
* @remarks
|
|
828
|
+
* Sets the gamma of shadows for color grading in Vibrant
|
|
829
|
+
* Visuals
|
|
830
|
+
*
|
|
831
|
+
* This function can't be called in restricted-execution mode.
|
|
832
|
+
*
|
|
833
|
+
* @param shadowsGamma
|
|
834
|
+
* A Vector3 (range [0.0f, 4.0f]). Used to set the gamma of
|
|
835
|
+
* shadows. An exponential factor applied to the final color
|
|
836
|
+
* after both color grading and tone mapping to adjust the
|
|
837
|
+
* overall luminance intensity of the image. The standard value
|
|
838
|
+
* for gamma is 2.2. Lower values darken the final image,
|
|
839
|
+
* whereas higher values brighten it. Too high a gamma will
|
|
840
|
+
* cause the final image to appear washed-out.
|
|
841
|
+
* @throws This function can throw errors.
|
|
842
|
+
*
|
|
843
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
844
|
+
*/
|
|
845
|
+
setShadowsGamma(shadowsGamma: minecraftserver.Vector3): void;
|
|
846
|
+
/**
|
|
847
|
+
* @remarks
|
|
848
|
+
* Sets the shadows max for color grading in Vibrant Visuals
|
|
849
|
+
*
|
|
850
|
+
* This function can't be called in restricted-execution mode.
|
|
851
|
+
*
|
|
852
|
+
* @param shadowsMax
|
|
853
|
+
* A number (range [0.0f, 1.0f]). Used to set the shadows max.
|
|
854
|
+
* A factor multiplied by the average luminance of the scene to
|
|
855
|
+
* determine which pixels are considered shadows. Pixels with
|
|
856
|
+
* luminance less than ShadowsMax * AverageLuminance will have
|
|
857
|
+
* the shadows set of color grading values applied. A value of
|
|
858
|
+
* 1.0 indicates shadows occupy the entire range of values
|
|
859
|
+
* including and up to the average luminance. Lower values will
|
|
860
|
+
* cause the maximum required luminance value for a pixel to be
|
|
861
|
+
* considered a shadow to drop. This value should not be equal
|
|
862
|
+
* to HighlightsMin.
|
|
863
|
+
* @throws This function can throw errors.
|
|
864
|
+
*
|
|
865
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
866
|
+
*/
|
|
867
|
+
setShadowsMax(shadowsMax: number): void;
|
|
868
|
+
/**
|
|
869
|
+
* @remarks
|
|
870
|
+
* Sets the offset of shadows for color grading in Vibrant
|
|
871
|
+
* Visuals
|
|
872
|
+
*
|
|
873
|
+
* This function can't be called in restricted-execution mode.
|
|
874
|
+
*
|
|
875
|
+
* @param shadowsOffset
|
|
876
|
+
* A Vector3 (range [-1.0f, 1.0f]). Used to set the offset of
|
|
877
|
+
* shadows. An additive factor that is multiplied by the
|
|
878
|
+
* average luminance of the scene and then added to a given
|
|
879
|
+
* color channel to adjust the overall luminance intensity of
|
|
880
|
+
* the image. A value of 0.0 results in no change. Values > 0.0
|
|
881
|
+
* brighten the image, values < 0.0 darken it. Offset is
|
|
882
|
+
* additive and therefore has a stronger effect on darker
|
|
883
|
+
* pixels than brighter pixels.
|
|
884
|
+
* @throws This function can throw errors.
|
|
885
|
+
*
|
|
886
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
887
|
+
*/
|
|
888
|
+
setShadowsOffset(shadowsOffset: minecraftserver.Vector3): void;
|
|
889
|
+
/**
|
|
890
|
+
* @remarks
|
|
891
|
+
* Sets the saturation of shadows for color grading in Vibrant
|
|
892
|
+
* Visuals
|
|
893
|
+
*
|
|
894
|
+
* This function can't be called in restricted-execution mode.
|
|
895
|
+
*
|
|
896
|
+
* @param shadowsSaturation
|
|
897
|
+
* A Vector3 (range [0.0f, 10.0f]). Used to set the saturation
|
|
898
|
+
* of shadows. Determines the hue intensity of colors. A value
|
|
899
|
+
* of 1.0 results in no change in saturation to the original
|
|
900
|
+
* image. A value of 0.0 results in a grayscale image. Values >
|
|
901
|
+
* 1.0 increase the intensity of colors.
|
|
902
|
+
* @throws This function can throw errors.
|
|
903
|
+
*
|
|
904
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
905
|
+
*/
|
|
906
|
+
setShadowsSaturation(shadowsSaturation: minecraftserver.Vector3): void;
|
|
907
|
+
/**
|
|
908
|
+
* @remarks
|
|
909
|
+
* Sets the temperature for color grading in Vibrant Visuals
|
|
910
|
+
*
|
|
911
|
+
* This function can't be called in restricted-execution mode.
|
|
912
|
+
*
|
|
913
|
+
* @param temperature
|
|
914
|
+
* A number (range [1000.0f, 15000.0f]). Used to set the
|
|
915
|
+
* temperature. The overall image temperature measured in
|
|
916
|
+
* Kelvin. The default value is 6500.0, the standard "daylight"
|
|
917
|
+
* illumination.
|
|
918
|
+
* @throws This function can throw errors.
|
|
919
|
+
*
|
|
920
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
921
|
+
*/
|
|
922
|
+
setTemperature(temperature: number): void;
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
/**
|
|
926
|
+
* Used to affect lighting for Vibrant Visuals
|
|
927
|
+
*/
|
|
928
|
+
export class BiomeLighting {
|
|
929
|
+
private constructor();
|
|
930
|
+
/**
|
|
931
|
+
* @remarks
|
|
932
|
+
* Resets the ambient color to the value set by resource packs
|
|
933
|
+
*
|
|
934
|
+
* This function can't be called in restricted-execution mode.
|
|
935
|
+
*
|
|
936
|
+
* @throws This function can throw errors.
|
|
937
|
+
*
|
|
938
|
+
* {@link minecraftcommon.EngineError}
|
|
939
|
+
*/
|
|
940
|
+
resetAmbientColor(): void;
|
|
941
|
+
/**
|
|
942
|
+
* @remarks
|
|
943
|
+
* Resets the ambient illuminance to the value set by resource
|
|
944
|
+
* packs
|
|
945
|
+
*
|
|
946
|
+
* This function can't be called in restricted-execution mode.
|
|
947
|
+
*
|
|
948
|
+
* @throws This function can throw errors.
|
|
949
|
+
*
|
|
950
|
+
* {@link minecraftcommon.EngineError}
|
|
951
|
+
*/
|
|
952
|
+
resetAmbientIlluminance(): void;
|
|
953
|
+
/**
|
|
954
|
+
* @remarks
|
|
955
|
+
* Resets the emissive desaturation to the value set by
|
|
956
|
+
* resource packs
|
|
957
|
+
*
|
|
958
|
+
* This function can't be called in restricted-execution mode.
|
|
959
|
+
*
|
|
960
|
+
* @throws This function can throw errors.
|
|
961
|
+
*
|
|
962
|
+
* {@link minecraftcommon.EngineError}
|
|
963
|
+
*/
|
|
964
|
+
resetEmissiveDesaturation(): void;
|
|
965
|
+
/**
|
|
966
|
+
* @remarks
|
|
967
|
+
* Resets the flash color to the value set by resource packs
|
|
968
|
+
*
|
|
969
|
+
* This function can't be called in restricted-execution mode.
|
|
970
|
+
*
|
|
971
|
+
* @throws This function can throw errors.
|
|
972
|
+
*
|
|
973
|
+
* {@link minecraftcommon.EngineError}
|
|
974
|
+
*/
|
|
975
|
+
resetFlashColor(): void;
|
|
976
|
+
/**
|
|
977
|
+
* @remarks
|
|
978
|
+
* Resets the flash illuminance to the value set by resource
|
|
979
|
+
* packs
|
|
980
|
+
*
|
|
981
|
+
* This function can't be called in restricted-execution mode.
|
|
982
|
+
*
|
|
983
|
+
* @throws This function can throw errors.
|
|
984
|
+
*
|
|
985
|
+
* {@link minecraftcommon.EngineError}
|
|
986
|
+
*/
|
|
987
|
+
resetFlashIlluminance(): void;
|
|
988
|
+
/**
|
|
989
|
+
* @remarks
|
|
990
|
+
* Resets the moon color to the value set by resource packs
|
|
991
|
+
*
|
|
992
|
+
* This function can't be called in restricted-execution mode.
|
|
993
|
+
*
|
|
994
|
+
* @throws This function can throw errors.
|
|
995
|
+
*
|
|
996
|
+
* {@link minecraftcommon.EngineError}
|
|
997
|
+
*/
|
|
998
|
+
resetMoonColor(): void;
|
|
999
|
+
/**
|
|
1000
|
+
* @remarks
|
|
1001
|
+
* Resets the moon illuminance to the value set by resource
|
|
1002
|
+
* packs
|
|
1003
|
+
*
|
|
1004
|
+
* This function can't be called in restricted-execution mode.
|
|
1005
|
+
*
|
|
1006
|
+
* @throws This function can throw errors.
|
|
1007
|
+
*
|
|
1008
|
+
* {@link minecraftcommon.EngineError}
|
|
1009
|
+
*/
|
|
1010
|
+
resetMoonIlluminance(): void;
|
|
1011
|
+
/**
|
|
1012
|
+
* @remarks
|
|
1013
|
+
* Resets the orbital offset to the value set by resource packs
|
|
1014
|
+
*
|
|
1015
|
+
* This function can't be called in restricted-execution mode.
|
|
1016
|
+
*
|
|
1017
|
+
* @throws This function can throw errors.
|
|
1018
|
+
*
|
|
1019
|
+
* {@link minecraftcommon.EngineError}
|
|
1020
|
+
*/
|
|
1021
|
+
resetOrbitalOffsetDegrees(): void;
|
|
1022
|
+
/**
|
|
1023
|
+
* @remarks
|
|
1024
|
+
* Resets the sky intensity to the value set by resource packs
|
|
1025
|
+
*
|
|
1026
|
+
* This function can't be called in restricted-execution mode.
|
|
1027
|
+
*
|
|
1028
|
+
* @throws This function can throw errors.
|
|
1029
|
+
*
|
|
1030
|
+
* {@link minecraftcommon.EngineError}
|
|
1031
|
+
*/
|
|
1032
|
+
resetSkyIntensity(): void;
|
|
1033
|
+
/**
|
|
1034
|
+
* @remarks
|
|
1035
|
+
* Resets the sun color to the value set by resource packs
|
|
1036
|
+
*
|
|
1037
|
+
* This function can't be called in restricted-execution mode.
|
|
1038
|
+
*
|
|
1039
|
+
* @throws This function can throw errors.
|
|
1040
|
+
*
|
|
1041
|
+
* {@link minecraftcommon.EngineError}
|
|
1042
|
+
*/
|
|
1043
|
+
resetSunColor(): void;
|
|
1044
|
+
/**
|
|
1045
|
+
* @remarks
|
|
1046
|
+
* Resets the sun illuminance to the value set by resource
|
|
1047
|
+
* packs
|
|
1048
|
+
*
|
|
1049
|
+
* This function can't be called in restricted-execution mode.
|
|
1050
|
+
*
|
|
1051
|
+
* @throws This function can throw errors.
|
|
1052
|
+
*
|
|
1053
|
+
* {@link minecraftcommon.EngineError}
|
|
1054
|
+
*/
|
|
1055
|
+
resetSunIlluminance(): void;
|
|
1056
|
+
/**
|
|
1057
|
+
* @remarks
|
|
1058
|
+
* Sets the ambient color for lighting in Vibrant Visuals
|
|
1059
|
+
*
|
|
1060
|
+
* This function can't be called in restricted-execution mode.
|
|
1061
|
+
*
|
|
1062
|
+
* @throws This function can throw errors.
|
|
1063
|
+
*
|
|
1064
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1065
|
+
*/
|
|
1066
|
+
setAmbientColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
|
|
1067
|
+
/**
|
|
1068
|
+
* @remarks
|
|
1069
|
+
* Sets the ambient illuminance for lighting in Vibrant Visuals
|
|
1070
|
+
*
|
|
1071
|
+
* This function can't be called in restricted-execution mode.
|
|
1072
|
+
*
|
|
1073
|
+
* @throws This function can throw errors.
|
|
1074
|
+
*
|
|
1075
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1076
|
+
*/
|
|
1077
|
+
setAmbientIlluminance(illuminance: number | Record<number, number>): void;
|
|
1078
|
+
/**
|
|
1079
|
+
* @remarks
|
|
1080
|
+
* Sets the emissive desaturation for lighting in Vibrant
|
|
1081
|
+
* Visuals
|
|
1082
|
+
*
|
|
1083
|
+
* This function can't be called in restricted-execution mode.
|
|
1084
|
+
*
|
|
1085
|
+
* @throws This function can throw errors.
|
|
1086
|
+
*
|
|
1087
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1088
|
+
*/
|
|
1089
|
+
setEmissiveDesaturation(value: number): void;
|
|
1090
|
+
/**
|
|
1091
|
+
* @remarks
|
|
1092
|
+
* Sets the flash color for lighting in Vibrant Visuals
|
|
1093
|
+
*
|
|
1094
|
+
* This function can't be called in restricted-execution mode.
|
|
1095
|
+
*
|
|
1096
|
+
* @throws This function can throw errors.
|
|
1097
|
+
*
|
|
1098
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1099
|
+
*/
|
|
1100
|
+
setFlashColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
|
|
1101
|
+
/**
|
|
1102
|
+
* @remarks
|
|
1103
|
+
* Sets the flash illuminance for lighting in Vibrant Visuals
|
|
1104
|
+
*
|
|
1105
|
+
* This function can't be called in restricted-execution mode.
|
|
1106
|
+
*
|
|
1107
|
+
* @throws This function can throw errors.
|
|
1108
|
+
*
|
|
1109
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1110
|
+
*/
|
|
1111
|
+
setFlashIlluminance(illuminance: number | Record<number, number>): void;
|
|
1112
|
+
/**
|
|
1113
|
+
* @remarks
|
|
1114
|
+
* Sets the moon color for lighting in Vibrant Visuals
|
|
1115
|
+
*
|
|
1116
|
+
* This function can't be called in restricted-execution mode.
|
|
1117
|
+
*
|
|
1118
|
+
* @throws This function can throw errors.
|
|
1119
|
+
*
|
|
1120
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1121
|
+
*/
|
|
1122
|
+
setMoonColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
|
|
1123
|
+
/**
|
|
1124
|
+
* @remarks
|
|
1125
|
+
* Sets the moon illuminance for lighting in Vibrant Visuals
|
|
1126
|
+
*
|
|
1127
|
+
* This function can't be called in restricted-execution mode.
|
|
1128
|
+
*
|
|
1129
|
+
* @throws This function can throw errors.
|
|
1130
|
+
*
|
|
1131
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1132
|
+
*/
|
|
1133
|
+
setMoonIlluminance(illuminance: number | Record<number, number>): void;
|
|
1134
|
+
/**
|
|
1135
|
+
* @remarks
|
|
1136
|
+
* Sets the orbital offset for lighting in Vibrant Visuals
|
|
1137
|
+
*
|
|
1138
|
+
* This function can't be called in restricted-execution mode.
|
|
1139
|
+
*
|
|
1140
|
+
* @throws This function can throw errors.
|
|
1141
|
+
*
|
|
1142
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1143
|
+
*/
|
|
1144
|
+
setOrbitalOffsetDegrees(degrees: number | Record<number, number>): void;
|
|
1145
|
+
/**
|
|
1146
|
+
* @remarks
|
|
1147
|
+
* Sets the sky intensity for lighting in Vibrant Visuals
|
|
1148
|
+
*
|
|
1149
|
+
* This function can't be called in restricted-execution mode.
|
|
1150
|
+
*
|
|
1151
|
+
* @throws This function can throw errors.
|
|
1152
|
+
*
|
|
1153
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1154
|
+
*/
|
|
1155
|
+
setSkyIntensity(intensity: number | Record<number, number>): void;
|
|
1156
|
+
/**
|
|
1157
|
+
* @remarks
|
|
1158
|
+
* Sets the sun color for lighting in Vibrant Visuals
|
|
1159
|
+
*
|
|
1160
|
+
* This function can't be called in restricted-execution mode.
|
|
1161
|
+
*
|
|
1162
|
+
* @throws This function can throw errors.
|
|
1163
|
+
*
|
|
1164
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1165
|
+
*/
|
|
1166
|
+
setSunColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
|
|
1167
|
+
/**
|
|
1168
|
+
* @remarks
|
|
1169
|
+
* Sets the sun illuminance for lighting in Vibrant Visuals
|
|
1170
|
+
*
|
|
1171
|
+
* This function can't be called in restricted-execution mode.
|
|
1172
|
+
*
|
|
1173
|
+
* @throws This function can throw errors.
|
|
1174
|
+
*
|
|
1175
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1176
|
+
*/
|
|
1177
|
+
setSunIlluminance(illuminance: number | Record<number, number>): void;
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
* Used to affect water for Vibrant Visuals
|
|
1182
|
+
*/
|
|
1183
|
+
export class BiomeWater {
|
|
1184
|
+
private constructor();
|
|
1185
|
+
/**
|
|
1186
|
+
* @remarks
|
|
1187
|
+
* Resets the CDOM to the value set by resource packs
|
|
1188
|
+
*
|
|
1189
|
+
* This function can't be called in restricted-execution mode.
|
|
1190
|
+
*
|
|
1191
|
+
* @throws This function can throw errors.
|
|
1192
|
+
*
|
|
1193
|
+
* {@link minecraftcommon.EngineError}
|
|
1194
|
+
*/
|
|
1195
|
+
resetCDOM(): void;
|
|
1196
|
+
/**
|
|
1197
|
+
* @remarks
|
|
1198
|
+
* Resets the chlorophyll concentration to the value set by
|
|
1199
|
+
* resource packs
|
|
1200
|
+
*
|
|
1201
|
+
* This function can't be called in restricted-execution mode.
|
|
1202
|
+
*
|
|
1203
|
+
* @throws This function can throw errors.
|
|
1204
|
+
*
|
|
1205
|
+
* {@link minecraftcommon.EngineError}
|
|
1206
|
+
*/
|
|
1207
|
+
resetChlorophyll(): void;
|
|
1208
|
+
/**
|
|
1209
|
+
* @remarks
|
|
1210
|
+
* Resets the suspended sediment to the value set by resource
|
|
1211
|
+
* packs
|
|
1212
|
+
*
|
|
1213
|
+
* This function can't be called in restricted-execution mode.
|
|
1214
|
+
*
|
|
1215
|
+
* @throws This function can throw errors.
|
|
1216
|
+
*
|
|
1217
|
+
* {@link minecraftcommon.EngineError}
|
|
1218
|
+
*/
|
|
1219
|
+
resetSuspendedSediment(): void;
|
|
1220
|
+
/**
|
|
1221
|
+
* @remarks
|
|
1222
|
+
* Resets the wave depth to the value set by resource packs
|
|
1223
|
+
*
|
|
1224
|
+
* This function can't be called in restricted-execution mode.
|
|
1225
|
+
*
|
|
1226
|
+
* @throws This function can throw errors.
|
|
1227
|
+
*
|
|
1228
|
+
* {@link minecraftcommon.EngineError}
|
|
1229
|
+
*/
|
|
1230
|
+
resetWavesDepth(): void;
|
|
1231
|
+
/**
|
|
1232
|
+
* @remarks
|
|
1233
|
+
* Resets the wave direction increment to the value set by
|
|
1234
|
+
* resource packs
|
|
1235
|
+
*
|
|
1236
|
+
* This function can't be called in restricted-execution mode.
|
|
1237
|
+
*
|
|
1238
|
+
* @throws This function can throw errors.
|
|
1239
|
+
*
|
|
1240
|
+
* {@link minecraftcommon.EngineError}
|
|
1241
|
+
*/
|
|
1242
|
+
resetWavesDirectionIncrement(): void;
|
|
1243
|
+
/**
|
|
1244
|
+
* @remarks
|
|
1245
|
+
* Resets the wave frequency to the value set by resource packs
|
|
1246
|
+
*
|
|
1247
|
+
* This function can't be called in restricted-execution mode.
|
|
1248
|
+
*
|
|
1249
|
+
* @throws This function can throw errors.
|
|
1250
|
+
*
|
|
1251
|
+
* {@link minecraftcommon.EngineError}
|
|
1252
|
+
*/
|
|
1253
|
+
resetWavesFrequency(): void;
|
|
1254
|
+
/**
|
|
1255
|
+
* @remarks
|
|
1256
|
+
* Resets the wave frequency scaling to the value set by
|
|
1257
|
+
* resource packs
|
|
1258
|
+
*
|
|
1259
|
+
* This function can't be called in restricted-execution mode.
|
|
1260
|
+
*
|
|
1261
|
+
* @throws This function can throw errors.
|
|
1262
|
+
*
|
|
1263
|
+
* {@link minecraftcommon.EngineError}
|
|
1264
|
+
*/
|
|
1265
|
+
resetWavesFrequencyScaling(): void;
|
|
1266
|
+
/**
|
|
1267
|
+
* @remarks
|
|
1268
|
+
* Resets the wave mix to the value set by resource packs
|
|
1269
|
+
*
|
|
1270
|
+
* This function can't be called in restricted-execution mode.
|
|
1271
|
+
*
|
|
1272
|
+
* @throws This function can throw errors.
|
|
1273
|
+
*
|
|
1274
|
+
* {@link minecraftcommon.EngineError}
|
|
1275
|
+
*/
|
|
1276
|
+
resetWavesMix(): void;
|
|
1277
|
+
/**
|
|
1278
|
+
* @remarks
|
|
1279
|
+
* Resets the wave octaves to the value set by resource packs
|
|
1280
|
+
*
|
|
1281
|
+
* This function can't be called in restricted-execution mode.
|
|
1282
|
+
*
|
|
1283
|
+
* @throws This function can throw errors.
|
|
1284
|
+
*
|
|
1285
|
+
* {@link minecraftcommon.EngineError}
|
|
1286
|
+
*/
|
|
1287
|
+
resetWavesOctaves(): void;
|
|
1288
|
+
/**
|
|
1289
|
+
* @remarks
|
|
1290
|
+
* Resets the wave pull to the value set by resource packs
|
|
1291
|
+
*
|
|
1292
|
+
* This function can't be called in restricted-execution mode.
|
|
1293
|
+
*
|
|
1294
|
+
* @throws This function can throw errors.
|
|
1295
|
+
*
|
|
1296
|
+
* {@link minecraftcommon.EngineError}
|
|
1297
|
+
*/
|
|
1298
|
+
resetWavesPull(): void;
|
|
1299
|
+
/**
|
|
1300
|
+
* @remarks
|
|
1301
|
+
* Resets the wave shape to the value set by resource packs
|
|
1302
|
+
*
|
|
1303
|
+
* This function can't be called in restricted-execution mode.
|
|
1304
|
+
*
|
|
1305
|
+
* @throws This function can throw errors.
|
|
1306
|
+
*
|
|
1307
|
+
* {@link minecraftcommon.EngineError}
|
|
1308
|
+
*/
|
|
1309
|
+
resetWavesShape(): void;
|
|
1310
|
+
/**
|
|
1311
|
+
* @remarks
|
|
1312
|
+
* Resets the wave speed to the value set by resource packs
|
|
1313
|
+
*
|
|
1314
|
+
* This function can't be called in restricted-execution mode.
|
|
1315
|
+
*
|
|
1316
|
+
* @throws This function can throw errors.
|
|
1317
|
+
*
|
|
1318
|
+
* {@link minecraftcommon.EngineError}
|
|
1319
|
+
*/
|
|
1320
|
+
resetWavesSpeed(): void;
|
|
1321
|
+
/**
|
|
1322
|
+
* @remarks
|
|
1323
|
+
* Resets the wave speed scaling to the value set by resource
|
|
1324
|
+
* packs
|
|
1325
|
+
*
|
|
1326
|
+
* This function can't be called in restricted-execution mode.
|
|
1327
|
+
*
|
|
1328
|
+
* @throws This function can throw errors.
|
|
1329
|
+
*
|
|
1330
|
+
* {@link minecraftcommon.EngineError}
|
|
1331
|
+
*/
|
|
1332
|
+
resetWavesSpeedScaling(): void;
|
|
1333
|
+
/**
|
|
1334
|
+
* @remarks
|
|
1335
|
+
* Sets the CDOM for water in Vibrant Visuals
|
|
1336
|
+
*
|
|
1337
|
+
* This function can't be called in restricted-execution mode.
|
|
1338
|
+
*
|
|
1339
|
+
* @param cdom
|
|
1340
|
+
* A number (range [0,15]). Used to set the CDOM. High
|
|
1341
|
+
* concentrations produce yellow to yellow-brown colors, due to
|
|
1342
|
+
* CDOM strongly absorbing blue wavelengths. Open oceans
|
|
1343
|
+
* typically have little to no CDOM, and thus retain a blue
|
|
1344
|
+
* appearance; fresh water sources, like rivers, tend to have
|
|
1345
|
+
* higher concentrations.
|
|
1346
|
+
* @throws This function can throw errors.
|
|
1347
|
+
*
|
|
1348
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1349
|
+
*/
|
|
1350
|
+
setCDOM(cdom: number): void;
|
|
1351
|
+
/**
|
|
1352
|
+
* @remarks
|
|
1353
|
+
* Sets the chlorophyll concentration for water in Vibrant
|
|
1354
|
+
* Visuals
|
|
1355
|
+
*
|
|
1356
|
+
* This function can't be called in restricted-execution mode.
|
|
1357
|
+
*
|
|
1358
|
+
* @param chlorophyll
|
|
1359
|
+
* A number (range [0,10]). Used to set the chlorophyll
|
|
1360
|
+
* concentration. High concentrations produce green colors, due
|
|
1361
|
+
* to chlorophyll strongly absorbing blue and red wavelengths.
|
|
1362
|
+
* @throws This function can throw errors.
|
|
1363
|
+
*
|
|
1364
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1365
|
+
*/
|
|
1366
|
+
setChlorophyll(chlorophyll: number): void;
|
|
1367
|
+
/**
|
|
1368
|
+
* @remarks
|
|
1369
|
+
* Sets the suspended sediment for water in Vibrant Visuals
|
|
1370
|
+
*
|
|
1371
|
+
* This function can't be called in restricted-execution mode.
|
|
1372
|
+
*
|
|
1373
|
+
* @param suspendedSediment
|
|
1374
|
+
* A number (range [0,300]). Used to set the suspended
|
|
1375
|
+
* sediment. High concentrations produce red to red-brown
|
|
1376
|
+
* colors, due to suspended sediment strongly absorbing blue
|
|
1377
|
+
* and green wavelengths. Suspended sediment, like clay and
|
|
1378
|
+
* silt, tend to be concentrated in rivers and can indicate
|
|
1379
|
+
* recent floods or sources of pollution.
|
|
1380
|
+
* @throws This function can throw errors.
|
|
1381
|
+
*
|
|
1382
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1383
|
+
*/
|
|
1384
|
+
setSuspendedSediment(suspendedSediment: number): void;
|
|
1385
|
+
/**
|
|
1386
|
+
* @remarks
|
|
1387
|
+
* Sets the wave depth for water in Vibrant Visuals
|
|
1388
|
+
*
|
|
1389
|
+
* This function can't be called in restricted-execution mode.
|
|
1390
|
+
*
|
|
1391
|
+
* @param wavesDepth
|
|
1392
|
+
* A number (range [0,10]). Used to set the wave depth.
|
|
1393
|
+
* Determines how much waves displace the water surface. Larger
|
|
1394
|
+
* values will result in deeper waves, whereas smaller values
|
|
1395
|
+
* will produce shallower waves.
|
|
1396
|
+
* @throws This function can throw errors.
|
|
1397
|
+
*
|
|
1398
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1399
|
+
*/
|
|
1400
|
+
setWavesDepth(wavesDepth: number): void;
|
|
1401
|
+
/**
|
|
1402
|
+
* @remarks
|
|
1403
|
+
* Sets the wave direction increment for water in Vibrant
|
|
1404
|
+
* Visuals
|
|
1405
|
+
*
|
|
1406
|
+
* This function can't be called in restricted-execution mode.
|
|
1407
|
+
*
|
|
1408
|
+
* @param wavesDirectionIncrement
|
|
1409
|
+
* A number (range [0.0f, 360.0f]). Used to set the wave
|
|
1410
|
+
* direction increment. An angle, in degrees, that controls how
|
|
1411
|
+
* much the heading changes between each octave.
|
|
1412
|
+
* @throws This function can throw errors.
|
|
1413
|
+
*
|
|
1414
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1415
|
+
*/
|
|
1416
|
+
setWavesDirectionIncrement(wavesDirectionIncrement: number): void;
|
|
1417
|
+
/**
|
|
1418
|
+
* @remarks
|
|
1419
|
+
* Sets the wave frequency for water in Vibrant Visuals
|
|
1420
|
+
*
|
|
1421
|
+
* This function can't be called in restricted-execution mode.
|
|
1422
|
+
*
|
|
1423
|
+
* @param wavesFrequency
|
|
1424
|
+
* A number (range [0,10]). Used to set the wave frequency.
|
|
1425
|
+
* Determines how many waves there are per water block. Can
|
|
1426
|
+
* also be thought of as the size of the waves. Larger values
|
|
1427
|
+
* will create more tightly packed waves, whereas smaller
|
|
1428
|
+
* values will spread waves out over a wider area.
|
|
1429
|
+
* @throws This function can throw errors.
|
|
1430
|
+
*
|
|
1431
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1432
|
+
*/
|
|
1433
|
+
setWavesFrequency(wavesFrequency: number): void;
|
|
1434
|
+
/**
|
|
1435
|
+
* @remarks
|
|
1436
|
+
* Sets the wave frequency scaling for water in Vibrant Visuals
|
|
1437
|
+
*
|
|
1438
|
+
* This function can't be called in restricted-execution mode.
|
|
1439
|
+
*
|
|
1440
|
+
* @param wavesFrequencyScaling
|
|
1441
|
+
* A number (range [0,2]). Used to set the wave frequency
|
|
1442
|
+
* scaling. Specifies how much wave frequency changes between
|
|
1443
|
+
* octaves. A value of 1 will result in no change between
|
|
1444
|
+
* octaves. Values higher than 1 will cause frequencies to
|
|
1445
|
+
* increase while values less than 1 will cause frequencies to
|
|
1446
|
+
* decrease.
|
|
1447
|
+
* @throws This function can throw errors.
|
|
1448
|
+
*
|
|
1449
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1450
|
+
*/
|
|
1451
|
+
setWavesFrequencyScaling(wavesFrequencyScaling: number): void;
|
|
1452
|
+
/**
|
|
1453
|
+
* @remarks
|
|
1454
|
+
* Sets the wave mix for water in Vibrant Visuals
|
|
1455
|
+
*
|
|
1456
|
+
* This function can't be called in restricted-execution mode.
|
|
1457
|
+
*
|
|
1458
|
+
* @param wavesMix
|
|
1459
|
+
* A number (range [0.0, 1.0]). Used to set the wave mix.
|
|
1460
|
+
* Controls how much each octave is blended into the
|
|
1461
|
+
* neighboring octave.
|
|
1462
|
+
* @throws This function can throw errors.
|
|
1463
|
+
*
|
|
1464
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1465
|
+
*/
|
|
1466
|
+
setWavesMix(wavesMix: number): void;
|
|
1467
|
+
/**
|
|
1468
|
+
* @remarks
|
|
1469
|
+
* Sets the wave octaves for water in Vibrant Visuals
|
|
1470
|
+
*
|
|
1471
|
+
* This function can't be called in restricted-execution mode.
|
|
1472
|
+
*
|
|
1473
|
+
* @param wavesOctaves
|
|
1474
|
+
* A number (range [1.0, 10]). Used to set the wave octaves.
|
|
1475
|
+
* Determines how many layers of waves to simulate; high values
|
|
1476
|
+
* result in more complex waves
|
|
1477
|
+
* @throws This function can throw errors.
|
|
1478
|
+
*
|
|
1479
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1480
|
+
*/
|
|
1481
|
+
setWavesOctaves(wavesOctaves: number): void;
|
|
1482
|
+
/**
|
|
1483
|
+
* @remarks
|
|
1484
|
+
* Sets the wave pull for water in Vibrant Visuals
|
|
1485
|
+
*
|
|
1486
|
+
* This function can't be called in restricted-execution mode.
|
|
1487
|
+
*
|
|
1488
|
+
* @param wavesPull
|
|
1489
|
+
* A number (range [-1.0f, 1.0f]). Used to set the wave pull.
|
|
1490
|
+
* Controls how much smaller waves are pulled into larger
|
|
1491
|
+
* waves. A value of 0 results in no pull. Values larger than 0
|
|
1492
|
+
* will pull waves in a standard concave fashion, whereas
|
|
1493
|
+
* values less than 0 will pull waves in a convex fashion,
|
|
1494
|
+
* resulting in more pillowing waves as opposed to cresting
|
|
1495
|
+
* waves.
|
|
1496
|
+
* @throws This function can throw errors.
|
|
1497
|
+
*
|
|
1498
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1499
|
+
*/
|
|
1500
|
+
setWavesPull(wavesPull: number): void;
|
|
1501
|
+
/**
|
|
1502
|
+
* @remarks
|
|
1503
|
+
* Sets the wave shape for water in Vibrant Visuals
|
|
1504
|
+
*
|
|
1505
|
+
* This function can't be called in restricted-execution mode.
|
|
1506
|
+
*
|
|
1507
|
+
* @param wavesShape
|
|
1508
|
+
* A number (range [1.0, 10]). Used to set the wave shape.
|
|
1509
|
+
* Adjusts the core shape of waves. A value of 1 results in a
|
|
1510
|
+
* pure sine wave, whereas values larger than 1 will produce
|
|
1511
|
+
* sharper waves.
|
|
1512
|
+
* @throws This function can throw errors.
|
|
1513
|
+
*
|
|
1514
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1515
|
+
*/
|
|
1516
|
+
setWavesShape(wavesShape: number): void;
|
|
1517
|
+
/**
|
|
1518
|
+
* @remarks
|
|
1519
|
+
* Sets the wave speed for water in Vibrant Visuals
|
|
1520
|
+
*
|
|
1521
|
+
* This function can't be called in restricted-execution mode.
|
|
1522
|
+
*
|
|
1523
|
+
* @param wavesSpeed
|
|
1524
|
+
* A number (range [0.01,10]). Used to set the wave speed.
|
|
1525
|
+
* etermines the movement speed of the first wave and the
|
|
1526
|
+
* starting value of the Speed Scaling parameter.
|
|
1527
|
+
* @throws This function can throw errors.
|
|
1528
|
+
*
|
|
1529
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1530
|
+
*/
|
|
1531
|
+
setWavesSpeed(wavesSpeed: number): void;
|
|
1532
|
+
/**
|
|
1533
|
+
* @remarks
|
|
1534
|
+
* Sets the wave speed scaling for water in Vibrant Visuals
|
|
1535
|
+
*
|
|
1536
|
+
* This function can't be called in restricted-execution mode.
|
|
1537
|
+
*
|
|
1538
|
+
* @param wavesSpeedScaling
|
|
1539
|
+
* A number (range [0.0,2]). Used to set the wave speed
|
|
1540
|
+
* scaling. Controls how much faster each subsequent octave
|
|
1541
|
+
* moves. A value of 1 will result in no change between
|
|
1542
|
+
* octaves. Values higher than 1 will cause speeds to increase
|
|
1543
|
+
* while values less than 1 will cause speeds to decrease.
|
|
1544
|
+
* @throws This function can throw errors.
|
|
1545
|
+
*
|
|
1546
|
+
* {@link minecraftcommon.InvalidArgumentError}
|
|
1547
|
+
*/
|
|
1548
|
+
setWavesSpeedScaling(wavesSpeedScaling: number): void;
|
|
1549
|
+
}
|
|
1550
|
+
|
|
335
1551
|
/**
|
|
336
1552
|
* @remarks
|
|
337
1553
|
* Retrieves the BiomeAtmospherics component to control
|
|
@@ -341,3 +1557,82 @@ export class BiomeAtmospherics {
|
|
|
341
1557
|
*
|
|
342
1558
|
*/
|
|
343
1559
|
export function getBiomeAtmospherics(biome: minecraftserver.BiomeType): BiomeAtmospherics;
|
|
1560
|
+
/**
|
|
1561
|
+
* @remarks
|
|
1562
|
+
* Retrieves the BiomeColorGrading component to control color
|
|
1563
|
+
* grading for Vibrant Visuals.
|
|
1564
|
+
*
|
|
1565
|
+
* This function can't be called in restricted-execution mode.
|
|
1566
|
+
*
|
|
1567
|
+
*/
|
|
1568
|
+
export function getBiomeColorGrading(biome: minecraftserver.BiomeType): BiomeColorGrading;
|
|
1569
|
+
/**
|
|
1570
|
+
* @remarks
|
|
1571
|
+
* Retrieves the BiomeLighting component to control lighting
|
|
1572
|
+
* for Vibrant Visuals.
|
|
1573
|
+
*
|
|
1574
|
+
* This function can't be called in restricted-execution mode.
|
|
1575
|
+
*
|
|
1576
|
+
*/
|
|
1577
|
+
export function getBiomeLighting(biome: minecraftserver.BiomeType): BiomeLighting;
|
|
1578
|
+
/**
|
|
1579
|
+
* @remarks
|
|
1580
|
+
* Retrieves the BiomeWater component to control water for
|
|
1581
|
+
* Vibrant Visuals
|
|
1582
|
+
*
|
|
1583
|
+
* This function can't be called in restricted-execution mode.
|
|
1584
|
+
*
|
|
1585
|
+
*/
|
|
1586
|
+
export function getBiomeWater(biome: minecraftserver.BiomeType): BiomeWater;
|
|
1587
|
+
/**
|
|
1588
|
+
* @remarks
|
|
1589
|
+
* Retrieves the PlayerAtmospherics component to control
|
|
1590
|
+
* atmospheric scattering for a particular player in Vibrant
|
|
1591
|
+
* Visuals. This offers the same controls as BiomeAtmospherics,
|
|
1592
|
+
* but PlayerAtmospherics controls will always take precedence
|
|
1593
|
+
* over BiomeAtmospherics.
|
|
1594
|
+
*
|
|
1595
|
+
* This function can't be called in restricted-execution mode.
|
|
1596
|
+
*
|
|
1597
|
+
*/
|
|
1598
|
+
export function getPlayerAtmospherics(
|
|
1599
|
+
biome: minecraftserver.BiomeType,
|
|
1600
|
+
player: minecraftserver.Player,
|
|
1601
|
+
): BiomeAtmospherics;
|
|
1602
|
+
/**
|
|
1603
|
+
* @remarks
|
|
1604
|
+
* Retrieves the PlayerColorGrading component to control color
|
|
1605
|
+
* grading for a particular player in Vibrant Visuals. This
|
|
1606
|
+
* offers the same controls as BiomeColorGrading, but
|
|
1607
|
+
* PlayerColorGrading controls will always take precedence over
|
|
1608
|
+
* BiomeColorGrading.
|
|
1609
|
+
*
|
|
1610
|
+
* This function can't be called in restricted-execution mode.
|
|
1611
|
+
*
|
|
1612
|
+
*/
|
|
1613
|
+
export function getPlayerColorGrading(
|
|
1614
|
+
biome: minecraftserver.BiomeType,
|
|
1615
|
+
player: minecraftserver.Player,
|
|
1616
|
+
): BiomeColorGrading;
|
|
1617
|
+
/**
|
|
1618
|
+
* @remarks
|
|
1619
|
+
* Retrieves the PlayerLighting component to control lighting
|
|
1620
|
+
* for a particular player in Vibrant Visuals. This offers the
|
|
1621
|
+
* same controls as BiomeLighting, but PlayerLighting controls
|
|
1622
|
+
* will always take precedence over BiomeLighting.
|
|
1623
|
+
*
|
|
1624
|
+
* This function can't be called in restricted-execution mode.
|
|
1625
|
+
*
|
|
1626
|
+
*/
|
|
1627
|
+
export function getPlayerLighting(biome: minecraftserver.BiomeType, player: minecraftserver.Player): BiomeLighting;
|
|
1628
|
+
/**
|
|
1629
|
+
* @remarks
|
|
1630
|
+
* Retrieves the PlayerWater component to control water for a
|
|
1631
|
+
* particular player in Vibrant Visuals. This offers the same
|
|
1632
|
+
* controls as BiomeWater, but PlayerWater controls will always
|
|
1633
|
+
* take precedence over BiomeWater.
|
|
1634
|
+
*
|
|
1635
|
+
* This function can't be called in restricted-execution mode.
|
|
1636
|
+
*
|
|
1637
|
+
*/
|
|
1638
|
+
export function getPlayerWater(biome: minecraftserver.BiomeType, player: minecraftserver.Player): BiomeWater;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@minecraft/server-graphics",
|
|
3
|
-
"version": "1.0.0-beta.1.26.30-preview.
|
|
3
|
+
"version": "1.0.0-beta.1.26.30-preview.28",
|
|
4
4
|
"description": "",
|
|
5
5
|
"contributors": [
|
|
6
6
|
{
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
],
|
|
15
15
|
"peerDependencies": {
|
|
16
16
|
"@minecraft/common": "^1.0.0",
|
|
17
|
-
"@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.9.0-beta.1.26.30-preview.
|
|
17
|
+
"@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.9.0-beta.1.26.30-preview.28"
|
|
18
18
|
},
|
|
19
19
|
"license": "MIT"
|
|
20
20
|
}
|