API
Return to top
Skybox
编辑

场景 / Skybox

Skybox Class
​

天空盒

使用示例: 可按如下操作控制编辑器天空盒实时效果

创建一个名为"SkyboxExample"的脚本，放置在对象栏中，打开脚本，输入以下代码，运行游戏，你将可以通过 "+" 和 "-" 键控制天空盒的亮度， "*" 键切换预设。

ts
@Component
export default class SkyboxExample extends mw.Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        if(Util.SystemUtil.isClient())
        {
            mw.InputUtil.onKeyDown(Type.Keys.Add,()=>{
                // 小键盘+建，增加天空盒亮度,依次递增1个单位
                Skybox.skyDomeIntensity = Skybox.skyDomeIntensity + 0.2;
                console.log("当前天空盒亮度:" + Skybox.skyDomeIntensity);
            });
            mw.InputUtil.onKeyDown(Type.Keys.Subtract,()=>{
                // 小键盘-建，降低天空盒亮度,依次递减1个单位
                Skybox.skyDomeIntensity = Skybox.skyDomeIntensity - 0.2;
                console.log("当前天空盒亮度:" + Skybox.skyDomeIntensity);
            });
            mw.InputUtil.onKeyDown(Type.Keys.Multiply,()=>{
                // 小键盘*建，切换天空盒预设
                Skybox.preset =7 % (Skybox.preset + 1);
            });
        }
    }
}
@Component
export default class SkyboxExample extends mw.Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        if(Util.SystemUtil.isClient())
        {
            mw.InputUtil.onKeyDown(Type.Keys.Add,()=>{
                // 小键盘+建，增加天空盒亮度,依次递增1个单位
                Skybox.skyDomeIntensity = Skybox.skyDomeIntensity + 0.2;
                console.log("当前天空盒亮度:" + Skybox.skyDomeIntensity);
            });
            mw.InputUtil.onKeyDown(Type.Keys.Subtract,()=>{
                // 小键盘-建，降低天空盒亮度,依次递减1个单位
                Skybox.skyDomeIntensity = Skybox.skyDomeIntensity - 0.2;
                console.log("当前天空盒亮度:" + Skybox.skyDomeIntensity);
            });
            mw.InputUtil.onKeyDown(Type.Keys.Multiply,()=>{
                // 小键盘*建，切换天空盒预设
                Skybox.preset =7 % (Skybox.preset + 1);
            });
        }
    }
}

Table of contents ​

Accessors
​

affectedByFog(): boolean client
设置是否受环境雾影响
cloudColor(): LinearColor client
获取云颜色
cloudDensity(): number client
获取云密度
cloudOpacity(): number client
获取云的透明度
cloudSpeed(): number client
获取云速度
cloudTextureID(): string client
获取云贴图ID
cloudVisible(): boolean client
获取是否开启云
disturbanceDensity(): number client
获取扰动密度
disturbanceEnabled(): boolean client
获取扰动开关
disturbanceIntensity(): number client
获取扰动强度
layerDisturbanceEnabled(): boolean client
设置是否开启分层扰动
moonColor(): LinearColor client
获取月亮颜色
moonIntensity(): number client
获取月亮亮度
moonSize(): number client
获取月亮大小
moonTextureID(): string client
获取月亮贴图ID
moonVisible(): boolean client
获取是否开启月亮
pitchAngle(): number client
获取天空盒贴图pitch旋转（度）
preset(): SkyPreset client
获取预设
rollAngle(): number client
获取天空盒贴图roll旋转（度）
skyDomeBaseColor(): LinearColor client
获取天空盒颜色
skyDomeBottomColor(): LinearColor client
天空下层颜色
skyDomeGradientEnabled(): boolean client
获取是否开启渐变效果
skyDomeHorizontalFallOff(): number client
获取地平线渐出值
skyDomeIntensity(): number client
获取天空盒亮度
skyDomeMiddleColor(): LinearColor client
天空中层颜色
skyDomeTextureID(): string client
获取天空盒贴图资源ID
skyDomeTopColor(): LinearColor client
获取天空顶层颜色
skyboxRotation(): Rotation client
获取天空球旋转
starDensity(): number client
获取星星密度
starIntensity(): number client
获取星星亮度
starTextureID(): string client
获取星星贴图ID
starVisible(): boolean client
获取是否开启星星
sunColor(): LinearColor client
获取太阳颜色
sunIntensity(): number client
获取太阳光亮度
sunSize(): number client
获取太阳大小
sunTextureID(): string client
获取太阳贴图ID
sunVisible(): boolean client
获取是否开启太阳
yawAngle(): number client
获取天空盒贴图yaw旋转（度）

Methods
​

pausSwitch(): void client
暂停天空盒背景
refresh(): void client
天空盒刷新
reset(): void client
重置为默认参数
startSwitch(targetTexture: string, switchMode: Gradient, switchTime: number): boolean client
开始切换天空盒背景

Accessors ​

affectedByFog
​

• Static get affectedByFog(): boolean client

• Static set affectedByFog(value): void client

设置是否受环境雾影响

Returns ​

boolean是否受环境雾影响

设置是否受环境雾影响

Parameters ​

value boolean是否受环境雾影响

cloudColor
​

• Static get cloudColor(): LinearColor client

• Static set cloudColor(value): void client

获取云颜色

Returns ​

LinearColor云颜色

设置云颜色

Parameters ​

value LinearColor云颜色

cloudDensity
​

• Static get cloudDensity(): number client

• Static set cloudDensity(value): void client

获取云密度

Returns ​

number云密度

设置云密度

Parameters ​

value number云密度(0~1)

cloudOpacity
​

• Static get cloudOpacity(): number client

• Static set cloudOpacity(value): void client

获取云的透明度

Returns ​

number云的透明度

设置云的透明度

Parameters ​

value number云的透明度(0~1)

cloudSpeed
​

• Static get cloudSpeed(): number client

• Static set cloudSpeed(value): void client

获取云速度

Returns ​

number云速度

设置云速度

Parameters ​

value number云速度(0~10)

cloudTextureID
​

• Static get cloudTextureID(): string client

• Static set cloudTextureID(value): void client

获取云贴图ID

Returns ​

string云贴图ID

设置云贴图资源ID

Parameters ​

value string云贴图资源ID

cloudVisible
​

• Static get cloudVisible(): boolean client

• Static set cloudVisible(value): void client

获取是否开启云

Returns ​

boolean是否开启云

设置是否开启云

Parameters ​

value boolean是否开启云

disturbanceDensity
​

• Static get disturbanceDensity(): number client

• Static set disturbanceDensity(value): void client

获取扰动密度

Returns ​

number扰动密度

设置扰动密度

Parameters ​

value number扰动密度

disturbanceEnabled
​

• Static get disturbanceEnabled(): boolean client

• Static set disturbanceEnabled(value): void client

获取扰动开关

Returns ​

boolean扰动开关

设置扰动开关

Parameters ​

value boolean扰动开关

disturbanceIntensity
​

• Static get disturbanceIntensity(): number client

• Static set disturbanceIntensity(value): void client

获取扰动强度

Returns ​

number扰动强度

设置扰动强度

Parameters ​

value number扰动强度

layerDisturbanceEnabled
​

• Static get layerDisturbanceEnabled(): boolean client

• Static set layerDisturbanceEnabled(value): void client

设置是否开启分层扰动

Returns ​

boolean是否开启分层扰动

设置是否开启分层扰动

Parameters ​

value boolean是否开启分层扰动

moonColor
​

• Static get moonColor(): LinearColor client

• Static set moonColor(value): void client

获取月亮颜色

Returns ​

LinearColor月亮颜色

设置月亮颜色

Parameters ​

value LinearColor月亮颜色

moonIntensity
​

• Static get moonIntensity(): number client

• Static set moonIntensity(value): void client

获取月亮亮度

Returns ​

number月亮亮度

设置月亮亮度

Parameters ​

value number月亮亮度(0~2000)

moonSize
​

• Static get moonSize(): number client

• Static set moonSize(value): void client

获取月亮大小

Returns ​

number月亮大小

设置月亮大小

Parameters ​

value number月亮大小(0~100)

moonTextureID
​

• Static get moonTextureID(): string client

• Static set moonTextureID(value): void client

获取月亮贴图ID

Returns ​

string月亮贴图ID

设置月亮贴图资源ID

Parameters ​

value string月亮贴图资源ID

moonVisible
​

• Static get moonVisible(): boolean client

• Static set moonVisible(value): void client

获取是否开启月亮

Returns ​

boolean是否开启月亮

设置是否开启月亮

Parameters ​

value boolean是否开启月亮

pitchAngle
​

• Static get pitchAngle(): number client

• Static set pitchAngle(value): void client

获取天空盒贴图pitch旋转（度）

Returns ​

number天空盒贴图旋转

设置天空盒贴图pitch旋转（度）

Parameters ​

value number天空盒贴图旋转度(0~360)

preset
​

• Static get preset(): SkyPreset client

• Static set preset(NewPreset): void client

获取预设

Returns ​

SkyPreset返回预设

设置预设

Parameters ​

NewPreset SkyPreset预设枚举

rollAngle
​

• Static get rollAngle(): number client

• Static set rollAngle(value): void client

获取天空盒贴图roll旋转（度）

Returns ​

number天空盒贴图旋转

设置天空盒贴图roll旋转（度）

Parameters ​

value number天空盒贴图旋转度(0~360)

skyDomeBaseColor
​

• Static get skyDomeBaseColor(): LinearColor client

• Static set skyDomeBaseColor(value): void client

获取天空盒颜色

Returns ​

LinearColor天空盒颜色

设置天空盒颜色

Parameters ​

value LinearColor天空盒颜色值

skyDomeBottomColor
​

• Static get skyDomeBottomColor(): LinearColor client

• Static set skyDomeBottomColor(value): void client

天空下层颜色

Returns ​

LinearColor天空下层颜色

设置天空下层颜色

Parameters ​

value LinearColor天空下层颜色值

skyDomeGradientEnabled
​

• Static get skyDomeGradientEnabled(): boolean client

• Static set skyDomeGradientEnabled(value): void client

获取是否开启渐变效果

Returns ​

boolean是否开启渐变效果

设置是否开启渐变效果

Parameters ​

value boolean是否开启渐变效果

skyDomeHorizontalFallOff
​

• Static get skyDomeHorizontalFallOff(): number client

• Static set skyDomeHorizontalFallOff(value): void client

获取地平线渐出值

Returns ​

number地平线渐出值

设置地平线渐出值

Parameters ​

value number地平线渐出值(1~20)

skyDomeIntensity
​

• Static get skyDomeIntensity(): number client

• Static set skyDomeIntensity(value): void client

获取天空盒亮度

Returns ​

number天空盒亮度

设置天空盒亮度

Parameters ​

value number天空盒亮度值(0~100)

skyDomeMiddleColor
​

• Static get skyDomeMiddleColor(): LinearColor client

• Static set skyDomeMiddleColor(value): void client

天空中层颜色

Returns ​

LinearColor天空中层颜色

设置天空中层颜色

Parameters ​

value LinearColor天空中层颜色值

skyDomeTextureID
​

• Static get skyDomeTextureID(): string client

• Static set skyDomeTextureID(value): void client

获取天空盒贴图资源ID

Returns ​

string贴图资源ID

设置天空盒贴图资源ID

Parameters ​

value string贴图资源ID

skyDomeTopColor
​

• Static get skyDomeTopColor(): LinearColor client

• Static set skyDomeTopColor(value): void client

获取天空顶层颜色

Returns ​

LinearColor天空顶层颜色

设置天空顶层颜色

Parameters ​

value LinearColor天空顶层颜色值

skyboxRotation
​

• Static get skyboxRotation(): Rotation client

• Static set skyboxRotation(value): void client

获取天空球旋转

Returns ​

Rotation天空球旋转值

设置天空球旋转

Parameters ​

value Rotation天空球旋转值

starDensity
​

• Static get starDensity(): number client

• Static set starDensity(value): void client

获取星星密度

Returns ​

number星星密度

设置星星密度

Parameters ​

value number星星密度(0~100)

starIntensity
​

• Static get starIntensity(): number client

• Static set starIntensity(value): void client

获取星星亮度

Returns ​

number星星亮度

设置星星亮度

Parameters ​

value number星星亮度(0~1)

starTextureID
​

• Static get starTextureID(): string client

• Static set starTextureID(value): void client

获取星星贴图ID

Returns ​

string星星贴图ID

设置星星贴图资源ID

Parameters ​

value string星星贴图资源ID

starVisible
​

• Static get starVisible(): boolean client

• Static set starVisible(value): void client

获取是否开启星星

Returns ​

boolean是否开启星星

设置是否开启星星

Parameters ​

value boolean是否开启星星

sunColor
​

• Static get sunColor(): LinearColor client

• Static set sunColor(value): void client

获取太阳颜色

Returns ​

LinearColor太阳颜色

设置太阳颜色

Parameters ​

value LinearColor太阳颜色

sunIntensity
​

• Static get sunIntensity(): number client

• Static set sunIntensity(value): void client

获取太阳光亮度

Returns ​

number太阳光亮度

设置太阳光亮度

Parameters ​

value number太阳光亮度(0~2000)

sunSize
​

• Static get sunSize(): number client

• Static set sunSize(value): void client

获取太阳大小

Returns ​

number太阳大小

设置太阳大小

Parameters ​

value number太阳大小(0~100)

sunTextureID
​

• Static get sunTextureID(): string client

• Static set sunTextureID(value): void client

获取太阳贴图ID

Returns ​

string太阳贴图ID

设置太阳贴图资源ID

Parameters ​

value string太阳贴图资源ID

sunVisible
​

• Static get sunVisible(): boolean client

• Static set sunVisible(value): void client

获取是否开启太阳

Returns ​

boolean是否开启太阳

设置是否开启太阳

Parameters ​

value boolean是否开启太阳

yawAngle
​

• Static get yawAngle(): number client

• Static set yawAngle(value): void client

获取天空盒贴图yaw旋转（度）

Returns ​

number天空盒贴图旋转

设置天空盒贴图yaw旋转（度）

Parameters ​

value number天空盒贴图yaw旋转度(0~360)

Methods ​

pausSwitch
​

• Static pausSwitch(): void client

暂停天空盒背景

refresh
​

• Static refresh(): void client

天空盒刷新

reset
​

• Static reset(): void client

重置为默认参数

startSwitch
​

• Static startSwitch(targetTexture, switchMode, switchTime): boolean client

开始切换天空盒背景

Parameters ​

targetTexture string要切换到的天空球贴图
switchMode Gradient过渡方式
switchTime number过渡时间,单位：秒

Returns ​

boolean