大气散射
本文记录控制生物群系大气散射(天空颜色、雾霾与散射强度)的接口。数值与关键帧的写法见设置约定。
BiomeAtmospherics 类
1.0.0+该特性在server-graphics模块脚本版本1.0.0+下可用,但该版本对于当前的中国版版本过高。
某个生物群系(或某个玩家)的大气散射设置。实例通过getBiomeAtmospherics或getPlayerAtmospherics获取。
调用任何设置方法都需要读写模式。
class BiomeAtmospherics {
private constructor();
resetHorizonBlendMax(): void;
resetHorizonBlendMieStart(): void;
resetHorizonBlendMin(): void;
resetHorizonBlendStart(): void;
resetMoonMieStrength(): void;
resetRayleighStrength(): void;
resetSkyHorizonColor(): void;
resetSkyZenithColor(): void;
resetSunGlareShape(): void;
resetSunMieStrength(): void;
setHorizonBlendMax(blendMax: number | Record<number, number>): void;
setHorizonBlendMieStart(blendMieStart: number | Record<number, number>): void;
setHorizonBlendMin(blendMin: number | Record<number, number>): void;
setHorizonBlendStart(blendStart: number | Record<number, number>): void;
setMoonMieStrength(moonMieStrength: number | Record<number, number>): void;
setRayleighStrength(rayleighStrength: number | Record<number, number>): void;
setSkyHorizonColor(color: Record<number, RGB> | RGB): void;
setSkyZenithColor(color: Record<number, RGB> | RGB): void;
setSunGlareShape(sunGlareShape: number | Record<number, number>): void;
setSunMieStrength(sunMieStrength: number | Record<number, number>): void;
}
设置方法
受限执行该属性/方法不能在受限执行模式下使用。
| 方法 | 参数 | 取值范围 | 说明 |
|---|---|---|---|
setHorizonBlendMax | blendMax | 0 ~ 1 | 地平线混合的上限。 |
setHorizonBlendMieStart | blendMieStart | 0 ~ 1.2 | 地平线米氏散射混合的起点。 |
setHorizonBlendMin | blendMin | 0 ~ 1 | 地平线混合的下限。 |
setHorizonBlendStart | blendStart | 0 ~ 1 | 地平线混合的起点。 |
setMoonMieStrength | moonMieStrength | 0 ~ 60 | 月球的米氏散射强度。 |
setRayleighStrength | rayleighStrength | 0 ~ 11 | 瑞利散射的强度。 |
setSkyHorizonColor | color | RGB | 天空在地平线处的颜色。 |
setSkyZenithColor | color | RGB | 天空在天顶处的颜色。 |
setSunGlareShape | sunGlareShape | 0 ~ 50 | 太阳眩光的形状。 |
setSunMieStrength | sunMieStrength | 0 ~ 60 | 太阳的米氏散射强度。 |
颜色类方法的color参数可传一个 RGB 三元组,也可传一组以时刻为键的关键帧。数值类方法同理。
重置方法
resetHorizonBlendMax、resetHorizonBlendMieStart、resetHorizonBlendMin、resetHorizonBlendStart、resetMoonMieStrength、resetRayleighStrength、resetSkyHorizonColor、resetSkyZenithColor、resetSunGlareShape、resetSunMieStrength分别把对应的设置恢复为资源包中设定的值,或行为包此前通过同名setXxx设定过的值。
resetSkyZenithColor(): void
参考文档
本文主要参考文档如下,读者可以在这些文档获得更多信息。