#Class: BiomeAtmospherics experimental

biome

Beta

用于在「灵动视效」(Vibrant Visuals) 中按生物群系影响大气散射。

Used to affect atmospheric scattering per biome for Vibrant Visuals

#Methods

#resetHorizonBlendMax()

resetHorizonBlendMax(): void

World Mutation Beta

#Returns

void

#Remarks

将地平线混合上限重置为资源包所设置的值,或通过行为包中的 'setHorizonBlendMax' API 所设置的值。

Resets the horizon blend max to the value set by resource packs or via the 'setHorizonBlendMax' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetHorizonBlendMieStart()

resetHorizonBlendMieStart(): void

World Mutation Beta

#Returns

void

#Remarks

将地平线混合 Mie 起始值重置为资源包所设置的值,或通过行为包中的 'setHorizonBlendMieStart' API 所设置的值。

Resets the horizon blend mie start to the value set by resource packs or via the 'setHorizonBlendMieStart' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetHorizonBlendMin()

resetHorizonBlendMin(): void

World Mutation Beta

#Returns

void

#Remarks

将地平线混合下限重置为资源包所设置的值,或通过行为包中的 'setHorizonBlendMin' API 所设置的值。

Resets the horizon blend min to the value set by resource packs or via the 'setHorizonBlendMin' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetHorizonBlendStart()

resetHorizonBlendStart(): void

World Mutation Beta

#Returns

void

#Remarks

将地平线混合起始值重置为资源包所设置的值,或通过行为包中的 'setHorizonBlendStart' API 所设置的值。

Resets the horizon blend start to the value set by resource packs or via the 'setHorizonBlendStart' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetMoonMieStrength()

resetMoonMieStrength(): void

World Mutation Beta

#Returns

void

#Remarks

将月亮 Mie 强度重置为资源包所设置的值,或通过行为包中的 'setMoonMieStrength' API 所设置的值。

Resets the moon mie strength to the value set by resource packs or via the 'setMoonMieStrength' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetRayleighStrength()

resetRayleighStrength(): void

World Mutation Beta

#Returns

void

#Remarks

将瑞利散射强度重置为资源包所设置的值,或通过行为包中的 'setRayleighStrength' API 所设置的值。

Resets the rayleigh strength to the value set by resource packs or via the 'setRayleighStrength' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetSkyHorizonColor()

resetSkyHorizonColor(): void

World Mutation Beta

#Returns

void

#Remarks

将天空地平线颜色重置为资源包所设置的值,或通过行为包中的 'setSkyHorizonColor' API 所设置的值。

Resets the sky horizon color to the color set by resource packs or via the 'setSkyHorizonColor' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetSkyZenithColor()

resetSkyZenithColor(): void

World Mutation Beta

#Returns

void

#Remarks

将天空天顶颜色重置为资源包所设置的值,或通过行为包中的 'setSkyZenithColor' API 所设置的值。

Resets the sky zenith color to the color set by resource packs or via the 'setSkyZenithColor' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetSunGlareShape()

resetSunGlareShape(): void

World Mutation Beta

#Returns

void

#Remarks

将太阳眩光形状重置为资源包所设置的值,或通过行为包中的 'setSunGlareShape' API 所设置的值。

Resets the sun glare shape to the value set by resource packs or via the 'setSunGlareShape' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#resetSunMieStrength()

resetSunMieStrength(): void

World Mutation Beta

#Returns

void

#Remarks

将太阳 Mie 强度重置为资源包所设置的值,或通过行为包中的 'setSunMieStrength' API 所设置的值。

Resets the sun mie strength to the value set by resource packs or via the 'setSunMieStrength' API in behavior packs

#Throws

This function can throw errors.

EngineError

---

#setHorizonBlendMax()

setHorizonBlendMax(blendMax): void

World Mutation Beta

#Parameters

#blendMax

number | Record<number, number>

一个数字(范围 [0,1])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,1])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置地平线混合上限。

Sets the horizon blend max for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setHorizonBlendMieStart()

setHorizonBlendMieStart(blendMieStart): void

World Mutation Beta

#Parameters

#blendMieStart

number | Record<number, number>

一个数字(范围 [0,1.2])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,1.2])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置地平线混合 Mie 起始值。

Sets the horizon blend mie start for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setHorizonBlendMin()

setHorizonBlendMin(blendMin): void

World Mutation Beta

#Parameters

#blendMin

number | Record<number, number>

一个数字(范围 [0,1])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,1])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置地平线混合下限。

Sets the horizon blend min for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setHorizonBlendStart()

setHorizonBlendStart(blendStart): void

World Mutation Beta

#Parameters

#blendStart

number | Record<number, number>

一个数字(范围 [0,1])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,1])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置地平线混合起始值。

Sets the horizon blend start for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setMoonMieStrength()

setMoonMieStrength(moonMieStrength): void

World Mutation Beta

#Parameters

#moonMieStrength

number | Record<number, number>

一个数字(范围 [0,60])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,60])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置月亮 Mie 强度。

Sets the moon mie strength for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setRayleighStrength()

setRayleighStrength(rayleighStrength): void

World Mutation Beta

#Parameters

#rayleighStrength

number | Record<number, number>

一个数字(范围 [0,11])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,11])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置瑞利散射强度。

Sets the rayleigh strength for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setSkyHorizonColor()

setSkyHorizonColor(color): void

World Mutation Beta

#Parameters

#color

any

一个 RGB 三元组或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出),值是一个 RGB 三元组

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置天空地平线颜色。

Sets the sky horizon color for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setSkyZenithColor()

setSkyZenithColor(color): void

World Mutation Beta

#Parameters

#color

any

一个 RGB 三元组或一组关键帧。关键帧由键值对组成。键是一个范围 0-1 的浮点数用于表示一天中的时间,值是一个 RGB 三元组

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置天空天顶颜色。

Sets the sky zenith color for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setSunGlareShape()

setSunGlareShape(sunGlareShape): void

World Mutation Beta

#Parameters

#sunGlareShape

number | Record<number, number>

一个数字(范围 [0,50])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,50])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置太阳眩光形状。

Sets the sun glare shape for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

---

#setSunMieStrength()

setSunMieStrength(sunMieStrength): void

World Mutation Beta

#Parameters

#sunMieStrength

number | Record<number, number>

一个数字(范围 [0,60])或一组关键帧。关键帧由键值对组成。键是一个数字(范围 [0,1])用于表示一天中的时间(0.0 和 1.0 表示正午,0.25 表示日落,0.5 表示午夜,0.75 表示日出)。值也是一个数字(范围 [0,60])

#Returns

void

#Remarks

为「灵动视效」中的大气散射设置太阳 Mie 强度。

Sets the sun mie strength for atmospheric scattering in Vibrant Visuals

#Throws

This function can throw errors.

InvalidArgumentError

#同领域相关

• BiomeColorGrading
• BiomeLighting
• BiomeWater
• getBiomeAtmospherics
• getBiomeColorGrading
• getBiomeLighting